16 |
to an annoying "missing Normative/Informative References" error message --> |
to an annoying "missing Normative/Informative References" error message --> |
17 |
<?rfc strict="no" ?> |
<?rfc strict="no" ?> |
18 |
|
|
19 |
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.3"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
35 |
</address> |
</address> |
36 |
</author> |
</author> |
37 |
<date month="October" year="2007"/> |
<date month="December" year="2007"/> |
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> |
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> |
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"/> |
7082 |
<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> |
7083 |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
7084 |
<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> |
7085 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
7086 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
7087 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
7088 |
</list> |
</list> |
7089 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
7090 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
7095 |
</t> |
</t> |
7096 |
|
|
7097 |
<t> |
<t> |
7098 |
|
Note for Windows: file path arguments in LSCP are expected |
7099 |
|
to use forward slashes as directory node separator similar |
7100 |
|
to Unix based operating systems. In contrast to Unix however |
7101 |
|
a Windows typical drive character is expected to be |
7102 |
|
prefixed to the path. That is an original Windows file path |
7103 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
7104 |
|
"D:/Sounds/My.gig". |
7105 |
|
</t> |
7106 |
|
|
7107 |
|
<t> |
7108 |
The following LSCP commands even support escape sequences as |
The following LSCP commands even support escape sequences as |
7109 |
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, |
7110 |
description) and / or may contain escape sequences in at least one of |
description) and / or may contain escape sequences in at least one of |