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.2cvs"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.4"> |
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="October" year="2007"/> |
<date month="April" year="2008"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
2162 |
</t> |
</t> |
2163 |
</list> |
</list> |
2164 |
</t> |
</t> |
2165 |
<t>Example:</t> |
<t>Example (Unix):</t> |
2166 |
<t> |
<t> |
2167 |
<list> |
<list> |
2168 |
<t></t> |
<t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t> |
2169 |
|
<t>S: OK</t> |
2170 |
|
</list> |
2171 |
|
</t> |
2172 |
|
<t>Example (Windows):</t> |
2173 |
|
<t> |
2174 |
|
<list> |
2175 |
|
<t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t> |
2176 |
|
<t>S: OK</t> |
2177 |
</list> |
</list> |
2178 |
</t> |
</t> |
2179 |
</section> |
</section> |
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 - |
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 - |
2548 |
</t> |
</t> |
2549 |
<t>INSTRUMENT_NAME - |
<t>INSTRUMENT_NAME - |
2550 |
<list> |
<list> |
2551 |
<t>the instrument name of the loaded instrument</t> |
<t>the instrument name of the loaded instrument |
2552 |
|
(note: since LSCP 1.2 this character string may contain |
2553 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2554 |
</list> |
</list> |
2555 |
</t> |
</t> |
2556 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
3460 |
<list> |
<list> |
3461 |
<t>NAME - |
<t>NAME - |
3462 |
<list> |
<list> |
3463 |
<t>name of the effect send entity</t> |
<t>name of the effect send entity |
3464 |
|
(note that this character string may contain |
3465 |
|
<xref target="character_set">escape sequences</xref>)</t> |
3466 |
</list> |
</list> |
3467 |
</t> |
</t> |
3468 |
<t>MIDI_CONTROLLER - |
<t>MIDI_CONTROLLER - |
3711 |
</t> |
</t> |
3712 |
</section> |
</section> |
3713 |
|
|
3714 |
|
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
3715 |
|
<t>The front-end can send MIDI events to specific sampler channel |
3716 |
|
by sending the following command:</t> |
3717 |
|
<t> |
3718 |
|
<list> |
3719 |
|
<t>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2></t> |
3720 |
|
</list> |
3721 |
|
</t> |
3722 |
|
<t>Where <sampler-chan> is the sampler channel number |
3723 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3724 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3725 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
3726 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported:</t> |
3727 |
|
<t> |
3728 |
|
<list> |
3729 |
|
<t>"NOTE_ON" - |
3730 |
|
<list> |
3731 |
|
<t>For turning on MIDI notes, where <arg1> |
3732 |
|
specifies the key number and <arg2> the velocity |
3733 |
|
as described in the MIDI specification.</t> |
3734 |
|
</list> |
3735 |
|
</t> |
3736 |
|
<t>"NOTE_OFF" - |
3737 |
|
<list> |
3738 |
|
<t>For turning a currently playing MIDI note off, where <arg1> |
3739 |
|
specifies the key number and <arg2> the velocity |
3740 |
|
as described in the MIDI specification.</t> |
3741 |
|
</list> |
3742 |
|
</t> |
3743 |
|
</list> |
3744 |
|
</t> |
3745 |
|
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
3746 |
|
and no realtime guarantee whatsoever will be made!</t> |
3747 |
|
<t>Possible Answers:</t> |
3748 |
|
<t> |
3749 |
|
<list> |
3750 |
|
<t>"OK" - |
3751 |
|
<list> |
3752 |
|
<t>on success</t> |
3753 |
|
</list> |
3754 |
|
</t> |
3755 |
|
<t>"ERR:<error-code>:<error-message>" - |
3756 |
|
<list> |
3757 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3758 |
|
</list> |
3759 |
|
</t> |
3760 |
|
</list> |
3761 |
|
</t> |
3762 |
|
<t>Example:</t> |
3763 |
|
<t> |
3764 |
|
<list> |
3765 |
|
<t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t> |
3766 |
|
<t>S: "OK"</t> |
3767 |
|
</list> |
3768 |
|
</t> |
3769 |
|
</section> |
3770 |
|
|
3771 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3772 |
<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> |
3773 |
<t> |
<t> |
3989 |
</t> |
</t> |
3990 |
</section> |
</section> |
3991 |
|
|
3992 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
3993 |
|
<t>The front-end can ask for the current number of active disk streams on |
3994 |
|
the sampler by sending the following command:</t> |
3995 |
|
<t> |
3996 |
|
<list> |
3997 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
3998 |
|
</list> |
3999 |
|
</t> |
4000 |
|
|
4001 |
|
<t>Possible Answers:</t> |
4002 |
|
<t> |
4003 |
|
<list> |
4004 |
|
<t>LinuxSampler will answer by returning the number of all active |
4005 |
|
disk streams on the sampler.</t> |
4006 |
|
</list> |
4007 |
|
</t> |
4008 |
|
</section> |
4009 |
|
|
4010 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
4011 |
<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> |
4012 |
<t> |
<t> |
4356 |
<t>NAME - |
<t>NAME - |
4357 |
<list> |
<list> |
4358 |
<t>custom name of the given map, |
<t>custom name of the given map, |
4359 |
which does not have to be unique</t> |
which does not have to be unique |
4360 |
|
(note that this character string may contain |
4361 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4362 |
</list> |
</list> |
4363 |
</t> |
</t> |
4364 |
<t>DEFAULT - |
<t>DEFAULT - |
4755 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
4756 |
changed with the |
changed with the |
4757 |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
4758 |
command and does not have to be unique.</t> |
command and does not have to be unique. |
4759 |
|
(note that this character string may contain |
4760 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4761 |
</list> |
</list> |
4762 |
</t> |
</t> |
4763 |
<t>"ENGINE_NAME" - |
<t>"ENGINE_NAME" - |
4768 |
</t> |
</t> |
4769 |
<t>"INSTRUMENT_FILE" - |
<t>"INSTRUMENT_FILE" - |
4770 |
<list> |
<list> |
4771 |
<t>File name of the instrument.</t> |
<t>File name of the instrument |
4772 |
|
(note that this path may contain |
4773 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4774 |
</list> |
</list> |
4775 |
</t> |
</t> |
4776 |
<t>"INSTRUMENT_NR" - |
<t>"INSTRUMENT_NR" - |
4782 |
<list> |
<list> |
4783 |
<t>Name of the loaded instrument as reflected by its file. |
<t>Name of the loaded instrument as reflected by its file. |
4784 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
4785 |
cannot be changed.</t> |
cannot be changed (note that this character string may contain |
4786 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4787 |
</list> |
</list> |
4788 |
</t> |
</t> |
4789 |
<t>"LOAD_MODE" - |
<t>"LOAD_MODE" - |
5798 |
</list> |
</list> |
5799 |
</t> |
</t> |
5800 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
5801 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
5802 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5803 |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5804 |
|
|
6041 |
<t>FORMAT INSTRUMENTS_DB</t> |
<t>FORMAT INSTRUMENTS_DB</t> |
6042 |
</list> |
</list> |
6043 |
</t> |
</t> |
6044 |
|
|
6045 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
6046 |
<t> |
<t> |
6047 |
<list> |
<list> |
6060 |
</t> |
</t> |
6061 |
</section> |
</section> |
6062 |
|
|
6063 |
|
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES"> |
6064 |
|
<t>The front-end can retrieve the list of all instrument files in the instruments database |
6065 |
|
that don't exist in the filesystem by sending the following command:</t> |
6066 |
|
<t> |
6067 |
|
<list> |
6068 |
|
<t>FIND LOST DB_INSTRUMENT_FILES</t> |
6069 |
|
</list> |
6070 |
|
</t> |
6071 |
|
|
6072 |
|
<t>Possible Answers:</t> |
6073 |
|
<t> |
6074 |
|
<list> |
6075 |
|
<t>A comma separated list with the absolute path names |
6076 |
|
(encapsulated into apostrophes) of all lost instrument files.</t> |
6077 |
|
<t>"ERR:<error-code>:<error-message>" - |
6078 |
|
<list> |
6079 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6080 |
|
</list> |
6081 |
|
</t> |
6082 |
|
</list> |
6083 |
|
</t> |
6084 |
|
<t>Example:</t> |
6085 |
|
<t> |
6086 |
|
<list> |
6087 |
|
<t>C: "FIND LOST DB_INSTRUMENT_FILES"</t> |
6088 |
|
<t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t> |
6089 |
|
</list> |
6090 |
|
</t> |
6091 |
|
</section> |
6092 |
|
|
6093 |
|
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH"> |
6094 |
|
<t>The front-end can substitute all occurrences of an instrument file |
6095 |
|
in the instruments database with a new one by sending the following command:</t> |
6096 |
|
<t> |
6097 |
|
<list> |
6098 |
|
<t>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path></t> |
6099 |
|
</list> |
6100 |
|
</t> |
6101 |
|
<t>Where <old_path> is the absolute path name of the instrument file |
6102 |
|
to substitute with <new_path>.</t> |
6103 |
|
|
6104 |
|
<t>Possible Answers:</t> |
6105 |
|
<t> |
6106 |
|
<list> |
6107 |
|
<t>"OK" - |
6108 |
|
<list> |
6109 |
|
<t>on success</t> |
6110 |
|
</list> |
6111 |
|
</t> |
6112 |
|
<t>"ERR:<error-code>:<error-message>" - |
6113 |
|
<list> |
6114 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6115 |
|
</list> |
6116 |
|
</t> |
6117 |
|
</list> |
6118 |
|
</t> |
6119 |
|
|
6120 |
|
<t>Example:</t> |
6121 |
|
<t> |
6122 |
|
<list> |
6123 |
|
<t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t> |
6124 |
|
<t>S: "OK"</t> |
6125 |
|
</list> |
6126 |
|
</t> |
6127 |
|
</section> |
6128 |
|
|
6129 |
</section> |
</section> |
6130 |
|
|
6131 |
|
|
6146 |
editor application by sending the following command:</t> |
editor application by sending the following command:</t> |
6147 |
<t> |
<t> |
6148 |
<list> |
<list> |
6149 |
<t>EDIT INSTRUMENT <sampler-channel></t> |
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6150 |
</list> |
</list> |
6151 |
</t> |
</t> |
6152 |
<t>Where <sampler-channel> should be replaced by the |
<t>Where <sampler-channel> should be replaced by the |
6198 |
<t>Examples:</t> |
<t>Examples:</t> |
6199 |
<t> |
<t> |
6200 |
<list> |
<list> |
6201 |
<t>C: "EDIT INSTRUMENT 0"</t> |
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6202 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
6203 |
</list> |
</list> |
6204 |
</t> |
</t> |
6205 |
</section> |
</section> |
6206 |
</section> |
</section> |
|
</section> |
|
6207 |
|
|
6208 |
|
<section title="Managing Files" anchor="file_management"> |
6209 |
|
<t>You can query detailed informations about files located |
6210 |
|
at the same system where the sampler instance is running on. |
6211 |
|
Using this command set allows to retrieve file informations |
6212 |
|
even remotely from another machine.</t> |
6213 |
|
|
6214 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
6215 |
|
<t>The front-end can retrieve the amount of instruments |
6216 |
|
within a given instrument file by sending the |
6217 |
|
following command:</t> |
6218 |
|
<t> |
6219 |
|
<list> |
6220 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
6221 |
|
</list> |
6222 |
|
</t> |
6223 |
|
<t>Where <filename> is the name of the instrument |
6224 |
|
file (encapsulated into apostrophes, supporting escape |
6225 |
|
sequences as described in chapter |
6226 |
|
"<xref target="character_set">Character Set and Escape |
6227 |
|
Sequences</xref>").</t> |
6228 |
|
|
6229 |
|
<t>The sampler will try to ask all sampler engines, |
6230 |
|
whether they support the given file and ask the first |
6231 |
|
engine with a positive answer for the amount of |
6232 |
|
instruments.</t> |
6233 |
|
|
6234 |
|
<t>Possible Answers:</t> |
6235 |
|
<t> |
6236 |
|
<list> |
6237 |
|
<t>On success, the sampler will answer by |
6238 |
|
returning the amount of instruments. |
6239 |
|
</t> |
6240 |
|
<t>"ERR:<error-code>:<error-message>" - |
6241 |
|
<list> |
6242 |
|
<t>if the file could not be handled</t> |
6243 |
|
</list> |
6244 |
|
</t> |
6245 |
|
</list> |
6246 |
|
</t> |
6247 |
|
|
6248 |
|
<t>Examples:</t> |
6249 |
|
<t> |
6250 |
|
<list> |
6251 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6252 |
|
<t>S: "10"</t> |
6253 |
|
</list> |
6254 |
|
</t> |
6255 |
|
</section> |
6256 |
|
|
6257 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
6258 |
|
<t>The front-end can retrieve a list of all instruments |
6259 |
|
within a given instrument file by sending the |
6260 |
|
following command:</t> |
6261 |
|
<t> |
6262 |
|
<list> |
6263 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
6264 |
|
</list> |
6265 |
|
</t> |
6266 |
|
<t>Where <filename> is the name of the instrument |
6267 |
|
file (encapsulated into apostrophes, supporting escape |
6268 |
|
sequences as described in chapter |
6269 |
|
"<xref target="character_set">Character Set and Escape |
6270 |
|
Sequences</xref>").</t> |
6271 |
|
|
6272 |
|
<t>The sampler will try to ask all sampler engines, |
6273 |
|
whether they support the given file and ask the first |
6274 |
|
engine with a positive answer for a list of IDs for the |
6275 |
|
instruments in the given file.</t> |
6276 |
|
|
6277 |
|
<t>Possible Answers:</t> |
6278 |
|
<t> |
6279 |
|
<list> |
6280 |
|
<t>On success, the sampler will answer by |
6281 |
|
returning a comma separated list of |
6282 |
|
instrument IDs. |
6283 |
|
</t> |
6284 |
|
<t>"ERR:<error-code>:<error-message>" - |
6285 |
|
<list> |
6286 |
|
<t>if the file could not be handled</t> |
6287 |
|
</list> |
6288 |
|
</t> |
6289 |
|
</list> |
6290 |
|
</t> |
6291 |
|
|
6292 |
|
<t>Examples:</t> |
6293 |
|
<t> |
6294 |
|
<list> |
6295 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6296 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
6297 |
|
</list> |
6298 |
|
</t> |
6299 |
|
</section> |
6300 |
|
|
6301 |
|
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
6302 |
|
<t>The front-end can retrieve detailed informations |
6303 |
|
about a specific instrument within a given instrument |
6304 |
|
file by sending the following command:</t> |
6305 |
|
<t> |
6306 |
|
<list> |
6307 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
6308 |
|
<instr-id></t> |
6309 |
|
</list> |
6310 |
|
</t> |
6311 |
|
<t>Where <filename> is the name of the instrument |
6312 |
|
file (encapsulated into apostrophes, supporting escape |
6313 |
|
sequences as described in chapter |
6314 |
|
"<xref target="character_set">Character Set and Escape |
6315 |
|
Sequences</xref>") and <instr-id> is the numeric |
6316 |
|
instrument ID as returned by the |
6317 |
|
<xref target="LIST FILE INSTRUMENTS"> |
6318 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
6319 |
|
|
6320 |
|
<t>The sampler will try to ask all sampler engines, |
6321 |
|
whether they support the given file and ask the first |
6322 |
|
engine with a positive answer for informations about the |
6323 |
|
specific instrument in the given file.</t> |
6324 |
|
|
6325 |
|
<t>Possible Answers:</t> |
6326 |
|
<t> |
6327 |
|
<list> |
6328 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6329 |
|
Each answer line begins with the settings category name |
6330 |
|
followed by a colon and then a space character <SP> and finally |
6331 |
|
the info character string to that setting category. At the |
6332 |
|
moment the following categories are defined:</t> |
6333 |
|
|
6334 |
|
<t> |
6335 |
|
<list> |
6336 |
|
<t>NAME - |
6337 |
|
<list> |
6338 |
|
<t>name of the instrument as |
6339 |
|
stored in the instrument file</t> |
6340 |
|
</list> |
6341 |
|
</t> |
6342 |
|
<t>FORMAT_FAMILY - |
6343 |
|
<list> |
6344 |
|
<t>name of the sampler format |
6345 |
|
of the given instrument</t> |
6346 |
|
</list> |
6347 |
|
</t> |
6348 |
|
<t>FORMAT_VERSION - |
6349 |
|
<list> |
6350 |
|
<t>version of the sampler format |
6351 |
|
the instrumen is stored as</t> |
6352 |
|
</list> |
6353 |
|
</t> |
6354 |
|
<t>PRODUCT - |
6355 |
|
<list> |
6356 |
|
<t>official product name of the |
6357 |
|
instrument as stored in the file |
6358 |
|
</t> |
6359 |
|
</list> |
6360 |
|
</t> |
6361 |
|
<t>ARTISTS - |
6362 |
|
<list> |
6363 |
|
<t>artists / sample library |
6364 |
|
vendor of the instrument</t> |
6365 |
|
</list> |
6366 |
|
</t> |
6367 |
|
<t>KEY_BINDINGS - |
6368 |
|
<list> |
6369 |
|
<t>comma separated list of integer values representing |
6370 |
|
the instrument's key mapping in the range between 0 .. 127, |
6371 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6372 |
|
</list> |
6373 |
|
</t> |
6374 |
|
<t>KEYSWITCH_BINDINGS - |
6375 |
|
<list> |
6376 |
|
<t>comma separated list of integer values representing |
6377 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
6378 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6379 |
|
</list> |
6380 |
|
</t> |
6381 |
|
</list> |
6382 |
|
</t> |
6383 |
|
</list> |
6384 |
|
</t> |
6385 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6386 |
|
|
6387 |
|
<t>Example:</t> |
6388 |
|
<t> |
6389 |
|
<list> |
6390 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
6391 |
|
<t>S: "NAME: Lunatic Loops"</t> |
6392 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6393 |
|
<t> "FORMAT_VERSION: 3"</t> |
6394 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
6395 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
6396 |
|
<t> "."</t> |
6397 |
|
</list> |
6398 |
|
</t> |
6399 |
|
</section> |
6400 |
|
</section> |
6401 |
|
</section> |
6402 |
|
|
6403 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
6404 |
<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"/> |
6484 |
</t> |
</t> |
6485 |
<t>/ EDIT SP edit_instruction |
<t>/ EDIT SP edit_instruction |
6486 |
</t> |
</t> |
6487 |
<t>/ FORMAT SP format_instruction |
<t>/ FORMAT SP format_instruction |
6488 |
|
</t> |
6489 |
|
<t>SEND SP send_instruction |
6490 |
</t> |
</t> |
6491 |
<t>/ RESET |
<t>/ RESET |
6492 |
</t> |
</t> |
6530 |
</t> |
</t> |
6531 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6532 |
</t> |
</t> |
6533 |
|
<t>/ CHANNEL_MIDI |
6534 |
|
</t> |
6535 |
|
<t>/ DEVICE_MIDI |
6536 |
|
</t> |
6537 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6538 |
</t> |
</t> |
6539 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6566 |
</t> |
</t> |
6567 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6568 |
</t> |
</t> |
6569 |
|
<t>/ TOTAL_STREAM_COUNT |
6570 |
|
</t> |
6571 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6572 |
</t> |
</t> |
6573 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6586 |
</t> |
</t> |
6587 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6588 |
</t> |
</t> |
6589 |
|
<t>/ CHANNEL_MIDI |
6590 |
|
</t> |
6591 |
|
<t>/ DEVICE_MIDI |
6592 |
|
</t> |
6593 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6594 |
</t> |
</t> |
6595 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6622 |
</t> |
</t> |
6623 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6624 |
</t> |
</t> |
6625 |
|
<t>/ TOTAL_STREAM_COUNT |
6626 |
|
</t> |
6627 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6628 |
</t> |
</t> |
6629 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6714 |
</t> |
</t> |
6715 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
6716 |
</t> |
</t> |
6717 |
|
<t>/ TOTAL_STREAM_COUNT |
6718 |
|
</t> |
6719 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6720 |
</t> |
</t> |
6721 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
6750 |
</t> |
</t> |
6751 |
<t>/ VOLUME |
<t>/ VOLUME |
6752 |
</t> |
</t> |
6753 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
6754 |
|
</t> |
6755 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6756 |
|
</t> |
6757 |
</list> |
</list> |
6758 |
</t> |
</t> |
6759 |
<t>set_instruction = |
<t>set_instruction = |
6788 |
</t> |
</t> |
6789 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
6790 |
</t> |
</t> |
6791 |
|
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
6792 |
|
</t> |
6793 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
6794 |
</t> |
</t> |
6795 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
6836 |
</t> |
</t> |
6837 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
6838 |
</t> |
</t> |
6839 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
6840 |
|
</t> |
6841 |
</list> |
</list> |
6842 |
</t> |
</t> |
6843 |
<t>move_instruction = |
<t>move_instruction = |
6908 |
</t> |
</t> |
6909 |
<t>edit_instruction = |
<t>edit_instruction = |
6910 |
<list> |
<list> |
6911 |
<t>INSTRUMENT SP sampler_channel |
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
6912 |
</t> |
</t> |
6913 |
</list> |
</list> |
6914 |
</t> |
</t> |
6972 |
</t> |
</t> |
6973 |
<t>/ DB_INSTRUMENTS SP db_path |
<t>/ DB_INSTRUMENTS SP db_path |
6974 |
</t> |
</t> |
6975 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
6976 |
|
</t> |
6977 |
|
</list> |
6978 |
|
</t> |
6979 |
|
<t>send_instruction = |
6980 |
|
<list> |
6981 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
6982 |
|
</t> |
6983 |
</list> |
</list> |
6984 |
</t> |
</t> |
6985 |
<t>load_instr_args = |
<t>load_instr_args = |
7212 |
in the old versions a single backslash was sufficient.</t> |
in the old versions a single backslash was sufficient.</t> |
7213 |
|
|
7214 |
<t>The following LSCP commands support escape sequences as part |
<t>The following LSCP commands support escape sequences as part |
7215 |
of their filename / path based arguments: |
of their filename / path based arguments and / or may contain |
7216 |
|
a filename / path with escape sequences in their response: |
7217 |
<list> |
<list> |
7218 |
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
7219 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
7220 |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
7221 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
7222 |
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
7223 |
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
7224 |
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
7239 |
<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> |
7240 |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
7241 |
<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> |
7242 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
7243 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
7244 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
7245 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
7246 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
7247 |
</list> |
</list> |
7248 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
7249 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
7254 |
</t> |
</t> |
7255 |
|
|
7256 |
<t> |
<t> |
7257 |
|
Note for Windows: file path arguments in LSCP are expected |
7258 |
|
to use forward slashes as directory node separator similar |
7259 |
|
to Unix based operating systems. In contrast to Unix however |
7260 |
|
a Windows typical drive character is expected to be |
7261 |
|
prefixed to the path. That is an original Windows file path |
7262 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
7263 |
|
"D:/Sounds/My.gig". |
7264 |
|
</t> |
7265 |
|
|
7266 |
|
<t> |
7267 |
The following LSCP commands even support escape sequences as |
The following LSCP commands even support escape sequences as |
7268 |
part of at least one of their text-based arguments (i.e. entity name, |
part of at least one of their text-based arguments (i.e. entity name, |
7269 |
description): |
description) and / or may contain escape sequences in at least one of |
7270 |
|
their text-based fields in their response: |
7271 |
<list> |
<list> |
7272 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
7273 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
7274 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
7275 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
7276 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
7277 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
7278 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
7279 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
7280 |
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
7281 |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
7282 |
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
7283 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
7284 |
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
7285 |
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
7286 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7287 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
7288 |
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
7289 |
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
7290 |
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
7291 |
</list> |
</list> |
7292 |
Please note that these lists are manually maintained. If you |
Please note that these lists are manually maintained. If you |
7293 |
find a command that also supports escape sequences we forgot to |
find a command that also supports escape sequences we forgot to |
7397 |
of sampler channels.</t> |
of sampler channels.</t> |
7398 |
</section> |
</section> |
7399 |
|
|
7400 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
7401 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
7402 |
|
back-end side, by issuing the following command:</t> |
7403 |
|
<t> |
7404 |
|
<list> |
7405 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
7406 |
|
</list> |
7407 |
|
</t> |
7408 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7409 |
|
<t> |
7410 |
|
<list> |
7411 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
7412 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
7413 |
|
</list> |
7414 |
|
</t> |
7415 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
7416 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7417 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7418 |
|
</t> |
7419 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7420 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7421 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7422 |
|
thread unaffected by this feature.</t> |
7423 |
|
</section> |
7424 |
|
|
7425 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
7426 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
7427 |
|
<t> |
7428 |
|
<list> |
7429 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
7430 |
|
</list> |
7431 |
|
</t> |
7432 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7433 |
|
<t> |
7434 |
|
<list> |
7435 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
7436 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
7437 |
|
</list> |
7438 |
|
</t> |
7439 |
|
<t>where <device-id> <port-id> will be replaced |
7440 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
7441 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7442 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7443 |
|
</t> |
7444 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7445 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7446 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7447 |
|
thread unaffected by this feature.</t> |
7448 |
|
</section> |
7449 |
|
|
7450 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
7451 |
<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 |
7452 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7584 |
all currently active voices.</t> |
all currently active voices.</t> |
7585 |
</section> |
</section> |
7586 |
|
|
7587 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
7588 |
|
<t>Client may want to be notified when the total number of disk streams on the |
7589 |
|
back-end changes by issuing the following command:</t> |
7590 |
|
<t> |
7591 |
|
<list> |
7592 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
7593 |
|
</list> |
7594 |
|
</t> |
7595 |
|
<t>Server will start sending the following notification messages:</t> |
7596 |
|
<t> |
7597 |
|
<list> |
7598 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
7599 |
|
</list> |
7600 |
|
</t> |
7601 |
|
<t>where <streams> will be replaced by the new number of |
7602 |
|
all currently active disk streams.</t> |
7603 |
|
</section> |
7604 |
|
|
7605 |
<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"> |
7606 |
<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 |
7607 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |