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.3cvs"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.5"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol (draft)</title> |
<title>LinuxSampler Control Protocol</title> |
22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
23 |
Schoenebeck'> |
Schoenebeck'> |
24 |
<organization> |
<organization> |
34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
35 |
</address> |
</address> |
36 |
</author> |
</author> |
37 |
<date month="June" year="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> |
2061 |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
2062 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
2063 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
2064 |
parameter.</t> |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
2065 |
|
for specifying no value for parameters allowing a list of values.</t> |
2066 |
|
|
2067 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2068 |
<t> |
<t> |
2089 |
<t>Example:</t> |
<t>Example:</t> |
2090 |
<t> |
<t> |
2091 |
<list> |
<list> |
2092 |
<t></t> |
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t> |
2093 |
|
<t>S: "OK"</t> |
2094 |
|
</list> |
2095 |
|
</t> |
2096 |
|
<t> |
2097 |
|
<list> |
2098 |
|
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t> |
2099 |
|
<t>S: "OK"</t> |
2100 |
</list> |
</list> |
2101 |
</t> |
</t> |
2102 |
</section> |
</section> |
2121 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
2122 |
Each sampler channel can only have one instrument.</t> |
Each sampler channel can only have one instrument.</t> |
2123 |
|
|
2124 |
<t>Notice: since LSCP 1.3 the <filename> argument supports |
<t>Notice: since LSCP 1.2 the <filename> argument supports |
2125 |
escape characters for special characters (see chapter |
escape characters for special characters (see chapter |
2126 |
"<xref target="character_set">Character Set and Escape Sequences</xref>" |
"<xref target="character_set">Character Set and Escape Sequences</xref>" |
2127 |
for details) and accordingly backslash characters in the filename |
for details) and accordingly backslash characters in the filename |
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> |
2451 |
<list> |
<list> |
2452 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
2453 |
<list> |
<list> |
2454 |
<t>arbitrary description text about the engine</t> |
<t>arbitrary description text about the engine |
2455 |
|
(note that the character string may contain |
2456 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2457 |
</list> |
</list> |
2458 |
</t> |
</t> |
2459 |
<t>VERSION - |
<t>VERSION - |
2512 |
<list> |
<list> |
2513 |
<t>numerical ID of the audio output device which is |
<t>numerical ID of the audio output device which is |
2514 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
2515 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
2516 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
2517 |
</list> |
</list> |
2518 |
</t> |
</t> |
2537 |
<list> |
<list> |
2538 |
<t>the file name of the loaded instrument, "NONE" if |
<t>the file name of the loaded instrument, "NONE" if |
2539 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
2540 |
channel</t> |
channel (note: since LSCP 1.2 this path may contain |
2541 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2542 |
</list> |
</list> |
2543 |
</t> |
</t> |
2544 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
2545 |
<list> |
<list> |
2546 |
<t>the instrument index number of the loaded instrument</t> |
<t>the instrument index number of the loaded instrument, |
2547 |
|
"-1" if there's no instrument loaded for this sampler |
2548 |
|
channel</t> |
2549 |
</list> |
</list> |
2550 |
</t> |
</t> |
2551 |
<t>INSTRUMENT_NAME - |
<t>INSTRUMENT_NAME - |
2552 |
<list> |
<list> |
2553 |
<t>the instrument name of the loaded instrument</t> |
<t>the instrument name of the loaded instrument |
2554 |
|
(note: since LSCP 1.2 this character string may contain |
2555 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2556 |
</list> |
</list> |
2557 |
</t> |
</t> |
2558 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
2559 |
<list> |
<list> |
2560 |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<t>Integer values 0 to 100 indicating loading progress |
2561 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
percentage for the instrument. Negative |
2562 |
|
value indicates a loading exception (also returns "-1" in case no |
2563 |
|
instrument was yet to be loaded on the sampler channel). |
2564 |
|
Value of 100 indicates that the instrument is fully |
2565 |
loaded.</t> |
loaded.</t> |
2566 |
</list> |
</list> |
2567 |
</t> |
</t> |
2569 |
<list> |
<list> |
2570 |
<t>numerical ID of the MIDI input device which is |
<t>numerical ID of the MIDI input device which is |
2571 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
2572 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
2573 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
2574 |
</list> |
</list> |
2575 |
</t> |
</t> |
2576 |
<t>MIDI_INPUT_PORT - |
<t>MIDI_INPUT_PORT - |
2577 |
<list> |
<list> |
2578 |
<t>port number of the MIDI input device</t> |
<t>port number of the MIDI input device (in case a |
2579 |
|
MIDI device was already assigned to the sampler |
2580 |
|
channel)</t> |
2581 |
</list> |
</list> |
2582 |
</t> |
</t> |
2583 |
<t>MIDI_INPUT_CHANNEL - |
<t>MIDI_INPUT_CHANNEL - |
3275 |
sampler channel on which the effect send should be created on, <midi-ctrl> |
sampler channel on which the effect send should be created on, <midi-ctrl> |
3276 |
is a number between 0..127 defining the MIDI controller which can alter the |
is a number between 0..127 defining the MIDI controller which can alter the |
3277 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
3278 |
for the effect send entity. The name does not have to be unique.</t> |
for the effect send entity. The name does not have to be unique, but MUST be |
3279 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
3280 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>".</t> |
3281 |
|
|
3282 |
<t>By default, that is as initial routing, the effect send's audio channels |
<t>By default, that is as initial routing, the effect send's audio channels |
3283 |
are automatically routed to the last audio channels of the sampler channel's |
are automatically routed to the last audio channels of the sampler channel's |
3467 |
<list> |
<list> |
3468 |
<t>NAME - |
<t>NAME - |
3469 |
<list> |
<list> |
3470 |
<t>name of the effect send entity</t> |
<t>name of the effect send entity |
3471 |
|
(note that this character string may contain |
3472 |
|
<xref target="character_set">escape sequences</xref>)</t> |
3473 |
</list> |
</list> |
3474 |
</t> |
</t> |
3475 |
<t>MIDI_CONTROLLER - |
<t>MIDI_CONTROLLER - |
3532 |
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3533 |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3534 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
3535 |
does not have to be unique.</t> |
does not have to be unique (name MUST be encapsulated into apostrophes |
3536 |
|
and supports escape sequences as described in chapter |
3537 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
3538 |
|
</t> |
3539 |
|
|
3540 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3541 |
<t> |
<t> |
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> |
4004 |
</t> |
</t> |
4005 |
</section> |
</section> |
4006 |
|
|
4007 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
4008 |
|
<t>The front-end can ask for the current number of active disk streams on |
4009 |
|
the sampler by sending the following command:</t> |
4010 |
|
<t> |
4011 |
|
<list> |
4012 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
4013 |
|
</list> |
4014 |
|
</t> |
4015 |
|
|
4016 |
|
<t>Possible Answers:</t> |
4017 |
|
<t> |
4018 |
|
<list> |
4019 |
|
<t>LinuxSampler will answer by returning the number of all active |
4020 |
|
disk streams on the sampler.</t> |
4021 |
|
</list> |
4022 |
|
</t> |
4023 |
|
</section> |
4024 |
|
|
4025 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
4026 |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
4027 |
<t> |
<t> |
4069 |
<list> |
<list> |
4070 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
4071 |
<list> |
<list> |
4072 |
<t>arbitrary textual description about the sampler</t> |
<t>arbitrary textual description about the sampler |
4073 |
|
(note that the character string may contain |
4074 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4075 |
</list> |
</list> |
4076 |
</t> |
</t> |
4077 |
<t>VERSION - |
<t>VERSION - |
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 |
|
|
4324 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
4325 |
reflected by the current MIDI instrument map.</t> |
reflected by the current MIDI instrument map.</t> |
4326 |
|
|
4327 |
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP"> |
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP"> |
4328 |
<t>The front-end can add a new MIDI instrument map by sending |
<t>The front-end can add a new MIDI instrument map by sending |
4329 |
the following command:</t> |
the following command:</t> |
4330 |
<t> |
<t> |
4334 |
</t> |
</t> |
4335 |
<t>Where <name> is an optional argument allowing to |
<t>Where <name> is an optional argument allowing to |
4336 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
4337 |
names do not have to be unique.</t> |
names do not have to be unique, but MUST be encapsulated |
4338 |
|
into apostrophes and support escape sequences as described |
4339 |
|
in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>". |
4340 |
|
</t> |
4341 |
|
|
4342 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4343 |
<t> |
<t> |
4508 |
<t>NAME - |
<t>NAME - |
4509 |
<list> |
<list> |
4510 |
<t>custom name of the given map, |
<t>custom name of the given map, |
4511 |
which does not have to be unique</t> |
which does not have to be unique |
4512 |
|
(note that this character string may contain |
4513 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4514 |
</list> |
</list> |
4515 |
</t> |
</t> |
4516 |
<t>DEFAULT - |
<t>DEFAULT - |
4546 |
</t> |
</t> |
4547 |
<t>Where <map> is the numerical ID of the map and |
<t>Where <map> is the numerical ID of the map and |
4548 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
4549 |
have to be unique.</t> |
have to be unique (name MUST be encapsulated into apostrophes |
4550 |
|
and supports escape sequences as described in chapter |
4551 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
4552 |
|
</t> |
4553 |
|
|
4554 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4555 |
<t> |
<t> |
4680 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
4681 |
mode by i.e. sending |
mode by i.e. sending |
4682 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4683 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
4684 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
4685 |
entry, useful for frontends for displaying an appropriate name for |
"<xref target="character_set">Character Set and Escape Sequences</xref>") for the |
4686 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
4687 |
mapped instruments (using |
mapped instruments (using |
4688 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
4689 |
</t> |
</t> |
4907 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
4908 |
changed with the |
changed with the |
4909 |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
4910 |
command and does not have to be unique.</t> |
command and does not have to be unique. |
4911 |
|
(note that this character string may contain |
4912 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4913 |
</list> |
</list> |
4914 |
</t> |
</t> |
4915 |
<t>"ENGINE_NAME" - |
<t>"ENGINE_NAME" - |
4920 |
</t> |
</t> |
4921 |
<t>"INSTRUMENT_FILE" - |
<t>"INSTRUMENT_FILE" - |
4922 |
<list> |
<list> |
4923 |
<t>File name of the instrument.</t> |
<t>File name of the instrument |
4924 |
|
(note that this path may contain |
4925 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4926 |
</list> |
</list> |
4927 |
</t> |
</t> |
4928 |
<t>"INSTRUMENT_NR" - |
<t>"INSTRUMENT_NR" - |
4934 |
<list> |
<list> |
4935 |
<t>Name of the loaded instrument as reflected by its file. |
<t>Name of the loaded instrument as reflected by its file. |
4936 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
4937 |
cannot be changed.</t> |
cannot be changed (note that this character string may contain |
4938 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4939 |
</list> |
</list> |
4940 |
</t> |
</t> |
4941 |
<t>"LOAD_MODE" - |
<t>"LOAD_MODE" - |
5023 |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
5024 |
<t>The following commands describe how to use and manage |
<t>The following commands describe how to use and manage |
5025 |
the instruments database.</t> |
the instruments database.</t> |
5026 |
|
<t>Notice:</t> |
5027 |
|
<t> |
5028 |
|
<list> |
5029 |
|
<t>All command arguments representing a path or |
5030 |
|
instrument/directory name support escape sequences as described in chapter |
5031 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>". |
5032 |
|
</t> |
5033 |
|
<t>All occurrences of a forward slash in instrument and directory |
5034 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
5035 |
|
</t> |
5036 |
|
</list> |
5037 |
|
</t> |
5038 |
|
|
5039 |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
5040 |
<t>The front-end can add a new instrument directory to the |
<t>The front-end can add a new instrument directory to the |
5212 |
<list> |
<list> |
5213 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
5214 |
<list> |
<list> |
5215 |
<t>A brief description of the directory content</t> |
<t>A brief description of the directory content. |
5216 |
|
Note that the character string may contain |
5217 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5218 |
</list> |
</list> |
5219 |
</t> |
</t> |
5220 |
<t>CREATED - |
<t>CREATED - |
5378 |
</list> |
</list> |
5379 |
</t> |
</t> |
5380 |
<t>Where <dir> is the absolute path name of the directory and |
<t>Where <dir> is the absolute path name of the directory and |
5381 |
<desc> is the new description for the directory.</t> |
<desc> is the new description for the directory |
5382 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5383 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5384 |
|
|
5385 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5386 |
<t> |
<t> |
5425 |
<t>NAME='<search-string>' |
<t>NAME='<search-string>' |
5426 |
<list> |
<list> |
5427 |
<t>Restricts the search to directories, which names |
<t>Restricts the search to directories, which names |
5428 |
satisfy the supplied search string.</t> |
satisfy the supplied search string (encapsulated into apostrophes, |
5429 |
|
supporting escape sequences as described in chapter |
5430 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5431 |
</list> |
</list> |
5432 |
</t> |
</t> |
5433 |
|
|
5458 |
<t>DESCRIPTION='<search-string>' |
<t>DESCRIPTION='<search-string>' |
5459 |
<list> |
<list> |
5460 |
<t>Restricts the search to directories with description |
<t>Restricts the search to directories with description |
5461 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string |
5462 |
|
(encapsulated into apostrophes, supporting escape |
5463 |
|
sequences as described in chapter |
5464 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5465 |
</list> |
</list> |
5466 |
</t> |
</t> |
5467 |
</t> |
</t> |
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. |
5726 |
<list> |
<list> |
5727 |
<t>INSTRUMENT_FILE - |
<t>INSTRUMENT_FILE - |
5728 |
<list> |
<list> |
5729 |
<t>File name of the instrument.</t> |
<t>File name of the instrument. |
5730 |
|
Note that the character string may contain |
5731 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5732 |
</list> |
</list> |
5733 |
</t> |
</t> |
5734 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
5767 |
</t> |
</t> |
5768 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
5769 |
<list> |
<list> |
5770 |
<t>A brief description of the instrument</t> |
<t>A brief description of the instrument. |
5771 |
|
Note that the character string may contain |
5772 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5773 |
</list> |
</list> |
5774 |
</t> |
</t> |
5775 |
<t>IS_DRUM - |
<t>IS_DRUM - |
5780 |
</t> |
</t> |
5781 |
<t>PRODUCT - |
<t>PRODUCT - |
5782 |
<list> |
<list> |
5783 |
<t>The product title of the instrument</t> |
<t>The product title of the instrument. |
5784 |
|
Note that the character string may contain |
5785 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5786 |
</list> |
</list> |
5787 |
</t> |
</t> |
5788 |
<t>ARTISTS - |
<t>ARTISTS - |
5789 |
<list> |
<list> |
5790 |
<t>Lists the artist names</t> |
<t>Lists the artist names. |
5791 |
|
Note that the character string may contain |
5792 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5793 |
</list> |
</list> |
5794 |
</t> |
</t> |
5795 |
<t>KEYWORDS - |
<t>KEYWORDS - |
5796 |
<list> |
<list> |
5797 |
<t>Provides a list of keywords that refer to the instrument. |
<t>Provides a list of keywords that refer to the instrument. |
5798 |
Keywords are separated with semicolon and blank.</t> |
Keywords are separated with semicolon and blank. |
5799 |
|
Note that the character string may contain |
5800 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5801 |
</list> |
</list> |
5802 |
</t> |
</t> |
5803 |
</list> |
</list> |
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.</t> |
<desc> is the new description for the instrument |
5958 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5959 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5960 |
|
|
5961 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5962 |
<t> |
<t> |
6001 |
<t>NAME='<search-string>' |
<t>NAME='<search-string>' |
6002 |
<list> |
<list> |
6003 |
<t>Restricts the search to instruments, which names |
<t>Restricts the search to instruments, which names |
6004 |
satisfy the supplied search string.</t> |
satisfy the supplied search string (encapsulated into apostrophes, |
6005 |
|
supporting escape sequences as described in chapter |
6006 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6007 |
</list> |
</list> |
6008 |
</t> |
</t> |
6009 |
|
|
6045 |
<t>DESCRIPTION='<search-string>' |
<t>DESCRIPTION='<search-string>' |
6046 |
<list> |
<list> |
6047 |
<t>Restricts the search to instruments with description |
<t>Restricts the search to instruments with description |
6048 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
6049 |
|
supporting escape sequences as described in chapter |
6050 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6051 |
</list> |
</list> |
6052 |
</t> |
</t> |
6053 |
|
|
6054 |
<t>PRODUCT='<search-string>' |
<t>PRODUCT='<search-string>' |
6055 |
<list> |
<list> |
6056 |
<t>Restricts the search to instruments with product info |
<t>Restricts the search to instruments with product info |
6057 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
6058 |
|
supporting escape sequences as described in chapter |
6059 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6060 |
</list> |
</list> |
6061 |
</t> |
</t> |
6062 |
|
|
6063 |
<t>ARTISTS='<search-string>' |
<t>ARTISTS='<search-string>' |
6064 |
<list> |
<list> |
6065 |
<t>Restricts the search to instruments with artists info |
<t>Restricts the search to instruments with artists info |
6066 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
6067 |
|
supporting escape sequences as described in chapter |
6068 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6069 |
</list> |
</list> |
6070 |
</t> |
</t> |
6071 |
|
|
6072 |
<t>KEYWORDS='<search-string>' |
<t>KEYWORDS='<search-string>' |
6073 |
<list> |
<list> |
6074 |
<t>Restricts the search to instruments with keyword list |
<t>Restricts the search to instruments with keyword list |
6075 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
6076 |
|
supporting escape sequences as described in chapter |
6077 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6078 |
</list> |
</list> |
6079 |
</t> |
</t> |
6080 |
|
|
6188 |
</t> |
</t> |
6189 |
</section> |
</section> |
6190 |
|
|
6191 |
|
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
6192 |
|
<t>The front-end can remove all instruments and directories and re-create |
6193 |
|
the instruments database structure (e.g., in case of a database corruption) |
6194 |
|
by sending the following command:</t> |
6195 |
|
<t> |
6196 |
|
<list> |
6197 |
|
<t>FORMAT INSTRUMENTS_DB</t> |
6198 |
|
</list> |
6199 |
|
</t> |
6200 |
|
|
6201 |
|
<t>Possible Answers:</t> |
6202 |
|
<t> |
6203 |
|
<list> |
6204 |
|
<t>"OK" - |
6205 |
|
<list> |
6206 |
|
<t>on success</t> |
6207 |
|
</list> |
6208 |
|
</t> |
6209 |
|
<t>"ERR:<error-code>:<error-message>" - |
6210 |
|
<list> |
6211 |
|
<t>If the formatting of the instruments database |
6212 |
|
failed.</t> |
6213 |
|
</list> |
6214 |
|
</t> |
6215 |
|
</list> |
6216 |
|
</t> |
6217 |
|
</section> |
6218 |
|
|
6219 |
|
<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 |
|
|
|
</section> |
|
6287 |
|
|
6288 |
|
|
6289 |
|
<section title="Editing Instruments" anchor="editing_instruments"> |
6290 |
|
<t>The sampler allows to edit instruments while playing with the |
6291 |
|
sampler by spawning an external (3rd party) instrument editor |
6292 |
|
application for a given instrument. The 3rd party instrument |
6293 |
|
editor applications have to place a respective plugin DLL file |
6294 |
|
into the sampler's plugins directory. The sampler will |
6295 |
|
automatically try to load all plugin DLLs in that directory on |
6296 |
|
startup and only on startup!</t> |
6297 |
|
<t>At the moment there is only one command for this feature set, |
6298 |
|
but this will most probably change in future.</t> |
6299 |
|
|
6300 |
|
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT"> |
6301 |
|
<t>The front-end can request to open an appropriate instrument |
6302 |
|
editor application by sending the following command:</t> |
6303 |
|
<t> |
6304 |
|
<list> |
6305 |
|
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6306 |
|
</list> |
6307 |
|
</t> |
6308 |
|
<t>Where <sampler-channel> should be replaced by the |
6309 |
|
number of the sampler channel as given by the |
6310 |
|
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
6311 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
6312 |
|
command.</t> |
6313 |
|
|
6314 |
|
<t>The sampler will try to ask all registered instrument |
6315 |
|
editors (or to be more specific: their sampler plugins) |
6316 |
|
whether they are capable to handle the instrument on the |
6317 |
|
given sampler channel. The sampler will simply use the first |
6318 |
|
instrument editor application which replied with a positive |
6319 |
|
answer and spawn that instrument editor application within |
6320 |
|
the sampler's process and provide that application access |
6321 |
|
to the instrument's data structures, so both applications |
6322 |
|
can share and access the same instruments data at the same |
6323 |
|
time, thus allowing to immediately hear changes with the |
6324 |
|
sampler made by the instrument editor.</t> |
6325 |
|
|
6326 |
|
<t>Note: consequently instrument editors are always spawned |
6327 |
|
locally on the same machine where the sampler is running |
6328 |
|
on!</t> |
6329 |
|
|
6330 |
|
<t>Possible Answers:</t> |
6331 |
|
<t> |
6332 |
|
<list> |
6333 |
|
<t>"OK" - |
6334 |
|
<list> |
6335 |
|
<t>when an appropriate instrument editor was |
6336 |
|
launched</t> |
6337 |
|
</list> |
6338 |
|
</t> |
6339 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6340 |
|
<list> |
6341 |
|
<t>when an appropriate instrument editor was |
6342 |
|
launched, but there are noteworthy issues</t> |
6343 |
|
</list> |
6344 |
|
</t> |
6345 |
|
<t>"ERR:<error-code>:<error-message>" - |
6346 |
|
<list> |
6347 |
|
<t>when an appropriate instrument editor |
6348 |
|
could not be launched</t> |
6349 |
|
</list> |
6350 |
|
</t> |
6351 |
|
</list> |
6352 |
|
</t> |
6353 |
|
|
6354 |
|
<t>Examples:</t> |
6355 |
|
<t> |
6356 |
|
<list> |
6357 |
|
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6358 |
|
<t>S: "OK"</t> |
6359 |
|
</list> |
6360 |
|
</t> |
6361 |
|
</section> |
6362 |
|
</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"/> |
6561 |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
6640 |
</t> |
</t> |
6641 |
<t>/ EDIT SP edit_instruction |
<t>/ EDIT SP edit_instruction |
6642 |
</t> |
</t> |
6643 |
|
<t>/ FORMAT SP format_instruction |
6644 |
|
</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 |
6658 |
<list> |
<list> |
6659 |
<t>CHANNEL |
<t>CHANNEL |
6660 |
</t> |
</t> |
6661 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6662 |
|
</t> |
6663 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
6664 |
|
</t> |
6665 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
6666 |
</t> |
</t> |
6667 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
6668 |
</t> |
</t> |
6669 |
<t>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
6670 |
</t> |
</t> |
6671 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
6672 |
</t> |
</t> |
6673 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
6674 |
</t> |
</t> |
6675 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP db_path SP filename |
6676 |
</t> |
</t> |
6677 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index |
<t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
6678 |
</t> |
</t> |
6679 |
<t>/ MIDI_INSTRUMENT_MAP |
<t>/ MIDI_INSTRUMENT_MAP |
6680 |
</t> |
</t> |
6681 |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
6682 |
</t> |
</t> |
6683 |
|
<t>/ MASTER_EFFECT_CHAIN SP number |
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 |
6732 |
</t> |
</t> |
6733 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6734 |
</t> |
</t> |
6735 |
|
<t>/ TOTAL_STREAM_COUNT |
6736 |
|
</t> |
6737 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6738 |
</t> |
</t> |
6739 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
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 |
6788 |
</t> |
</t> |
6789 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6790 |
</t> |
</t> |
6791 |
|
<t>/ TOTAL_STREAM_COUNT |
6792 |
|
</t> |
6793 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6794 |
</t> |
</t> |
6795 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6822 |
</t> |
</t> |
6823 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
6824 |
</t> |
</t> |
6825 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname |
<t>/ MASTER_EFFECT_CHAIN SP number SP number |
6826 |
|
</t> |
6827 |
|
<t>/ MASTER_EFFECT_CHAIN SP EFFECT SP number SP number SP number |
6828 |
</t> |
</t> |
6829 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
6830 |
</t> |
</t> |
6831 |
<t>/ DB_INSTRUMENT SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6832 |
|
</t> |
6833 |
|
<t>/ DB_INSTRUMENT SP db_path |
6834 |
</t> |
</t> |
6835 |
</list> |
</list> |
6836 |
</t> |
</t> |
6838 |
<list> |
<list> |
6839 |
<t>AVAILABLE_ENGINES |
<t>AVAILABLE_ENGINES |
6840 |
</t> |
</t> |
6841 |
|
<t>/ AVAILABLE_EFFECTS |
6842 |
|
</t> |
6843 |
|
<t>/ EFFECT_INSTANCES |
6844 |
|
</t> |
6845 |
|
<t>/ EFFECT SP INFO SP number |
6846 |
|
</t> |
6847 |
|
<t>/ EFFECT_INSTANCE SP INFO SP number |
6848 |
|
</t> |
6849 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP number SP number |
6850 |
|
</t> |
6851 |
|
<t>/ MASTER_EFFECT_CHAINS SP number |
6852 |
|
</t> |
6853 |
|
<t>/ MASTER_EFFECT_CHAIN SP INFO SP number SP number |
6854 |
|
</t> |
6855 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
6856 |
</t> |
</t> |
6857 |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
6898 |
</t> |
</t> |
6899 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
6900 |
</t> |
</t> |
6901 |
|
<t>/ TOTAL_STREAM_COUNT |
6902 |
|
</t> |
6903 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6904 |
</t> |
</t> |
6905 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
6918 |
</t> |
</t> |
6919 |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
6920 |
</t> |
</t> |
6921 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6922 |
</t> |
</t> |
6923 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6924 |
</t> |
</t> |
6925 |
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
6926 |
</t> |
</t> |
6927 |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6928 |
</t> |
</t> |
6929 |
<t>/ DB_INSTRUMENTS SP pathname |
<t>/ DB_INSTRUMENTS SP db_path |
6930 |
</t> |
</t> |
6931 |
<t>/ DB_INSTRUMENT SP INFO SP pathname |
<t>/ DB_INSTRUMENT SP INFO SP db_path |
6932 |
</t> |
</t> |
6933 |
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
6934 |
</t> |
</t> |
6935 |
<t>/ VOLUME |
<t>/ VOLUME |
6936 |
</t> |
</t> |
6937 |
|
<t>/ VOICES |
6938 |
|
</t> |
6939 |
|
<t>/ STREAMS |
6940 |
|
</t> |
6941 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
6942 |
|
</t> |
6943 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6944 |
|
</t> |
6945 |
</list> |
</list> |
6946 |
</t> |
</t> |
6947 |
<t>set_instruction = |
<t>set_instruction = |
6952 |
</t> |
</t> |
6953 |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
6954 |
</t> |
</t> |
6955 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
6956 |
|
</t> |
6957 |
<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 |
6958 |
</t> |
</t> |
6959 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP number SP number SP effect_control_value |
6960 |
|
</t> |
6961 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
6962 |
</t> |
</t> |
6963 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
6970 |
</t> |
</t> |
6971 |
<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 |
6972 |
</t> |
</t> |
6973 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
6974 |
|
</t> |
6975 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
6976 |
</t> |
</t> |
6977 |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval |
<t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
6978 |
</t> |
</t> |
6979 |
<t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
6980 |
</t> |
</t> |
6981 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval |
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
6982 |
</t> |
</t> |
6983 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
6984 |
</t> |
</t> |
6985 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
6986 |
</t> |
</t> |
6987 |
|
<t>/ VOICES SP number |
6988 |
|
</t> |
6989 |
|
<t>/ STREAMS SP number |
6990 |
|
</t> |
6991 |
</list> |
</list> |
6992 |
</t> |
</t> |
6993 |
<t>create_instruction = |
<t>create_instruction = |
7004 |
</t> |
</t> |
7005 |
<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 |
7006 |
</t> |
</t> |
7007 |
|
<t>/ EFFECT_INSTANCE SP number |
7008 |
|
</t> |
7009 |
|
<t>/ EFFECT_INSTANCE SP string SP filename SP effect_name |
7010 |
|
</t> |
7011 |
</list> |
</list> |
7012 |
</t> |
</t> |
7013 |
<t>reset_instruction = |
<t>reset_instruction = |
7026 |
</t> |
</t> |
7027 |
<t>find_instruction = |
<t>find_instruction = |
7028 |
<list> |
<list> |
7029 |
<t>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list |
<t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
7030 |
</t> |
</t> |
7031 |
<t>/ DB_INSTRUMENTS SP pathname SP query_val_list |
<t>/ DB_INSTRUMENTS SP db_path SP query_val_list |
7032 |
</t> |
</t> |
7033 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
7034 |
</t> |
</t> |
7035 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
7036 |
|
</t> |
7037 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
7038 |
</t> |
</t> |
7039 |
</list> |
</list> |
7040 |
</t> |
</t> |
7041 |
<t>move_instruction = |
<t>move_instruction = |
7042 |
<list> |
<list> |
7043 |
<t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
7044 |
</t> |
</t> |
7045 |
<t>/ DB_INSTRUMENT SP pathname SP pathname |
<t>/ DB_INSTRUMENT SP db_path SP db_path |
7046 |
</t> |
</t> |
7047 |
</list> |
</list> |
7048 |
</t> |
</t> |
7049 |
<t>copy_instruction = |
<t>copy_instruction = |
7050 |
<list> |
<list> |
7051 |
<t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
7052 |
</t> |
</t> |
7053 |
<t>/ DB_INSTRUMENT SP pathname SP pathname |
<t>/ DB_INSTRUMENT SP db_path SP db_path |
7054 |
</t> |
</t> |
7055 |
</list> |
</list> |
7056 |
</t> |
</t> |
7062 |
</t> |
</t> |
7063 |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
7064 |
</t> |
</t> |
7065 |
|
<t>/ EFFECT_INSTANCE SP number |
7066 |
|
</t> |
7067 |
</list> |
</list> |
7068 |
</t> |
</t> |
7069 |
<t>load_instruction = |
<t>load_instruction = |
7074 |
</t> |
</t> |
7075 |
</list> |
</list> |
7076 |
</t> |
</t> |
7077 |
|
<t>append_instruction = |
7078 |
|
<list> |
7079 |
|
<t>MASTER_EFFECT_CHAIN SP EFFECT SP number SP number SP number |
7080 |
|
</t> |
7081 |
|
</list> |
7082 |
|
</t> |
7083 |
|
<t>insert_instruction = |
7084 |
|
<list> |
7085 |
|
<t>MASTER_EFFECT_CHAIN SP EFFECT SP number SP number SP number SP number |
7086 |
|
</t> |
7087 |
|
</list> |
7088 |
|
</t> |
7089 |
<t>set_chan_instruction = |
<t>set_chan_instruction = |
7090 |
<list> |
<list> |
7091 |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
7120 |
</t> |
</t> |
7121 |
<t>edit_instruction = |
<t>edit_instruction = |
7122 |
<list> |
<list> |
7123 |
<t>INSTRUMENT SP sampler_channel |
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
7124 |
|
</t> |
7125 |
|
</list> |
7126 |
|
</t> |
7127 |
|
<t>format_instruction = |
7128 |
|
<list> |
7129 |
|
<t>INSTRUMENTS_DB |
7130 |
</t> |
</t> |
7131 |
</list> |
</list> |
7132 |
</t> |
</t> |
7164 |
</t> |
</t> |
7165 |
<t>/ AVAILABLE_ENGINES |
<t>/ AVAILABLE_ENGINES |
7166 |
</t> |
</t> |
7167 |
|
<t>/ AVAILABLE_EFFECTS |
7168 |
|
</t> |
7169 |
|
<t>/ EFFECT_INSTANCES |
7170 |
|
</t> |
7171 |
|
<t>/ MASTER_EFFECT_CHAINS SP number |
7172 |
|
</t> |
7173 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
7174 |
</t> |
</t> |
7175 |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
7182 |
</t> |
</t> |
7183 |
<t>/ FX_SENDS SP sampler_channel |
<t>/ FX_SENDS SP sampler_channel |
7184 |
</t> |
</t> |
7185 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
7186 |
|
</t> |
7187 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
7188 |
</t> |
</t> |
7189 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
7190 |
</t> |
</t> |
7191 |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENTS SP db_path |
7192 |
</t> |
</t> |
7193 |
<t>/ DB_INSTRUMENTS SP pathname |
<t>/ FILE SP INSTRUMENTS SP filename |
7194 |
|
</t> |
7195 |
|
</list> |
7196 |
|
</t> |
7197 |
|
<t>send_instruction = |
7198 |
|
<list> |
7199 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
7200 |
</t> |
</t> |
7201 |
</list> |
</list> |
7202 |
</t> |
</t> |
7294 |
</t> |
</t> |
7295 |
</list> |
</list> |
7296 |
</t> |
</t> |
7297 |
|
<t>effect_control_value = |
7298 |
|
<list> |
7299 |
|
<t>real |
7300 |
|
</t> |
7301 |
|
</list> |
7302 |
|
</t> |
7303 |
<t>sampler_channel = |
<t>sampler_channel = |
7304 |
<list> |
<list> |
7305 |
<t>number |
<t>number |
7324 |
</t> |
</t> |
7325 |
</list> |
</list> |
7326 |
</t> |
</t> |
7327 |
<t>pathname = |
<t>filename = |
7328 |
<list> |
<list> |
7329 |
<t>stringval |
<t>path |
7330 |
</t> |
</t> |
7331 |
</list> |
</list> |
7332 |
</t> |
</t> |
7333 |
<t>dirname = |
<t>db_path = |
7334 |
<list> |
<list> |
7335 |
<t>stringval |
<t>path |
7336 |
</t> |
</t> |
7337 |
</list> |
</list> |
7338 |
</t> |
</t> |
7339 |
<t>filename = |
<t>map_name = |
7340 |
<list> |
<list> |
7341 |
<t>stringval_escaped |
<t>stringval_escaped |
7342 |
</t> |
</t> |
7343 |
</list> |
</list> |
7344 |
</t> |
</t> |
7345 |
<t>map_name = |
<t>entry_name = |
7346 |
<list> |
<list> |
7347 |
<t>stringval |
<t>stringval_escaped |
7348 |
</t> |
</t> |
7349 |
</list> |
</list> |
7350 |
</t> |
</t> |
7351 |
<t>entry_name = |
<t>fx_send_name = |
7352 |
<list> |
<list> |
7353 |
<t>stringval |
<t>stringval_escaped |
7354 |
</t> |
</t> |
7355 |
</list> |
</list> |
7356 |
</t> |
</t> |
7357 |
<t>fx_send_name = |
<t>effect_name = |
7358 |
<list> |
<list> |
7359 |
<t>stringval |
<t>stringval_escaped |
7360 |
</t> |
</t> |
7361 |
</list> |
</list> |
7362 |
</t> |
</t> |
7368 |
</t> |
</t> |
7369 |
</list> |
</list> |
7370 |
</t> |
</t> |
7371 |
|
|
7372 |
<t>param_val = |
<t>param_val = |
7373 |
<list> |
<list> |
7374 |
<t>string |
<t>string |
7391 |
</t> |
</t> |
7392 |
<t>query_val = |
<t>query_val = |
7393 |
<list> |
<list> |
7394 |
<t>string |
<t>text_escaped |
7395 |
</t> |
</t> |
7396 |
<t>/ stringval |
<t>/ stringval_escaped |
7397 |
</t> |
</t> |
7398 |
</list> |
</list> |
7399 |
</t> |
</t> |
7411 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
7412 |
|
|
7413 |
<section title="Character Set and Escape Sequences" anchor="character_set"> |
<section title="Character Set and Escape Sequences" anchor="character_set"> |
7414 |
<t>Older versions of this protocol up to and including v1.2 only |
<t>Older versions of this protocol up to and including v1.1 only |
7415 |
supported the standard ASCII character set (ASCII code 0 - 127) |
supported the standard ASCII character set (ASCII code 0 - 127) |
7416 |
<xref target="RFC20"/>, all younger versions of this protocol |
<xref target="RFC20"/>, all younger versions of this protocol |
7417 |
however support the Extended ASCII character set (ASCII code |
however support the Extended ASCII character set (ASCII code |
7435 |
</texttable> |
</texttable> |
7436 |
<t>Notice: due to the transition of certain parts of the |
<t>Notice: due to the transition of certain parts of the |
7437 |
protocol which now support escape sequences, a slight backward |
protocol which now support escape sequences, a slight backward |
7438 |
incompatibility to protocols version v1.2 and younger has been |
incompatibility to protocols version v1.1 and younger has been |
7439 |
introduced. The only difference is that in parts of the protocol |
introduced. The only difference is that in parts of the protocol |
7440 |
where escape characters are now supported, a backslash characters |
where escape characters are now supported, a backslash characters |
7441 |
MUST be escaped as well (that is as double backslash), whereas |
MUST be escaped as well (that is as double backslash), whereas |
7442 |
in the old versions a single backslash was sufficient.</t> |
in the old versions a single backslash was sufficient.</t> |
7443 |
|
|
7444 |
|
<t>The following LSCP commands support escape sequences as part |
7445 |
|
of their filename / path based arguments and / or may contain |
7446 |
|
a filename / path with escape sequences in their response: |
7447 |
|
<list> |
7448 |
|
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
7449 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
7450 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
7451 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
7452 |
|
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
7453 |
|
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
7454 |
|
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
7455 |
|
<t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t> |
7456 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7457 |
|
<t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7458 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
7459 |
|
<t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t> |
7460 |
|
<t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t> |
7461 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
7462 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
7463 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
7464 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
7465 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
7466 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
7467 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7468 |
|
<t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t> |
7469 |
|
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
7470 |
|
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
7471 |
|
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
7472 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
7473 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
7474 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
7475 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
7476 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
7477 |
|
</list> |
7478 |
|
Note that the forward slash character ('/') has a special meaning in |
7479 |
|
filename / path based arguments: it acts as separator of the nodes in |
7480 |
|
the path, thus if a directory- or filename includes a forward slash |
7481 |
|
(not intended as path node separator), you MUST escape that slash |
7482 |
|
either with the respective hex escape sequence ("\x2f") or with the |
7483 |
|
respective octal escape sequence ("\057"). |
7484 |
|
</t> |
7485 |
|
|
7486 |
|
<t> |
7487 |
|
Note for Windows: file path arguments in LSCP are expected |
7488 |
|
to use forward slashes as directory node separator similar |
7489 |
|
to Unix based operating systems. In contrast to Unix however |
7490 |
|
a Windows typical drive character is expected to be |
7491 |
|
prefixed to the path. That is an original Windows file path |
7492 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
7493 |
|
"D:/Sounds/My.gig". |
7494 |
|
</t> |
7495 |
|
|
7496 |
|
<t> |
7497 |
|
The following LSCP commands even support escape sequences as |
7498 |
|
part of at least one of their text-based arguments (i.e. entity name, |
7499 |
|
description) and / or may contain escape sequences in at least one of |
7500 |
|
their text-based fields in their response: |
7501 |
|
<list> |
7502 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
7503 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
7504 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
7505 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
7506 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
7507 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
7508 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
7509 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
7510 |
|
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
7511 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
7512 |
|
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
7513 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
7514 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
7515 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
7516 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7517 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
7518 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
7519 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
7520 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
7521 |
|
</list> |
7522 |
|
Please note that these lists are manually maintained. If you |
7523 |
|
find a command that also supports escape sequences we forgot to |
7524 |
|
mention here, please report it! |
7525 |
|
</t> |
7526 |
</section> |
</section> |
7527 |
</section> |
</section> |
7528 |
|
|
7627 |
of sampler channels.</t> |
of sampler channels.</t> |
7628 |
</section> |
</section> |
7629 |
|
|
7630 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
7631 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
7632 |
|
back-end side, by issuing the following command:</t> |
7633 |
|
<t> |
7634 |
|
<list> |
7635 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
7636 |
|
</list> |
7637 |
|
</t> |
7638 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7639 |
|
<t> |
7640 |
|
<list> |
7641 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
7642 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
7643 |
|
</list> |
7644 |
|
</t> |
7645 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
7646 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7647 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7648 |
|
</t> |
7649 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7650 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7651 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7652 |
|
thread unaffected by this feature.</t> |
7653 |
|
</section> |
7654 |
|
|
7655 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
7656 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
7657 |
|
<t> |
7658 |
|
<list> |
7659 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
7660 |
|
</list> |
7661 |
|
</t> |
7662 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7663 |
|
<t> |
7664 |
|
<list> |
7665 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
7666 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
7667 |
|
</list> |
7668 |
|
</t> |
7669 |
|
<t>where <device-id> <port-id> will be replaced |
7670 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
7671 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7672 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7673 |
|
</t> |
7674 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7675 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7676 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7677 |
|
thread unaffected by this feature.</t> |
7678 |
|
</section> |
7679 |
|
|
7680 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
7681 |
<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 |
7682 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7814 |
all currently active voices.</t> |
all currently active voices.</t> |
7815 |
</section> |
</section> |
7816 |
|
|
7817 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
7818 |
|
<t>Client may want to be notified when the total number of disk streams on the |
7819 |
|
back-end changes by issuing the following command:</t> |
7820 |
|
<t> |
7821 |
|
<list> |
7822 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
7823 |
|
</list> |
7824 |
|
</t> |
7825 |
|
<t>Server will start sending the following notification messages:</t> |
7826 |
|
<t> |
7827 |
|
<list> |
7828 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
7829 |
|
</list> |
7830 |
|
</t> |
7831 |
|
<t>where <streams> will be replaced by the new number of |
7832 |
|
all currently active disk streams.</t> |
7833 |
|
</section> |
7834 |
|
|
7835 |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
7836 |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
7837 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7930 |
replaced by the optional dotted floating point value, reflecting the |
replaced by the optional dotted floating point value, reflecting the |
7931 |
new global volume parameter.</t> |
new global volume parameter.</t> |
7932 |
</list> |
</list> |
7933 |
|
<list> |
7934 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
7935 |
|
golbal limit of the sampler for maximum voices is changed, where |
7936 |
|
<max-voices> will be an integer value, reflecting the |
7937 |
|
new global voice limit parameter.</t> |
7938 |
|
</list> |
7939 |
|
<list> |
7940 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
7941 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
7942 |
|
<max-streams> will be an integer value, reflecting the |
7943 |
|
new global disk streams limit parameter.</t> |
7944 |
|
</list> |
7945 |
</t> |
</t> |
7946 |
</section> |
</section> |
7947 |
|
|