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.2cvs"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol (draft)</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="May" year="2007"/> |
<date month="June" year="2007"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
61 |
(front-end) and server (LinuxSampler) respectively. Lines in |
(front-end) and server (LinuxSampler) respectively. Lines in |
62 |
examples must be interpreted as every line being CRLF |
examples must be interpreted as every line being CRLF |
63 |
terminated (carriage return character followed by line feed |
terminated (carriage return character followed by line feed |
64 |
character as defined in the ASCII standard), thus the following |
character as defined in the ASCII standard <xref target="RFC20"/>), |
65 |
example:</t> |
thus the following example:</t> |
66 |
|
|
67 |
<t> |
<t> |
68 |
<list> |
<list> |
2113 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
2114 |
Each sampler channel can only have one instrument.</t> |
Each sampler channel can only have one instrument.</t> |
2115 |
|
|
2116 |
|
<t>Notice: since LSCP 1.2 the <filename> argument supports |
2117 |
|
escape characters for special characters (see chapter |
2118 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>" |
2119 |
|
for details) and accordingly backslash characters in the filename |
2120 |
|
MUST now be escaped as well!</t> |
2121 |
|
|
2122 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
2123 |
is that the regular command returns OK only after the instrument has been |
is that the regular command returns OK only after the instrument has been |
2124 |
fully loaded and the channel is ready to be used while NON_MODAL version |
fully loaded and the channel is ready to be used while NON_MODAL version |
4331 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
4332 |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
4333 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
4334 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
4335 |
|
supporting escape sequences as described in chapter |
4336 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"), |
4337 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
4338 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
4339 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
5210 |
to the instruments database by sending the following command:</t> |
to the instruments database by sending the following command:</t> |
5211 |
<t> |
<t> |
5212 |
<list> |
<list> |
5213 |
<t>ADD DB_INSTRUMENTS [<mode>] <db_dir> <file_path> [<instr_index>]</t> |
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>]</t> |
5214 |
</list> |
</list> |
5215 |
</t> |
</t> |
5216 |
<t>Where <db_dir> is the absolute path name of a directory |
<t>Where <db_dir> is the absolute path name of a directory |
5228 |
scanning will be done and has exactly the following possibilities:</t> |
scanning will be done and has exactly the following possibilities:</t> |
5229 |
<t> |
<t> |
5230 |
<list> |
<list> |
5231 |
|
<t>"RECURSIVE" - |
5232 |
|
<list> |
5233 |
|
<t>All instruments will be processed, including those |
5234 |
|
in the subdirectories, and the respective subdirectory |
5235 |
|
tree structure will be recreated in the instruments |
5236 |
|
database</t> |
5237 |
|
</list> |
5238 |
|
</t> |
5239 |
<t>"NON_RECURSIVE" - |
<t>"NON_RECURSIVE" - |
5240 |
<list> |
<list> |
5241 |
<t>Only the instruments in the specified directory |
<t>Only the instruments in the specified directory |
5252 |
the specified database directory.</t> |
the specified database directory.</t> |
5253 |
</list> |
</list> |
5254 |
</t> |
</t> |
|
<t>not supplied - |
|
|
<list> |
|
|
<t>The subdirectory tree structure will be recreated |
|
|
in the instruments database and all instruments will be |
|
|
processed and added to the respective subdirectory |
|
|
in the instruments database.</t> |
|
|
</list> |
|
|
</t> |
|
5255 |
</list> |
</list> |
5256 |
</t> |
</t> |
5257 |
|
|
5258 |
|
<t>The difference between regular and NON_MODAL versions of the command |
5259 |
|
is that the regular command returns when the scanning is finished |
5260 |
|
while NON_MODAL version returns immediately and a background process is launched. |
5261 |
|
The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5262 |
|
command can be used to monitor the scanning progress.</t> |
5263 |
|
|
5264 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5265 |
<t> |
<t> |
5266 |
<list> |
<list> |
5267 |
<t>"OK" - |
<t>"OK" - |
5268 |
<list> |
<list> |
5269 |
<t>on success</t> |
<t>on success when NON_MODAL is not supplied</t> |
5270 |
|
</list> |
5271 |
|
</t> |
5272 |
|
<t>"OK[<job-id>]" - |
5273 |
|
<list> |
5274 |
|
<t>on success when NON_MODAL is supplied, where <job-id> |
5275 |
|
is a numerical ID used to obtain status information about the job progress. |
5276 |
|
See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5277 |
|
</t> |
5278 |
</list> |
</list> |
5279 |
</t> |
</t> |
5280 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
5699 |
|
|
5700 |
<t>SIZE=[<min>]..[<max>] |
<t>SIZE=[<min>]..[<max>] |
5701 |
<list> |
<list> |
5702 |
<t>Restricts the search to instruments, which |
<t>Restricts the search to instruments, which |
5703 |
size is in the specified range. If <min> is omitted, |
size is in the specified range. If <min> is omitted, |
5704 |
the search results are restricted to instruments with size less then |
the search results are restricted to instruments with size less then |
5705 |
or equal to <max>. If <max> is omitted, the |
or equal to <max>. If <max> is omitted, the |
5762 |
|
|
5763 |
<t>IS_DRUM=true | false |
<t>IS_DRUM=true | false |
5764 |
<list> |
<list> |
5765 |
<t>Either true or false. Restricts the search to |
<t>Either true or false. Restricts the search to |
5766 |
drum kits or chromatic instruments.</t> |
drum kits or chromatic instruments.</t> |
5767 |
</list> |
</list> |
5768 |
</t> |
</t> |
5806 |
</t> |
</t> |
5807 |
</section> |
</section> |
5808 |
|
|
5809 |
|
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO"> |
5810 |
|
<t>The front-end can ask for the current status of a |
5811 |
|
particular database instruments job by sending the following command:</t> |
5812 |
|
<t> |
5813 |
|
<list> |
5814 |
|
<t>GET DB_INSTRUMENTS_JOB INFO <job-id></t> |
5815 |
|
</list> |
5816 |
|
</t> |
5817 |
|
<t>Where <job-id> should be replaced by the numerical ID |
5818 |
|
of the job the front-end is interested in.</t> |
5819 |
|
|
5820 |
|
<t>Possible Answers:</t> |
5821 |
|
<t> |
5822 |
|
<list> |
5823 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
5824 |
|
Each answer line begins with the settings category name |
5825 |
|
followed by a colon and then a space character <SP> and finally |
5826 |
|
the info character string to that setting category. At the |
5827 |
|
moment the following categories are defined:</t> |
5828 |
|
|
5829 |
|
<t> |
5830 |
|
<list> |
5831 |
|
<t>FILES_TOTAL - |
5832 |
|
<list> |
5833 |
|
<t>The total number of files scheduled for scanning</t> |
5834 |
|
</list> |
5835 |
|
</t> |
5836 |
|
<t>FILES_SCANNED - |
5837 |
|
<list> |
5838 |
|
<t>The current number of scanned files</t> |
5839 |
|
</list> |
5840 |
|
</t> |
5841 |
|
<t>SCANNING - |
5842 |
|
<list> |
5843 |
|
<t>The absolute path name of the file which is currently |
5844 |
|
being scanned</t> |
5845 |
|
</list> |
5846 |
|
</t> |
5847 |
|
<t>STATUS - |
5848 |
|
<list> |
5849 |
|
<t>An integer value between 0 and 100 indicating the |
5850 |
|
scanning progress percentage of the file which is |
5851 |
|
currently being scanned</t> |
5852 |
|
</list> |
5853 |
|
</t> |
5854 |
|
</list> |
5855 |
|
</t> |
5856 |
|
</list> |
5857 |
|
</t> |
5858 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
5859 |
|
|
5860 |
|
<t>Example:</t> |
5861 |
|
<t> |
5862 |
|
<list> |
5863 |
|
<t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t> |
5864 |
|
<t>S: "FILES_TOTAL: 12"</t> |
5865 |
|
<t> "FILES_SCANNED: 7"</t> |
5866 |
|
<t> "SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t> |
5867 |
|
<t> "STATUS: 42"</t> |
5868 |
|
<t> "."</t> |
5869 |
|
</list> |
5870 |
|
</t> |
5871 |
|
</section> |
5872 |
|
|
5873 |
</section> |
</section> |
5874 |
|
|
5875 |
</section> |
</section> |
5957 |
</t> |
</t> |
5958 |
<t>/ COPY SP copy_instruction |
<t>/ COPY SP copy_instruction |
5959 |
</t> |
</t> |
5960 |
|
<t>/ EDIT SP edit_instruction |
5961 |
|
</t> |
5962 |
<t>/ RESET |
<t>/ RESET |
5963 |
</t> |
</t> |
5964 |
<t>/ QUIT |
<t>/ QUIT |
5971 |
</t> |
</t> |
5972 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
5973 |
</t> |
</t> |
5974 |
<t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname |
5975 |
|
</t> |
5976 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname |
5977 |
</t> |
</t> |
5978 |
<t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname |
5979 |
|
</t> |
5980 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index |
5981 |
</t> |
</t> |
5982 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP pathname SP pathname |
5983 |
</t> |
</t> |
6029 |
</t> |
</t> |
6030 |
<t>/ DB_INSTRUMENT_INFO |
<t>/ DB_INSTRUMENT_INFO |
6031 |
</t> |
</t> |
6032 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
6033 |
|
</t> |
6034 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6035 |
</t> |
</t> |
6036 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6079 |
</t> |
</t> |
6080 |
<t>/ DB_INSTRUMENT_INFO |
<t>/ DB_INSTRUMENT_INFO |
6081 |
</t> |
</t> |
6082 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
6083 |
|
</t> |
6084 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6085 |
</t> |
</t> |
6086 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6203 |
</t> |
</t> |
6204 |
<t>/ DB_INSTRUMENT SP INFO SP pathname |
<t>/ DB_INSTRUMENT SP INFO SP pathname |
6205 |
</t> |
</t> |
6206 |
|
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
6207 |
|
</t> |
6208 |
<t>/ VOLUME |
<t>/ VOLUME |
6209 |
</t> |
</t> |
6210 |
</list> |
</list> |
6353 |
</t> |
</t> |
6354 |
</list> |
</list> |
6355 |
</t> |
</t> |
6356 |
|
<t>edit_instruction = |
6357 |
|
<list> |
6358 |
|
<t>INSTRUMENT SP sampler_channel |
6359 |
|
</t> |
6360 |
|
</list> |
6361 |
|
</t> |
6362 |
<t>modal_arg = |
<t>modal_arg = |
6363 |
<list> |
<list> |
6364 |
<t>/* epsilon (empty argument) */ |
<t>/* epsilon (empty argument) */ |
6547 |
</t> |
</t> |
6548 |
<t>filename = |
<t>filename = |
6549 |
<list> |
<list> |
6550 |
<t>stringval |
<t>stringval_escaped |
6551 |
</t> |
</t> |
6552 |
</list> |
</list> |
6553 |
</t> |
</t> |
6605 |
</t> |
</t> |
6606 |
</list> |
</list> |
6607 |
</t> |
</t> |
6608 |
|
<t>scan_mode = |
6609 |
|
<list> |
6610 |
|
<t>RECURSIVE |
6611 |
|
</t> |
6612 |
|
<t>/ NON_RECURSIVE |
6613 |
|
</t> |
6614 |
|
<t>/ FLAT |
6615 |
|
</t> |
6616 |
|
</list> |
6617 |
|
</t> |
6618 |
|
|
6619 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
6620 |
|
|
6621 |
|
<section title="Character Set and Escape Sequences" anchor="character_set"> |
6622 |
|
<t>Older versions of this protocol up to and including v1.1 only |
6623 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
6624 |
|
<xref target="RFC20"/>, all younger versions of this protocol |
6625 |
|
however support the Extended ASCII character set (ASCII code |
6626 |
|
0 - 255). The same group of younger protocols also support |
6627 |
|
escape sequences, but only for certain, explicitly declared |
6628 |
|
parts of the protocol. The supported escape sequences are |
6629 |
|
defined as follows:</t> |
6630 |
|
<texttable> |
6631 |
|
<ttcol>ASCII Character Sequence</ttcol> |
6632 |
|
<ttcol>Translated into (Name)</ttcol> |
6633 |
|
<c>\n</c> <c>new line</c> |
6634 |
|
<c>\r</c> <c>carriage return</c> |
6635 |
|
<c>\f</c> <c>form feed</c> |
6636 |
|
<c>\t</c> <c>horizontal tab</c> |
6637 |
|
<c>\v</c> <c>vertical tab</c> |
6638 |
|
<c>\'</c> <c>apostrophe</c> |
6639 |
|
<c>\"</c> <c>quotation mark</c> |
6640 |
|
<c>\\</c> <c>backslash</c> |
6641 |
|
<c>\OOO</c> <c>three digit octal ASCII code of the character</c> |
6642 |
|
<c>\xHH</c> <c>two digit hex ASCII code of the character</c> |
6643 |
|
</texttable> |
6644 |
|
<t>Notice: due to the transition of certain parts of the |
6645 |
|
protocol which now support escape sequences, a slight backward |
6646 |
|
incompatibility to protocols version v1.1 and younger has been |
6647 |
|
introduced. The only difference is that in parts of the protocol |
6648 |
|
where escape characters are now supported, a backslash characters |
6649 |
|
MUST be escaped as well (that is as double backslash), whereas |
6650 |
|
in the old versions a single backslash was sufficient.</t> |
6651 |
|
</section> |
6652 |
</section> |
</section> |
6653 |
|
|
6654 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
6834 |
</section> |
</section> |
6835 |
|
|
6836 |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
6837 |
<t>Client may want to be notified when the number of effect sends on |
<t>Client may want to be notified when the number of effect sends on |
6838 |
a particular sampler channel is changed by issuing the following command:</t> |
a particular sampler channel is changed by issuing the following command:</t> |
6839 |
<t> |
<t> |
6840 |
<list> |
<list> |
7094 |
the new name of the instrument, encapsulated into apostrophes.</t> |
the new name of the instrument, encapsulated into apostrophes.</t> |
7095 |
</section> |
</section> |
7096 |
|
|
7097 |
|
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"> |
7098 |
|
<t>Client may want to be notified when the status of particular database |
7099 |
|
instruments job is changed by issuing the following command:</t> |
7100 |
|
<t> |
7101 |
|
<list> |
7102 |
|
<t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t> |
7103 |
|
</list> |
7104 |
|
</t> |
7105 |
|
<t>Server will start sending the following notification messages:</t> |
7106 |
|
<t> |
7107 |
|
<list> |
7108 |
|
<t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"</t> |
7109 |
|
</list> |
7110 |
|
</t> |
7111 |
|
<t>where <job-id> will be replaced by the numerical ID of the job, |
7112 |
|
which status is changed. The front-end will have to send the respective |
7113 |
|
command to actually get the status info. Because these messages |
7114 |
|
will be triggered by LSCP commands issued by other clients rather than real |
7115 |
|
time events happening on the server, it is believed that an empty notification |
7116 |
|
message is sufficient here.</t> |
7117 |
|
</section> |
7118 |
|
|
7119 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
7120 |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
7121 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
7194 |
</front> |
</front> |
7195 |
<seriesInfo name="RFC" value="2234" /> |
<seriesInfo name="RFC" value="2234" /> |
7196 |
</reference> |
</reference> |
7197 |
|
<reference anchor="RFC20"> |
7198 |
|
<front> |
7199 |
|
<title>ASCII format for Network Interchange</title> |
7200 |
|
<author> |
7201 |
|
<organization>UCLA</organization> |
7202 |
|
</author> |
7203 |
|
<date year="1969"></date> |
7204 |
|
</front> |
7205 |
|
<seriesInfo name="RFC" value="20" /> |
7206 |
|
</reference> |
7207 |
</references> |
</references> |
7208 |
</back> |
</back> |
7209 |
|
|