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="February" 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 - |
3932 |
</t> |
</t> |
3933 |
</section> |
</section> |
3934 |
|
|
3935 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
3936 |
|
<t>The front-end can ask for the current number of active disk streams on |
3937 |
|
the sampler by sending the following command:</t> |
3938 |
|
<t> |
3939 |
|
<list> |
3940 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
3941 |
|
</list> |
3942 |
|
</t> |
3943 |
|
|
3944 |
|
<t>Possible Answers:</t> |
3945 |
|
<t> |
3946 |
|
<list> |
3947 |
|
<t>LinuxSampler will answer by returning the number of all active |
3948 |
|
disk streams on the sampler.</t> |
3949 |
|
</list> |
3950 |
|
</t> |
3951 |
|
</section> |
3952 |
|
|
3953 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
3954 |
<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> |
3955 |
<t> |
<t> |
4299 |
<t>NAME - |
<t>NAME - |
4300 |
<list> |
<list> |
4301 |
<t>custom name of the given map, |
<t>custom name of the given map, |
4302 |
which does not have to be unique</t> |
which does not have to be unique |
4303 |
|
(note that this character string may contain |
4304 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4305 |
</list> |
</list> |
4306 |
</t> |
</t> |
4307 |
<t>DEFAULT - |
<t>DEFAULT - |
4698 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
4699 |
changed with the |
changed with the |
4700 |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
4701 |
command and does not have to be unique.</t> |
command and does not have to be unique. |
4702 |
|
(note that this character string may contain |
4703 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4704 |
</list> |
</list> |
4705 |
</t> |
</t> |
4706 |
<t>"ENGINE_NAME" - |
<t>"ENGINE_NAME" - |
4711 |
</t> |
</t> |
4712 |
<t>"INSTRUMENT_FILE" - |
<t>"INSTRUMENT_FILE" - |
4713 |
<list> |
<list> |
4714 |
<t>File name of the instrument.</t> |
<t>File name of the instrument |
4715 |
|
(note that this path may contain |
4716 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4717 |
</list> |
</list> |
4718 |
</t> |
</t> |
4719 |
<t>"INSTRUMENT_NR" - |
<t>"INSTRUMENT_NR" - |
4725 |
<list> |
<list> |
4726 |
<t>Name of the loaded instrument as reflected by its file. |
<t>Name of the loaded instrument as reflected by its file. |
4727 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
4728 |
cannot be changed.</t> |
cannot be changed (note that this character string may contain |
4729 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4730 |
</list> |
</list> |
4731 |
</t> |
</t> |
4732 |
<t>"LOAD_MODE" - |
<t>"LOAD_MODE" - |
5741 |
</list> |
</list> |
5742 |
</t> |
</t> |
5743 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
5744 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
5745 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5746 |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5747 |
|
|
5984 |
<t>FORMAT INSTRUMENTS_DB</t> |
<t>FORMAT INSTRUMENTS_DB</t> |
5985 |
</list> |
</list> |
5986 |
</t> |
</t> |
5987 |
|
|
5988 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5989 |
<t> |
<t> |
5990 |
<list> |
<list> |
6023 |
editor application by sending the following command:</t> |
editor application by sending the following command:</t> |
6024 |
<t> |
<t> |
6025 |
<list> |
<list> |
6026 |
<t>EDIT INSTRUMENT <sampler-channel></t> |
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6027 |
</list> |
</list> |
6028 |
</t> |
</t> |
6029 |
<t>Where <sampler-channel> should be replaced by the |
<t>Where <sampler-channel> should be replaced by the |
6075 |
<t>Examples:</t> |
<t>Examples:</t> |
6076 |
<t> |
<t> |
6077 |
<list> |
<list> |
6078 |
<t>C: "EDIT INSTRUMENT 0"</t> |
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6079 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
6080 |
</list> |
</list> |
6081 |
</t> |
</t> |
6082 |
</section> |
</section> |
6083 |
</section> |
</section> |
|
</section> |
|
6084 |
|
|
6085 |
|
<section title="Managing Files" anchor="file_management"> |
6086 |
|
<t>You can query detailed informations about files located |
6087 |
|
at the same system where the sampler instance is running on. |
6088 |
|
Using this command set allows to retrieve file informations |
6089 |
|
even remotely from another machine.</t> |
6090 |
|
|
6091 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
6092 |
|
<t>The front-end can retrieve the amount of instruments |
6093 |
|
within a given instrument file by sending the |
6094 |
|
following command:</t> |
6095 |
|
<t> |
6096 |
|
<list> |
6097 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
6098 |
|
</list> |
6099 |
|
</t> |
6100 |
|
<t>Where <filename> is the name of the instrument |
6101 |
|
file (encapsulated into apostrophes, supporting escape |
6102 |
|
sequences as described in chapter |
6103 |
|
"<xref target="character_set">Character Set and Escape |
6104 |
|
Sequences</xref>").</t> |
6105 |
|
|
6106 |
|
<t>The sampler will try to ask all sampler engines, |
6107 |
|
whether they support the given file and ask the first |
6108 |
|
engine with a positive answer for the amount of |
6109 |
|
instruments.</t> |
6110 |
|
|
6111 |
|
<t>Possible Answers:</t> |
6112 |
|
<t> |
6113 |
|
<list> |
6114 |
|
<t>On success, the sampler will answer by |
6115 |
|
returning the amount of instruments. |
6116 |
|
</t> |
6117 |
|
<t>"ERR:<error-code>:<error-message>" - |
6118 |
|
<list> |
6119 |
|
<t>if the file could not be handled</t> |
6120 |
|
</list> |
6121 |
|
</t> |
6122 |
|
</list> |
6123 |
|
</t> |
6124 |
|
|
6125 |
|
<t>Examples:</t> |
6126 |
|
<t> |
6127 |
|
<list> |
6128 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6129 |
|
<t>S: "10"</t> |
6130 |
|
</list> |
6131 |
|
</t> |
6132 |
|
</section> |
6133 |
|
|
6134 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
6135 |
|
<t>The front-end can retrieve a list of all instruments |
6136 |
|
within a given instrument file by sending the |
6137 |
|
following command:</t> |
6138 |
|
<t> |
6139 |
|
<list> |
6140 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
6141 |
|
</list> |
6142 |
|
</t> |
6143 |
|
<t>Where <filename> is the name of the instrument |
6144 |
|
file (encapsulated into apostrophes, supporting escape |
6145 |
|
sequences as described in chapter |
6146 |
|
"<xref target="character_set">Character Set and Escape |
6147 |
|
Sequences</xref>").</t> |
6148 |
|
|
6149 |
|
<t>The sampler will try to ask all sampler engines, |
6150 |
|
whether they support the given file and ask the first |
6151 |
|
engine with a positive answer for a list of IDs for the |
6152 |
|
instruments in the given file.</t> |
6153 |
|
|
6154 |
|
<t>Possible Answers:</t> |
6155 |
|
<t> |
6156 |
|
<list> |
6157 |
|
<t>On success, the sampler will answer by |
6158 |
|
returning a comma separated list of |
6159 |
|
instrument IDs. |
6160 |
|
</t> |
6161 |
|
<t>"ERR:<error-code>:<error-message>" - |
6162 |
|
<list> |
6163 |
|
<t>if the file could not be handled</t> |
6164 |
|
</list> |
6165 |
|
</t> |
6166 |
|
</list> |
6167 |
|
</t> |
6168 |
|
|
6169 |
|
<t>Examples:</t> |
6170 |
|
<t> |
6171 |
|
<list> |
6172 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6173 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
6174 |
|
</list> |
6175 |
|
</t> |
6176 |
|
</section> |
6177 |
|
|
6178 |
|
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
6179 |
|
<t>The front-end can retrieve detailed informations |
6180 |
|
about a specific instrument within a given instrument |
6181 |
|
file by sending the following command:</t> |
6182 |
|
<t> |
6183 |
|
<list> |
6184 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
6185 |
|
<instr-id></t> |
6186 |
|
</list> |
6187 |
|
</t> |
6188 |
|
<t>Where <filename> is the name of the instrument |
6189 |
|
file (encapsulated into apostrophes, supporting escape |
6190 |
|
sequences as described in chapter |
6191 |
|
"<xref target="character_set">Character Set and Escape |
6192 |
|
Sequences</xref>") and <instr-id> is the numeric |
6193 |
|
instrument ID as returned by the |
6194 |
|
<xref target="LIST FILE INSTRUMENTS"> |
6195 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
6196 |
|
|
6197 |
|
<t>The sampler will try to ask all sampler engines, |
6198 |
|
whether they support the given file and ask the first |
6199 |
|
engine with a positive answer for informations about the |
6200 |
|
specific instrument in the given file.</t> |
6201 |
|
|
6202 |
|
<t>Possible Answers:</t> |
6203 |
|
<t> |
6204 |
|
<list> |
6205 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6206 |
|
Each answer line begins with the settings category name |
6207 |
|
followed by a colon and then a space character <SP> and finally |
6208 |
|
the info character string to that setting category. At the |
6209 |
|
moment the following categories are defined:</t> |
6210 |
|
|
6211 |
|
<t> |
6212 |
|
<list> |
6213 |
|
<t>NAME - |
6214 |
|
<list> |
6215 |
|
<t>name of the instrument as |
6216 |
|
stored in the instrument file</t> |
6217 |
|
</list> |
6218 |
|
</t> |
6219 |
|
<t>FORMAT_FAMILY - |
6220 |
|
<list> |
6221 |
|
<t>name of the sampler format |
6222 |
|
of the given instrument</t> |
6223 |
|
</list> |
6224 |
|
</t> |
6225 |
|
<t>FORMAT_VERSION - |
6226 |
|
<list> |
6227 |
|
<t>version of the sampler format |
6228 |
|
the instrumen is stored as</t> |
6229 |
|
</list> |
6230 |
|
</t> |
6231 |
|
<t>PRODUCT - |
6232 |
|
<list> |
6233 |
|
<t>official product name of the |
6234 |
|
instrument as stored in the file |
6235 |
|
</t> |
6236 |
|
</list> |
6237 |
|
</t> |
6238 |
|
<t>ARTISTS - |
6239 |
|
<list> |
6240 |
|
<t>artists / sample library |
6241 |
|
vendor of the instrument</t> |
6242 |
|
</list> |
6243 |
|
</t> |
6244 |
|
</list> |
6245 |
|
</t> |
6246 |
|
</list> |
6247 |
|
</t> |
6248 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6249 |
|
|
6250 |
|
<t>Example:</t> |
6251 |
|
<t> |
6252 |
|
<list> |
6253 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
6254 |
|
<t>S: "NAME: Lunatic Loops"</t> |
6255 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6256 |
|
<t> "FORMAT_VERSION: 3"</t> |
6257 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
6258 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
6259 |
|
<t> "."</t> |
6260 |
|
</list> |
6261 |
|
</t> |
6262 |
|
</section> |
6263 |
|
</section> |
6264 |
|
</section> |
6265 |
|
|
6266 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
6267 |
<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"/> |
6391 |
</t> |
</t> |
6392 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6393 |
</t> |
</t> |
6394 |
|
<t>/ CHANNEL_MIDI |
6395 |
|
</t> |
6396 |
|
<t>/ DEVICE_MIDI |
6397 |
|
</t> |
6398 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6399 |
</t> |
</t> |
6400 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6427 |
</t> |
</t> |
6428 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6429 |
</t> |
</t> |
6430 |
|
<t>/ TOTAL_STREAM_COUNT |
6431 |
|
</t> |
6432 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6433 |
</t> |
</t> |
6434 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6447 |
</t> |
</t> |
6448 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6449 |
</t> |
</t> |
6450 |
|
<t>/ CHANNEL_MIDI |
6451 |
|
</t> |
6452 |
|
<t>/ DEVICE_MIDI |
6453 |
|
</t> |
6454 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6455 |
</t> |
</t> |
6456 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6483 |
</t> |
</t> |
6484 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6485 |
</t> |
</t> |
6486 |
|
<t>/ TOTAL_STREAM_COUNT |
6487 |
|
</t> |
6488 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6489 |
</t> |
</t> |
6490 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6575 |
</t> |
</t> |
6576 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
6577 |
</t> |
</t> |
6578 |
|
<t>/ TOTAL_STREAM_COUNT |
6579 |
|
</t> |
6580 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6581 |
</t> |
</t> |
6582 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
6611 |
</t> |
</t> |
6612 |
<t>/ VOLUME |
<t>/ VOLUME |
6613 |
</t> |
</t> |
6614 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
6615 |
|
</t> |
6616 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6617 |
|
</t> |
6618 |
</list> |
</list> |
6619 |
</t> |
</t> |
6620 |
<t>set_instruction = |
<t>set_instruction = |
6765 |
</t> |
</t> |
6766 |
<t>edit_instruction = |
<t>edit_instruction = |
6767 |
<list> |
<list> |
6768 |
<t>INSTRUMENT SP sampler_channel |
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
6769 |
</t> |
</t> |
6770 |
</list> |
</list> |
6771 |
</t> |
</t> |
6829 |
</t> |
</t> |
6830 |
<t>/ DB_INSTRUMENTS SP db_path |
<t>/ DB_INSTRUMENTS SP db_path |
6831 |
</t> |
</t> |
6832 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
6833 |
|
</t> |
6834 |
</list> |
</list> |
6835 |
</t> |
</t> |
6836 |
<t>load_instr_args = |
<t>load_instr_args = |
7063 |
in the old versions a single backslash was sufficient.</t> |
in the old versions a single backslash was sufficient.</t> |
7064 |
|
|
7065 |
<t>The following LSCP commands support escape sequences as part |
<t>The following LSCP commands support escape sequences as part |
7066 |
of their filename / path based arguments: |
of their filename / path based arguments and / or may contain |
7067 |
|
a filename / path with escape sequences in their response: |
7068 |
<list> |
<list> |
7069 |
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
7070 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
7071 |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
7072 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
7073 |
<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> |
7074 |
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
7075 |
<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> |
7090 |
<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> |
7091 |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
7092 |
<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> |
7093 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
7094 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
7095 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
7096 |
</list> |
</list> |
7097 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
7098 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
7103 |
</t> |
</t> |
7104 |
|
|
7105 |
<t> |
<t> |
7106 |
|
Note for Windows: file path arguments in LSCP are expected |
7107 |
|
to use forward slashes as directory node separator similar |
7108 |
|
to Unix based operating systems. In contrast to Unix however |
7109 |
|
a Windows typical drive character is expected to be |
7110 |
|
prefixed to the path. That is an original Windows file path |
7111 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
7112 |
|
"D:/Sounds/My.gig". |
7113 |
|
</t> |
7114 |
|
|
7115 |
|
<t> |
7116 |
The following LSCP commands even support escape sequences as |
The following LSCP commands even support escape sequences as |
7117 |
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, |
7118 |
description): |
description) and / or may contain escape sequences in at least one of |
7119 |
|
their text-based fields in their response: |
7120 |
<list> |
<list> |
7121 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
7122 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
7123 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
7124 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
7125 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
7126 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
7127 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
7128 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
7129 |
<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> |
7130 |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
7131 |
<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> |
7132 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
7133 |
<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> |
7134 |
<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> |
7135 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7136 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
7137 |
<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> |
7138 |
<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> |
7139 |
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
7140 |
</list> |
</list> |
7141 |
Please note that these lists are manually maintained. If you |
Please note that these lists are manually maintained. If you |
7142 |
find a command that also supports escape sequences we forgot to |
find a command that also supports escape sequences we forgot to |
7246 |
of sampler channels.</t> |
of sampler channels.</t> |
7247 |
</section> |
</section> |
7248 |
|
|
7249 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
7250 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
7251 |
|
back-end side, by issuing the following command:</t> |
7252 |
|
<t> |
7253 |
|
<list> |
7254 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
7255 |
|
</list> |
7256 |
|
</t> |
7257 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7258 |
|
<t> |
7259 |
|
<list> |
7260 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
7261 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
7262 |
|
</list> |
7263 |
|
</t> |
7264 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
7265 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7266 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7267 |
|
</t> |
7268 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7269 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7270 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7271 |
|
thread unaffected by this feature.</t> |
7272 |
|
</section> |
7273 |
|
|
7274 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
7275 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
7276 |
|
<t> |
7277 |
|
<list> |
7278 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
7279 |
|
</list> |
7280 |
|
</t> |
7281 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7282 |
|
<t> |
7283 |
|
<list> |
7284 |
|
<t>"NOTIFY:CHANNEL_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
7285 |
|
<t>"NOTIFY:CHANNEL_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
7286 |
|
</list> |
7287 |
|
</t> |
7288 |
|
<t>where <device-id> <port-id> will be replaced |
7289 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
7290 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7291 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7292 |
|
</t> |
7293 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7294 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7295 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7296 |
|
thread unaffected by this feature.</t> |
7297 |
|
</section> |
7298 |
|
|
7299 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
7300 |
<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 |
7301 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7433 |
all currently active voices.</t> |
all currently active voices.</t> |
7434 |
</section> |
</section> |
7435 |
|
|
7436 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
7437 |
|
<t>Client may want to be notified when the total number of disk streams on the |
7438 |
|
back-end changes by issuing the following command:</t> |
7439 |
|
<t> |
7440 |
|
<list> |
7441 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
7442 |
|
</list> |
7443 |
|
</t> |
7444 |
|
<t>Server will start sending the following notification messages:</t> |
7445 |
|
<t> |
7446 |
|
<list> |
7447 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
7448 |
|
</list> |
7449 |
|
</t> |
7450 |
|
<t>where <streams> will be replaced by the new number of |
7451 |
|
all currently active disk streams.</t> |
7452 |
|
</section> |
7453 |
|
|
7454 |
<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"> |
7455 |
<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 |
7456 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |