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="October" 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> |
2061 |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
2062 |
command, <port> by the MIDI port number, <key> by the name of |
command, <port> by the MIDI port number, <key> by the name of |
2063 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
2064 |
parameter.</t> |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
2065 |
|
for specifying no value for parameters allowing a list of values.</t> |
2066 |
|
|
2067 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2068 |
<t> |
<t> |
2089 |
<t>Example:</t> |
<t>Example:</t> |
2090 |
<t> |
<t> |
2091 |
<list> |
<list> |
2092 |
<t></t> |
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t> |
2093 |
|
<t>S: "OK"</t> |
2094 |
|
</list> |
2095 |
|
</t> |
2096 |
|
<t> |
2097 |
|
<list> |
2098 |
|
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t> |
2099 |
|
<t>S: "OK"</t> |
2100 |
</list> |
</list> |
2101 |
</t> |
</t> |
2102 |
</section> |
</section> |
2121 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
2122 |
Each sampler channel can only have one instrument.</t> |
Each sampler channel can only have one instrument.</t> |
2123 |
|
|
2124 |
|
<t>Notice: since LSCP 1.2 the <filename> argument supports |
2125 |
|
escape characters for special characters (see chapter |
2126 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>" |
2127 |
|
for details) and accordingly backslash characters in the filename |
2128 |
|
MUST now be escaped as well!</t> |
2129 |
|
|
2130 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
2131 |
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 |
2132 |
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 |
2443 |
<list> |
<list> |
2444 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
2445 |
<list> |
<list> |
2446 |
<t>arbitrary description text about the engine</t> |
<t>arbitrary description text about the engine |
2447 |
|
(note that the character string may contain |
2448 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2449 |
</list> |
</list> |
2450 |
</t> |
</t> |
2451 |
<t>VERSION - |
<t>VERSION - |
2529 |
<list> |
<list> |
2530 |
<t>the file name of the loaded instrument, "NONE" if |
<t>the file name of the loaded instrument, "NONE" if |
2531 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
2532 |
channel</t> |
channel (note: since LSCP 1.2 this path may contain |
2533 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2534 |
</list> |
</list> |
2535 |
</t> |
</t> |
2536 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
2540 |
</t> |
</t> |
2541 |
<t>INSTRUMENT_NAME - |
<t>INSTRUMENT_NAME - |
2542 |
<list> |
<list> |
2543 |
<t>the instrument name of the loaded instrument</t> |
<t>the instrument name of the loaded instrument |
2544 |
|
(note: since LSCP 1.2 this character string may contain |
2545 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2546 |
</list> |
</list> |
2547 |
</t> |
</t> |
2548 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
3260 |
sampler channel on which the effect send should be created on, <midi-ctrl> |
sampler channel on which the effect send should be created on, <midi-ctrl> |
3261 |
is a number between 0..127 defining the MIDI controller which can alter the |
is a number between 0..127 defining the MIDI controller which can alter the |
3262 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
3263 |
for the effect send entity. The name does not have to be unique.</t> |
for the effect send entity. The name does not have to be unique, but MUST be |
3264 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
3265 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>".</t> |
3266 |
|
|
3267 |
<t>By default, that is as initial routing, the effect send's audio channels |
<t>By default, that is as initial routing, the effect send's audio channels |
3268 |
are automatically routed to the last audio channels of the sampler channel's |
are automatically routed to the last audio channels of the sampler channel's |
3452 |
<list> |
<list> |
3453 |
<t>NAME - |
<t>NAME - |
3454 |
<list> |
<list> |
3455 |
<t>name of the effect send entity</t> |
<t>name of the effect send entity |
3456 |
|
(note that this character string may contain |
3457 |
|
<xref target="character_set">escape sequences</xref>)</t> |
3458 |
</list> |
</list> |
3459 |
</t> |
</t> |
3460 |
<t>MIDI_CONTROLLER - |
<t>MIDI_CONTROLLER - |
3517 |
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3518 |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3519 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
3520 |
does not have to be unique.</t> |
does not have to be unique (name MUST be encapsulated into apostrophes |
3521 |
|
and supports escape sequences as described in chapter |
3522 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
3523 |
|
</t> |
3524 |
|
|
3525 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3526 |
<t> |
<t> |
3924 |
</t> |
</t> |
3925 |
</section> |
</section> |
3926 |
|
|
3927 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
3928 |
|
<t>The front-end can ask for the current number of active disk streams on |
3929 |
|
the sampler by sending the following command:</t> |
3930 |
|
<t> |
3931 |
|
<list> |
3932 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
3933 |
|
</list> |
3934 |
|
</t> |
3935 |
|
|
3936 |
|
<t>Possible Answers:</t> |
3937 |
|
<t> |
3938 |
|
<list> |
3939 |
|
<t>LinuxSampler will answer by returning the number of all active |
3940 |
|
disk streams on the sampler.</t> |
3941 |
|
</list> |
3942 |
|
</t> |
3943 |
|
</section> |
3944 |
|
|
3945 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
3946 |
<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> |
3947 |
<t> |
<t> |
3989 |
<list> |
<list> |
3990 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
3991 |
<list> |
<list> |
3992 |
<t>arbitrary textual description about the sampler</t> |
<t>arbitrary textual description about the sampler |
3993 |
|
(note that the character string may contain |
3994 |
|
<xref target="character_set">escape sequences</xref>)</t> |
3995 |
</list> |
</list> |
3996 |
</t> |
</t> |
3997 |
<t>VERSION - |
<t>VERSION - |
4107 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
4108 |
reflected by the current MIDI instrument map.</t> |
reflected by the current MIDI instrument map.</t> |
4109 |
|
|
4110 |
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP"> |
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP"> |
4111 |
<t>The front-end can add a new MIDI instrument map by sending |
<t>The front-end can add a new MIDI instrument map by sending |
4112 |
the following command:</t> |
the following command:</t> |
4113 |
<t> |
<t> |
4117 |
</t> |
</t> |
4118 |
<t>Where <name> is an optional argument allowing to |
<t>Where <name> is an optional argument allowing to |
4119 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
4120 |
names do not have to be unique.</t> |
names do not have to be unique, but MUST be encapsulated |
4121 |
|
into apostrophes and support escape sequences as described |
4122 |
|
in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>". |
4123 |
|
</t> |
4124 |
|
|
4125 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4126 |
<t> |
<t> |
4291 |
<t>NAME - |
<t>NAME - |
4292 |
<list> |
<list> |
4293 |
<t>custom name of the given map, |
<t>custom name of the given map, |
4294 |
which does not have to be unique</t> |
which does not have to be unique |
4295 |
|
(note that this character string may contain |
4296 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4297 |
</list> |
</list> |
4298 |
</t> |
</t> |
4299 |
<t>DEFAULT - |
<t>DEFAULT - |
4329 |
</t> |
</t> |
4330 |
<t>Where <map> is the numerical ID of the map and |
<t>Where <map> is the numerical ID of the map and |
4331 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
4332 |
have to be unique.</t> |
have to be unique (name MUST be encapsulated into apostrophes |
4333 |
|
and supports escape sequences as described in chapter |
4334 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
4335 |
|
</t> |
4336 |
|
|
4337 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4338 |
<t> |
<t> |
4379 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
4380 |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
4381 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
4382 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
4383 |
|
supporting escape sequences as described in chapter |
4384 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"), |
4385 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
4386 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
4387 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
4463 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
4464 |
mode by i.e. sending |
mode by i.e. sending |
4465 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4466 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
4467 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
4468 |
entry, useful for frontends for displaying an appropriate name for |
"<xref target="character_set">Character Set and Escape Sequences</xref>") for the |
4469 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
4470 |
mapped instruments (using |
mapped instruments (using |
4471 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
4472 |
</t> |
</t> |
4690 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
4691 |
changed with the |
changed with the |
4692 |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
4693 |
command and does not have to be unique.</t> |
command and does not have to be unique. |
4694 |
|
(note that this character string may contain |
4695 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4696 |
</list> |
</list> |
4697 |
</t> |
</t> |
4698 |
<t>"ENGINE_NAME" - |
<t>"ENGINE_NAME" - |
4703 |
</t> |
</t> |
4704 |
<t>"INSTRUMENT_FILE" - |
<t>"INSTRUMENT_FILE" - |
4705 |
<list> |
<list> |
4706 |
<t>File name of the instrument.</t> |
<t>File name of the instrument |
4707 |
|
(note that this path may contain |
4708 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4709 |
</list> |
</list> |
4710 |
</t> |
</t> |
4711 |
<t>"INSTRUMENT_NR" - |
<t>"INSTRUMENT_NR" - |
4717 |
<list> |
<list> |
4718 |
<t>Name of the loaded instrument as reflected by its file. |
<t>Name of the loaded instrument as reflected by its file. |
4719 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
4720 |
cannot be changed.</t> |
cannot be changed (note that this character string may contain |
4721 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4722 |
</list> |
</list> |
4723 |
</t> |
</t> |
4724 |
<t>"LOAD_MODE" - |
<t>"LOAD_MODE" - |
4806 |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
4807 |
<t>The following commands describe how to use and manage |
<t>The following commands describe how to use and manage |
4808 |
the instruments database.</t> |
the instruments database.</t> |
4809 |
|
<t>Notice:</t> |
4810 |
|
<t> |
4811 |
|
<list> |
4812 |
|
<t>All command arguments representing a path or |
4813 |
|
instrument/directory name support escape sequences as described in chapter |
4814 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>". |
4815 |
|
</t> |
4816 |
|
<t>All occurrences of a forward slash in instrument and directory |
4817 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
4818 |
|
</t> |
4819 |
|
</list> |
4820 |
|
</t> |
4821 |
|
|
4822 |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
4823 |
<t>The front-end can add a new instrument directory to the |
<t>The front-end can add a new instrument directory to the |
4995 |
<list> |
<list> |
4996 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
4997 |
<list> |
<list> |
4998 |
<t>A brief description of the directory content</t> |
<t>A brief description of the directory content. |
4999 |
|
Note that the character string may contain |
5000 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5001 |
</list> |
</list> |
5002 |
</t> |
</t> |
5003 |
<t>CREATED - |
<t>CREATED - |
5161 |
</list> |
</list> |
5162 |
</t> |
</t> |
5163 |
<t>Where <dir> is the absolute path name of the directory and |
<t>Where <dir> is the absolute path name of the directory and |
5164 |
<desc> is the new description for the directory.</t> |
<desc> is the new description for the directory |
5165 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5166 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5167 |
|
|
5168 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5169 |
<t> |
<t> |
5208 |
<t>NAME='<search-string>' |
<t>NAME='<search-string>' |
5209 |
<list> |
<list> |
5210 |
<t>Restricts the search to directories, which names |
<t>Restricts the search to directories, which names |
5211 |
satisfy the supplied search string.</t> |
satisfy the supplied search string (encapsulated into apostrophes, |
5212 |
|
supporting escape sequences as described in chapter |
5213 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5214 |
</list> |
</list> |
5215 |
</t> |
</t> |
5216 |
|
|
5241 |
<t>DESCRIPTION='<search-string>' |
<t>DESCRIPTION='<search-string>' |
5242 |
<list> |
<list> |
5243 |
<t>Restricts the search to directories with description |
<t>Restricts the search to directories with description |
5244 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string |
5245 |
|
(encapsulated into apostrophes, supporting escape |
5246 |
|
sequences as described in chapter |
5247 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5248 |
</list> |
</list> |
5249 |
</t> |
</t> |
5250 |
</t> |
</t> |
5285 |
to the instruments database by sending the following command:</t> |
to the instruments database by sending the following command:</t> |
5286 |
<t> |
<t> |
5287 |
<list> |
<list> |
5288 |
<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> |
5289 |
</list> |
</list> |
5290 |
</t> |
</t> |
5291 |
<t>Where <db_dir> is the absolute path name of a directory |
<t>Where <db_dir> is the absolute path name of a directory |
5303 |
scanning will be done and has exactly the following possibilities:</t> |
scanning will be done and has exactly the following possibilities:</t> |
5304 |
<t> |
<t> |
5305 |
<list> |
<list> |
5306 |
|
<t>"RECURSIVE" - |
5307 |
|
<list> |
5308 |
|
<t>All instruments will be processed, including those |
5309 |
|
in the subdirectories, and the respective subdirectory |
5310 |
|
tree structure will be recreated in the instruments |
5311 |
|
database</t> |
5312 |
|
</list> |
5313 |
|
</t> |
5314 |
<t>"NON_RECURSIVE" - |
<t>"NON_RECURSIVE" - |
5315 |
<list> |
<list> |
5316 |
<t>Only the instruments in the specified directory |
<t>Only the instruments in the specified directory |
5327 |
the specified database directory.</t> |
the specified database directory.</t> |
5328 |
</list> |
</list> |
5329 |
</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> |
|
5330 |
</list> |
</list> |
5331 |
</t> |
</t> |
5332 |
|
|
5333 |
|
<t>The difference between regular and NON_MODAL versions of the command |
5334 |
|
is that the regular command returns when the scanning is finished |
5335 |
|
while NON_MODAL version returns immediately and a background process is launched. |
5336 |
|
The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5337 |
|
command can be used to monitor the scanning progress.</t> |
5338 |
|
|
5339 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5340 |
<t> |
<t> |
5341 |
<list> |
<list> |
5342 |
<t>"OK" - |
<t>"OK" - |
5343 |
<list> |
<list> |
5344 |
<t>on success</t> |
<t>on success when NON_MODAL is not supplied</t> |
5345 |
|
</list> |
5346 |
|
</t> |
5347 |
|
<t>"OK[<job-id>]" - |
5348 |
|
<list> |
5349 |
|
<t>on success when NON_MODAL is supplied, where <job-id> |
5350 |
|
is a numerical ID used to obtain status information about the job progress. |
5351 |
|
See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5352 |
|
</t> |
5353 |
</list> |
</list> |
5354 |
</t> |
</t> |
5355 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
5505 |
<list> |
<list> |
5506 |
<t>INSTRUMENT_FILE - |
<t>INSTRUMENT_FILE - |
5507 |
<list> |
<list> |
5508 |
<t>File name of the instrument.</t> |
<t>File name of the instrument. |
5509 |
|
Note that the character string may contain |
5510 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5511 |
</list> |
</list> |
5512 |
</t> |
</t> |
5513 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
5546 |
</t> |
</t> |
5547 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
5548 |
<list> |
<list> |
5549 |
<t>A brief description of the instrument</t> |
<t>A brief description of the instrument. |
5550 |
|
Note that the character string may contain |
5551 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5552 |
</list> |
</list> |
5553 |
</t> |
</t> |
5554 |
<t>IS_DRUM - |
<t>IS_DRUM - |
5559 |
</t> |
</t> |
5560 |
<t>PRODUCT - |
<t>PRODUCT - |
5561 |
<list> |
<list> |
5562 |
<t>The product title of the instrument</t> |
<t>The product title of the instrument. |
5563 |
|
Note that the character string may contain |
5564 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5565 |
</list> |
</list> |
5566 |
</t> |
</t> |
5567 |
<t>ARTISTS - |
<t>ARTISTS - |
5568 |
<list> |
<list> |
5569 |
<t>Lists the artist names</t> |
<t>Lists the artist names. |
5570 |
|
Note that the character string may contain |
5571 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5572 |
</list> |
</list> |
5573 |
</t> |
</t> |
5574 |
<t>KEYWORDS - |
<t>KEYWORDS - |
5575 |
<list> |
<list> |
5576 |
<t>Provides a list of keywords that refer to the instrument. |
<t>Provides a list of keywords that refer to the instrument. |
5577 |
Keywords are separated with semicolon and blank.</t> |
Keywords are separated with semicolon and blank. |
5578 |
|
Note that the character string may contain |
5579 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5580 |
</list> |
</list> |
5581 |
</t> |
</t> |
5582 |
</list> |
</list> |
5733 |
</list> |
</list> |
5734 |
</t> |
</t> |
5735 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
5736 |
<desc> is the new description for the instrument.</t> |
<desc> is the new description for the instrument |
5737 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5738 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5739 |
|
|
5740 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5741 |
<t> |
<t> |
5780 |
<t>NAME='<search-string>' |
<t>NAME='<search-string>' |
5781 |
<list> |
<list> |
5782 |
<t>Restricts the search to instruments, which names |
<t>Restricts the search to instruments, which names |
5783 |
satisfy the supplied search string.</t> |
satisfy the supplied search string (encapsulated into apostrophes, |
5784 |
|
supporting escape sequences as described in chapter |
5785 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5786 |
</list> |
</list> |
5787 |
</t> |
</t> |
5788 |
|
|
5789 |
<t>SIZE=[<min>]..[<max>] |
<t>SIZE=[<min>]..[<max>] |
5790 |
<list> |
<list> |
5791 |
<t>Restricts the search to instruments, which |
<t>Restricts the search to instruments, which |
5792 |
size is in the specified range. If <min> is omitted, |
size is in the specified range. If <min> is omitted, |
5793 |
the search results are restricted to instruments with size less then |
the search results are restricted to instruments with size less then |
5794 |
or equal to <max>. If <max> is omitted, the |
or equal to <max>. If <max> is omitted, the |
5824 |
<t>DESCRIPTION='<search-string>' |
<t>DESCRIPTION='<search-string>' |
5825 |
<list> |
<list> |
5826 |
<t>Restricts the search to instruments with description |
<t>Restricts the search to instruments with description |
5827 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5828 |
|
supporting escape sequences as described in chapter |
5829 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5830 |
</list> |
</list> |
5831 |
</t> |
</t> |
5832 |
|
|
5833 |
<t>PRODUCT='<search-string>' |
<t>PRODUCT='<search-string>' |
5834 |
<list> |
<list> |
5835 |
<t>Restricts the search to instruments with product info |
<t>Restricts the search to instruments with product info |
5836 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5837 |
|
supporting escape sequences as described in chapter |
5838 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5839 |
</list> |
</list> |
5840 |
</t> |
</t> |
5841 |
|
|
5842 |
<t>ARTISTS='<search-string>' |
<t>ARTISTS='<search-string>' |
5843 |
<list> |
<list> |
5844 |
<t>Restricts the search to instruments with artists info |
<t>Restricts the search to instruments with artists info |
5845 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5846 |
|
supporting escape sequences as described in chapter |
5847 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5848 |
</list> |
</list> |
5849 |
</t> |
</t> |
5850 |
|
|
5851 |
<t>KEYWORDS='<search-string>' |
<t>KEYWORDS='<search-string>' |
5852 |
<list> |
<list> |
5853 |
<t>Restricts the search to instruments with keyword list |
<t>Restricts the search to instruments with keyword list |
5854 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5855 |
|
supporting escape sequences as described in chapter |
5856 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5857 |
</list> |
</list> |
5858 |
</t> |
</t> |
5859 |
|
|
5860 |
<t>IS_DRUM=true | false |
<t>IS_DRUM=true | false |
5861 |
<list> |
<list> |
5862 |
<t>Either true or false. Restricts the search to |
<t>Either true or false. Restricts the search to |
5863 |
drum kits or chromatic instruments.</t> |
drum kits or chromatic instruments.</t> |
5864 |
</list> |
</list> |
5865 |
</t> |
</t> |
5903 |
</t> |
</t> |
5904 |
</section> |
</section> |
5905 |
|
|
5906 |
|
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO"> |
5907 |
|
<t>The front-end can ask for the current status of a |
5908 |
|
particular database instruments job by sending the following command:</t> |
5909 |
|
<t> |
5910 |
|
<list> |
5911 |
|
<t>GET DB_INSTRUMENTS_JOB INFO <job-id></t> |
5912 |
|
</list> |
5913 |
|
</t> |
5914 |
|
<t>Where <job-id> should be replaced by the numerical ID |
5915 |
|
of the job the front-end is interested in.</t> |
5916 |
|
|
5917 |
|
<t>Possible Answers:</t> |
5918 |
|
<t> |
5919 |
|
<list> |
5920 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
5921 |
|
Each answer line begins with the settings category name |
5922 |
|
followed by a colon and then a space character <SP> and finally |
5923 |
|
the info character string to that setting category. At the |
5924 |
|
moment the following categories are defined:</t> |
5925 |
|
|
5926 |
|
<t> |
5927 |
|
<list> |
5928 |
|
<t>FILES_TOTAL - |
5929 |
|
<list> |
5930 |
|
<t>The total number of files scheduled for scanning</t> |
5931 |
|
</list> |
5932 |
|
</t> |
5933 |
|
<t>FILES_SCANNED - |
5934 |
|
<list> |
5935 |
|
<t>The current number of scanned files</t> |
5936 |
|
</list> |
5937 |
|
</t> |
5938 |
|
<t>SCANNING - |
5939 |
|
<list> |
5940 |
|
<t>The absolute path name of the file which is currently |
5941 |
|
being scanned</t> |
5942 |
|
</list> |
5943 |
|
</t> |
5944 |
|
<t>STATUS - |
5945 |
|
<list> |
5946 |
|
<t>An integer value between 0 and 100 indicating the |
5947 |
|
scanning progress percentage of the file which is |
5948 |
|
currently being scanned</t> |
5949 |
|
</list> |
5950 |
|
</t> |
5951 |
|
</list> |
5952 |
|
</t> |
5953 |
|
</list> |
5954 |
|
</t> |
5955 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
5956 |
|
|
5957 |
|
<t>Example:</t> |
5958 |
|
<t> |
5959 |
|
<list> |
5960 |
|
<t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t> |
5961 |
|
<t>S: "FILES_TOTAL: 12"</t> |
5962 |
|
<t> "FILES_SCANNED: 7"</t> |
5963 |
|
<t> "SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t> |
5964 |
|
<t> "STATUS: 42"</t> |
5965 |
|
<t> "."</t> |
5966 |
|
</list> |
5967 |
|
</t> |
5968 |
|
</section> |
5969 |
|
|
5970 |
|
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
5971 |
|
<t>The front-end can remove all instruments and directories and re-create |
5972 |
|
the instruments database structure (e.g., in case of a database corruption) |
5973 |
|
by sending the following command:</t> |
5974 |
|
<t> |
5975 |
|
<list> |
5976 |
|
<t>FORMAT INSTRUMENTS_DB</t> |
5977 |
|
</list> |
5978 |
|
</t> |
5979 |
|
|
5980 |
|
<t>Possible Answers:</t> |
5981 |
|
<t> |
5982 |
|
<list> |
5983 |
|
<t>"OK" - |
5984 |
|
<list> |
5985 |
|
<t>on success</t> |
5986 |
|
</list> |
5987 |
|
</t> |
5988 |
|
<t>"ERR:<error-code>:<error-message>" - |
5989 |
|
<list> |
5990 |
|
<t>If the formatting of the instruments database |
5991 |
|
failed.</t> |
5992 |
|
</list> |
5993 |
|
</t> |
5994 |
|
</list> |
5995 |
|
</t> |
5996 |
|
</section> |
5997 |
|
|
5998 |
</section> |
</section> |
5999 |
|
|
6000 |
|
|
6001 |
|
|
6002 |
|
<section title="Editing Instruments" anchor="editing_instruments"> |
6003 |
|
<t>The sampler allows to edit instruments while playing with the |
6004 |
|
sampler by spawning an external (3rd party) instrument editor |
6005 |
|
application for a given instrument. The 3rd party instrument |
6006 |
|
editor applications have to place a respective plugin DLL file |
6007 |
|
into the sampler's plugins directory. The sampler will |
6008 |
|
automatically try to load all plugin DLLs in that directory on |
6009 |
|
startup and only on startup!</t> |
6010 |
|
<t>At the moment there is only one command for this feature set, |
6011 |
|
but this will most probably change in future.</t> |
6012 |
|
|
6013 |
|
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT"> |
6014 |
|
<t>The front-end can request to open an appropriate instrument |
6015 |
|
editor application by sending the following command:</t> |
6016 |
|
<t> |
6017 |
|
<list> |
6018 |
|
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6019 |
|
</list> |
6020 |
|
</t> |
6021 |
|
<t>Where <sampler-channel> should be replaced by the |
6022 |
|
number of the sampler channel as given by the |
6023 |
|
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
6024 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
6025 |
|
command.</t> |
6026 |
|
|
6027 |
|
<t>The sampler will try to ask all registered instrument |
6028 |
|
editors (or to be more specific: their sampler plugins) |
6029 |
|
whether they are capable to handle the instrument on the |
6030 |
|
given sampler channel. The sampler will simply use the first |
6031 |
|
instrument editor application which replied with a positive |
6032 |
|
answer and spawn that instrument editor application within |
6033 |
|
the sampler's process and provide that application access |
6034 |
|
to the instrument's data structures, so both applications |
6035 |
|
can share and access the same instruments data at the same |
6036 |
|
time, thus allowing to immediately hear changes with the |
6037 |
|
sampler made by the instrument editor.</t> |
6038 |
|
|
6039 |
|
<t>Note: consequently instrument editors are always spawned |
6040 |
|
locally on the same machine where the sampler is running |
6041 |
|
on!</t> |
6042 |
|
|
6043 |
|
<t>Possible Answers:</t> |
6044 |
|
<t> |
6045 |
|
<list> |
6046 |
|
<t>"OK" - |
6047 |
|
<list> |
6048 |
|
<t>when an appropriate instrument editor was |
6049 |
|
launched</t> |
6050 |
|
</list> |
6051 |
|
</t> |
6052 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6053 |
|
<list> |
6054 |
|
<t>when an appropriate instrument editor was |
6055 |
|
launched, but there are noteworthy issues</t> |
6056 |
|
</list> |
6057 |
|
</t> |
6058 |
|
<t>"ERR:<error-code>:<error-message>" - |
6059 |
|
<list> |
6060 |
|
<t>when an appropriate instrument editor |
6061 |
|
could not be launched</t> |
6062 |
|
</list> |
6063 |
|
</t> |
6064 |
|
</list> |
6065 |
|
</t> |
6066 |
|
|
6067 |
|
<t>Examples:</t> |
6068 |
|
<t> |
6069 |
|
<list> |
6070 |
|
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6071 |
|
<t>S: "OK"</t> |
6072 |
|
</list> |
6073 |
|
</t> |
6074 |
|
</section> |
6075 |
|
</section> |
6076 |
</section> |
</section> |
6077 |
|
|
6078 |
|
|
6158 |
</t> |
</t> |
6159 |
<t>/ COPY SP copy_instruction |
<t>/ COPY SP copy_instruction |
6160 |
</t> |
</t> |
6161 |
|
<t>/ EDIT SP edit_instruction |
6162 |
|
</t> |
6163 |
|
<t>/ FORMAT SP format_instruction |
6164 |
|
</t> |
6165 |
<t>/ RESET |
<t>/ RESET |
6166 |
</t> |
</t> |
6167 |
<t>/ QUIT |
<t>/ QUIT |
6172 |
<list> |
<list> |
6173 |
<t>CHANNEL |
<t>CHANNEL |
6174 |
</t> |
</t> |
6175 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6176 |
|
</t> |
6177 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
6178 |
</t> |
</t> |
6179 |
<t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
6180 |
</t> |
</t> |
6181 |
<t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
6182 |
</t> |
</t> |
6183 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
6184 |
</t> |
</t> |
6185 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index |
<t>/ DB_INSTRUMENTS SP db_path SP filename |
6186 |
|
</t> |
6187 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
6188 |
</t> |
</t> |
6189 |
<t>/ MIDI_INSTRUMENT_MAP |
<t>/ MIDI_INSTRUMENT_MAP |
6190 |
</t> |
</t> |
6232 |
</t> |
</t> |
6233 |
<t>/ DB_INSTRUMENT_INFO |
<t>/ DB_INSTRUMENT_INFO |
6234 |
</t> |
</t> |
6235 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
6236 |
|
</t> |
6237 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6238 |
</t> |
</t> |
6239 |
|
<t>/ TOTAL_STREAM_COUNT |
6240 |
|
</t> |
6241 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6242 |
</t> |
</t> |
6243 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6284 |
</t> |
</t> |
6285 |
<t>/ DB_INSTRUMENT_INFO |
<t>/ DB_INSTRUMENT_INFO |
6286 |
</t> |
</t> |
6287 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
6288 |
|
</t> |
6289 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6290 |
</t> |
</t> |
6291 |
|
<t>/ TOTAL_STREAM_COUNT |
6292 |
|
</t> |
6293 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6294 |
</t> |
</t> |
6295 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6322 |
</t> |
</t> |
6323 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
6324 |
</t> |
</t> |
6325 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
6326 |
</t> |
</t> |
6327 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6328 |
</t> |
</t> |
6329 |
<t>/ DB_INSTRUMENT SP pathname |
<t>/ DB_INSTRUMENT SP db_path |
6330 |
</t> |
</t> |
6331 |
</list> |
</list> |
6332 |
</t> |
</t> |
6380 |
</t> |
</t> |
6381 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
6382 |
</t> |
</t> |
6383 |
|
<t>/ TOTAL_STREAM_COUNT |
6384 |
|
</t> |
6385 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6386 |
</t> |
</t> |
6387 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
6400 |
</t> |
</t> |
6401 |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
6402 |
</t> |
</t> |
6403 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6404 |
|
</t> |
6405 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6406 |
</t> |
</t> |
6407 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
6408 |
</t> |
</t> |
6409 |
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6410 |
</t> |
</t> |
6411 |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENTS SP db_path |
6412 |
</t> |
</t> |
6413 |
<t>/ DB_INSTRUMENTS SP pathname |
<t>/ DB_INSTRUMENT SP INFO SP db_path |
6414 |
</t> |
</t> |
6415 |
<t>/ DB_INSTRUMENT SP INFO SP pathname |
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
6416 |
</t> |
</t> |
6417 |
<t>/ VOLUME |
<t>/ VOLUME |
6418 |
</t> |
</t> |
6419 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
6420 |
|
</t> |
6421 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6422 |
|
</t> |
6423 |
</list> |
</list> |
6424 |
</t> |
</t> |
6425 |
<t>set_instruction = |
<t>set_instruction = |
6430 |
</t> |
</t> |
6431 |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
6432 |
</t> |
</t> |
6433 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
6434 |
|
</t> |
6435 |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
6436 |
</t> |
</t> |
6437 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
6446 |
</t> |
</t> |
6447 |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
6448 |
</t> |
</t> |
6449 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
6450 |
</t> |
</t> |
6451 |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
6452 |
</t> |
</t> |
6453 |
<t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname |
<t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
6454 |
</t> |
</t> |
6455 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
6456 |
</t> |
</t> |
6457 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
6458 |
</t> |
</t> |
6492 |
</t> |
</t> |
6493 |
<t>find_instruction = |
<t>find_instruction = |
6494 |
<list> |
<list> |
6495 |
<t>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list |
<t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
6496 |
</t> |
</t> |
6497 |
<t>/ DB_INSTRUMENTS SP pathname SP query_val_list |
<t>/ DB_INSTRUMENTS SP db_path SP query_val_list |
6498 |
</t> |
</t> |
6499 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
6500 |
</t> |
</t> |
6501 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
6502 |
</t> |
</t> |
6503 |
</list> |
</list> |
6504 |
</t> |
</t> |
6505 |
<t>move_instruction = |
<t>move_instruction = |
6506 |
<list> |
<list> |
6507 |
<t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
6508 |
</t> |
</t> |
6509 |
<t>/ DB_INSTRUMENT SP pathname SP pathname |
<t>/ DB_INSTRUMENT SP db_path SP db_path |
6510 |
</t> |
</t> |
6511 |
</list> |
</list> |
6512 |
</t> |
</t> |
6513 |
<t>copy_instruction = |
<t>copy_instruction = |
6514 |
<list> |
<list> |
6515 |
<t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
6516 |
</t> |
</t> |
6517 |
<t>/ DB_INSTRUMENT SP pathname SP pathname |
<t>/ DB_INSTRUMENT SP db_path SP db_path |
6518 |
</t> |
</t> |
6519 |
</list> |
</list> |
6520 |
</t> |
</t> |
6568 |
</t> |
</t> |
6569 |
</list> |
</list> |
6570 |
</t> |
</t> |
6571 |
|
<t>edit_instruction = |
6572 |
|
<list> |
6573 |
|
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
6574 |
|
</t> |
6575 |
|
</list> |
6576 |
|
</t> |
6577 |
|
<t>format_instruction = |
6578 |
|
<list> |
6579 |
|
<t>INSTRUMENTS_DB |
6580 |
|
</t> |
6581 |
|
</list> |
6582 |
|
</t> |
6583 |
<t>modal_arg = |
<t>modal_arg = |
6584 |
<list> |
<list> |
6585 |
<t>/* epsilon (empty argument) */ |
<t>/* epsilon (empty argument) */ |
6626 |
</t> |
</t> |
6627 |
<t>/ FX_SENDS SP sampler_channel |
<t>/ FX_SENDS SP sampler_channel |
6628 |
</t> |
</t> |
6629 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6630 |
|
</t> |
6631 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6632 |
</t> |
</t> |
6633 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6634 |
</t> |
</t> |
6635 |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENTS SP db_path |
6636 |
</t> |
</t> |
6637 |
<t>/ DB_INSTRUMENTS SP pathname |
<t>/ FILE SP INSTRUMENTS SP filename |
6638 |
</t> |
</t> |
6639 |
</list> |
</list> |
6640 |
</t> |
</t> |
6756 |
</t> |
</t> |
6757 |
</list> |
</list> |
6758 |
</t> |
</t> |
6759 |
<t>pathname = |
<t>filename = |
|
<list> |
|
|
<t>stringval |
|
|
</t> |
|
|
</list> |
|
|
</t> |
|
|
<t>dirname = |
|
6760 |
<list> |
<list> |
6761 |
<t>stringval |
<t>path |
6762 |
</t> |
</t> |
6763 |
</list> |
</list> |
6764 |
</t> |
</t> |
6765 |
<t>filename = |
<t>db_path = |
6766 |
<list> |
<list> |
6767 |
<t>stringval |
<t>path |
6768 |
</t> |
</t> |
6769 |
</list> |
</list> |
6770 |
</t> |
</t> |
6771 |
<t>map_name = |
<t>map_name = |
6772 |
<list> |
<list> |
6773 |
<t>stringval |
<t>stringval_escaped |
6774 |
</t> |
</t> |
6775 |
</list> |
</list> |
6776 |
</t> |
</t> |
6777 |
<t>entry_name = |
<t>entry_name = |
6778 |
<list> |
<list> |
6779 |
<t>stringval |
<t>stringval_escaped |
6780 |
</t> |
</t> |
6781 |
</list> |
</list> |
6782 |
</t> |
</t> |
6783 |
<t>fx_send_name = |
<t>fx_send_name = |
6784 |
<list> |
<list> |
6785 |
<t>stringval |
<t>stringval_escaped |
6786 |
</t> |
</t> |
6787 |
</list> |
</list> |
6788 |
</t> |
</t> |
6794 |
</t> |
</t> |
6795 |
</list> |
</list> |
6796 |
</t> |
</t> |
6797 |
|
|
6798 |
<t>param_val = |
<t>param_val = |
6799 |
<list> |
<list> |
6800 |
<t>string |
<t>string |
6817 |
</t> |
</t> |
6818 |
<t>query_val = |
<t>query_val = |
6819 |
<list> |
<list> |
6820 |
<t>string |
<t>text_escaped |
6821 |
</t> |
</t> |
6822 |
<t>/ stringval |
<t>/ stringval_escaped |
6823 |
|
</t> |
6824 |
|
</list> |
6825 |
|
</t> |
6826 |
|
<t>scan_mode = |
6827 |
|
<list> |
6828 |
|
<t>RECURSIVE |
6829 |
|
</t> |
6830 |
|
<t>/ NON_RECURSIVE |
6831 |
|
</t> |
6832 |
|
<t>/ FLAT |
6833 |
</t> |
</t> |
6834 |
</list> |
</list> |
6835 |
</t> |
</t> |
6836 |
|
|
6837 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
6838 |
|
|
6839 |
|
<section title="Character Set and Escape Sequences" anchor="character_set"> |
6840 |
|
<t>Older versions of this protocol up to and including v1.1 only |
6841 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
6842 |
|
<xref target="RFC20"/>, all younger versions of this protocol |
6843 |
|
however support the Extended ASCII character set (ASCII code |
6844 |
|
0 - 255). The same group of younger protocols also support |
6845 |
|
escape sequences, but only for certain, explicitly declared |
6846 |
|
parts of the protocol. The supported escape sequences are |
6847 |
|
defined as follows:</t> |
6848 |
|
<texttable> |
6849 |
|
<ttcol>ASCII Character Sequence</ttcol> |
6850 |
|
<ttcol>Translated into (Name)</ttcol> |
6851 |
|
<c>\n</c> <c>new line</c> |
6852 |
|
<c>\r</c> <c>carriage return</c> |
6853 |
|
<c>\f</c> <c>form feed</c> |
6854 |
|
<c>\t</c> <c>horizontal tab</c> |
6855 |
|
<c>\v</c> <c>vertical tab</c> |
6856 |
|
<c>\'</c> <c>apostrophe</c> |
6857 |
|
<c>\"</c> <c>quotation mark</c> |
6858 |
|
<c>\\</c> <c>backslash</c> |
6859 |
|
<c>\OOO</c> <c>three digit octal ASCII code of the character</c> |
6860 |
|
<c>\xHH</c> <c>two digit hex ASCII code of the character</c> |
6861 |
|
</texttable> |
6862 |
|
<t>Notice: due to the transition of certain parts of the |
6863 |
|
protocol which now support escape sequences, a slight backward |
6864 |
|
incompatibility to protocols version v1.1 and younger has been |
6865 |
|
introduced. The only difference is that in parts of the protocol |
6866 |
|
where escape characters are now supported, a backslash characters |
6867 |
|
MUST be escaped as well (that is as double backslash), whereas |
6868 |
|
in the old versions a single backslash was sufficient.</t> |
6869 |
|
|
6870 |
|
<t>The following LSCP commands support escape sequences as part |
6871 |
|
of their filename / path based arguments and / or may contain |
6872 |
|
a filename / path with escape sequences in their response: |
6873 |
|
<list> |
6874 |
|
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
6875 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
6876 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
6877 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
6878 |
|
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
6879 |
|
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
6880 |
|
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
6881 |
|
<t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t> |
6882 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t> |
6883 |
|
<t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t> |
6884 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
6885 |
|
<t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t> |
6886 |
|
<t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t> |
6887 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
6888 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
6889 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
6890 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
6891 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
6892 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
6893 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
6894 |
|
<t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t> |
6895 |
|
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
6896 |
|
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
6897 |
|
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
6898 |
|
</list> |
6899 |
|
Note that the forward slash character ('/') has a special meaning in |
6900 |
|
filename / path based arguments: it acts as separator of the nodes in |
6901 |
|
the path, thus if a directory- or filename includes a forward slash |
6902 |
|
(not intended as path node separator), you MUST escape that slash |
6903 |
|
either with the respective hex escape sequence ("\x2f") or with the |
6904 |
|
respective octal escape sequence ("\057"). |
6905 |
|
</t> |
6906 |
|
|
6907 |
|
<t> |
6908 |
|
The following LSCP commands even support escape sequences as |
6909 |
|
part of at least one of their text-based arguments (i.e. entity name, |
6910 |
|
description) and / or may contain escape sequences in at least one of |
6911 |
|
their text-based fields in their response: |
6912 |
|
<list> |
6913 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
6914 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
6915 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
6916 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
6917 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
6918 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
6919 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
6920 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
6921 |
|
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
6922 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
6923 |
|
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
6924 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
6925 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
6926 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
6927 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
6928 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
6929 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
6930 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
6931 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
6932 |
|
</list> |
6933 |
|
Please note that these lists are manually maintained. If you |
6934 |
|
find a command that also supports escape sequences we forgot to |
6935 |
|
mention here, please report it! |
6936 |
|
</t> |
6937 |
|
</section> |
6938 |
</section> |
</section> |
6939 |
|
|
6940 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
7120 |
</section> |
</section> |
7121 |
|
|
7122 |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
7123 |
<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 |
7124 |
a particular sampler channel is changed by issuing the following command:</t> |
a particular sampler channel is changed by issuing the following command:</t> |
7125 |
<t> |
<t> |
7126 |
<list> |
<list> |
7175 |
all currently active voices.</t> |
all currently active voices.</t> |
7176 |
</section> |
</section> |
7177 |
|
|
7178 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
7179 |
|
<t>Client may want to be notified when the total number of disk streams on the |
7180 |
|
back-end changes by issuing the following command:</t> |
7181 |
|
<t> |
7182 |
|
<list> |
7183 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
7184 |
|
</list> |
7185 |
|
</t> |
7186 |
|
<t>Server will start sending the following notification messages:</t> |
7187 |
|
<t> |
7188 |
|
<list> |
7189 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
7190 |
|
</list> |
7191 |
|
</t> |
7192 |
|
<t>where <streams> will be replaced by the new number of |
7193 |
|
all currently active disk streams.</t> |
7194 |
|
</section> |
7195 |
|
|
7196 |
<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"> |
7197 |
<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 |
7198 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7398 |
the new name of the instrument, encapsulated into apostrophes.</t> |
the new name of the instrument, encapsulated into apostrophes.</t> |
7399 |
</section> |
</section> |
7400 |
|
|
7401 |
|
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"> |
7402 |
|
<t>Client may want to be notified when the status of particular database |
7403 |
|
instruments job is changed by issuing the following command:</t> |
7404 |
|
<t> |
7405 |
|
<list> |
7406 |
|
<t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t> |
7407 |
|
</list> |
7408 |
|
</t> |
7409 |
|
<t>Server will start sending the following notification messages:</t> |
7410 |
|
<t> |
7411 |
|
<list> |
7412 |
|
<t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"</t> |
7413 |
|
</list> |
7414 |
|
</t> |
7415 |
|
<t>where <job-id> will be replaced by the numerical ID of the job, |
7416 |
|
which status is changed. The front-end will have to send the respective |
7417 |
|
command to actually get the status info. Because these messages |
7418 |
|
will be triggered by LSCP commands issued by other clients rather than real |
7419 |
|
time events happening on the server, it is believed that an empty notification |
7420 |
|
message is sufficient here.</t> |
7421 |
|
</section> |
7422 |
|
|
7423 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
7424 |
<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 |
7425 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
7498 |
</front> |
</front> |
7499 |
<seriesInfo name="RFC" value="2234" /> |
<seriesInfo name="RFC" value="2234" /> |
7500 |
</reference> |
</reference> |
7501 |
|
<reference anchor="RFC20"> |
7502 |
|
<front> |
7503 |
|
<title>ASCII format for Network Interchange</title> |
7504 |
|
<author> |
7505 |
|
<organization>UCLA</organization> |
7506 |
|
</author> |
7507 |
|
<date year="1969"></date> |
7508 |
|
</front> |
7509 |
|
<seriesInfo name="RFC" value="20" /> |
7510 |
|
</reference> |
7511 |
</references> |
</references> |
7512 |
</back> |
</back> |
7513 |
|
|