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.4"> |
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="May" year="2007"/> |
<date month="April" year="2008"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
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 |
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 - |
3268 |
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> |
3269 |
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 |
3270 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
3271 |
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 |
3272 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
3273 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>".</t> |
3274 |
|
|
3275 |
<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 |
3276 |
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 |
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 - |
3525 |
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> |
3526 |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3527 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
3528 |
does not have to be unique.</t> |
does not have to be unique (name MUST be encapsulated into apostrophes |
3529 |
|
and supports escape sequences as described in chapter |
3530 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
3531 |
|
</t> |
3532 |
|
|
3533 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
3534 |
<t> |
<t> |
3711 |
</t> |
</t> |
3712 |
</section> |
</section> |
3713 |
|
|
3714 |
|
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
3715 |
|
<t>The front-end can send MIDI events to specific sampler channel |
3716 |
|
by sending the following command:</t> |
3717 |
|
<t> |
3718 |
|
<list> |
3719 |
|
<t>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2></t> |
3720 |
|
</list> |
3721 |
|
</t> |
3722 |
|
<t>Where <sampler-chan> is the sampler channel number |
3723 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3724 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3725 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
3726 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported:</t> |
3727 |
|
<t> |
3728 |
|
<list> |
3729 |
|
<t>"NOTE_ON" - |
3730 |
|
<list> |
3731 |
|
<t>For turning on MIDI notes, where <arg1> |
3732 |
|
specifies the key number and <arg2> the velocity |
3733 |
|
as described in the MIDI specification.</t> |
3734 |
|
</list> |
3735 |
|
</t> |
3736 |
|
<t>"NOTE_OFF" - |
3737 |
|
<list> |
3738 |
|
<t>For turning a currently playing MIDI note off, where <arg1> |
3739 |
|
specifies the key number and <arg2> the velocity |
3740 |
|
as described in the MIDI specification.</t> |
3741 |
|
</list> |
3742 |
|
</t> |
3743 |
|
</list> |
3744 |
|
</t> |
3745 |
|
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
3746 |
|
and no realtime guarantee whatsoever will be made!</t> |
3747 |
|
<t>Possible Answers:</t> |
3748 |
|
<t> |
3749 |
|
<list> |
3750 |
|
<t>"OK" - |
3751 |
|
<list> |
3752 |
|
<t>on success</t> |
3753 |
|
</list> |
3754 |
|
</t> |
3755 |
|
<t>"ERR:<error-code>:<error-message>" - |
3756 |
|
<list> |
3757 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3758 |
|
</list> |
3759 |
|
</t> |
3760 |
|
</list> |
3761 |
|
</t> |
3762 |
|
<t>Example:</t> |
3763 |
|
<t> |
3764 |
|
<list> |
3765 |
|
<t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t> |
3766 |
|
<t>S: "OK"</t> |
3767 |
|
</list> |
3768 |
|
</t> |
3769 |
|
</section> |
3770 |
|
|
3771 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3772 |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
3773 |
<t> |
<t> |
3989 |
</t> |
</t> |
3990 |
</section> |
</section> |
3991 |
|
|
3992 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
3993 |
|
<t>The front-end can ask for the current number of active disk streams on |
3994 |
|
the sampler by sending the following command:</t> |
3995 |
|
<t> |
3996 |
|
<list> |
3997 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
3998 |
|
</list> |
3999 |
|
</t> |
4000 |
|
|
4001 |
|
<t>Possible Answers:</t> |
4002 |
|
<t> |
4003 |
|
<list> |
4004 |
|
<t>LinuxSampler will answer by returning the number of all active |
4005 |
|
disk streams on the sampler.</t> |
4006 |
|
</list> |
4007 |
|
</t> |
4008 |
|
</section> |
4009 |
|
|
4010 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
4011 |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
4012 |
<t> |
<t> |
4054 |
<list> |
<list> |
4055 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
4056 |
<list> |
<list> |
4057 |
<t>arbitrary textual description about the sampler</t> |
<t>arbitrary textual description about the sampler |
4058 |
|
(note that the character string may contain |
4059 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4060 |
</list> |
</list> |
4061 |
</t> |
</t> |
4062 |
<t>VERSION - |
<t>VERSION - |
4172 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
4173 |
reflected by the current MIDI instrument map.</t> |
reflected by the current MIDI instrument map.</t> |
4174 |
|
|
4175 |
<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"> |
4176 |
<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 |
4177 |
the following command:</t> |
the following command:</t> |
4178 |
<t> |
<t> |
4182 |
</t> |
</t> |
4183 |
<t>Where <name> is an optional argument allowing to |
<t>Where <name> is an optional argument allowing to |
4184 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
4185 |
names do not have to be unique.</t> |
names do not have to be unique, but MUST be encapsulated |
4186 |
|
into apostrophes and support escape sequences as described |
4187 |
|
in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>". |
4188 |
|
</t> |
4189 |
|
|
4190 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4191 |
<t> |
<t> |
4356 |
<t>NAME - |
<t>NAME - |
4357 |
<list> |
<list> |
4358 |
<t>custom name of the given map, |
<t>custom name of the given map, |
4359 |
which does not have to be unique</t> |
which does not have to be unique |
4360 |
|
(note that this character string may contain |
4361 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4362 |
</list> |
</list> |
4363 |
</t> |
</t> |
4364 |
<t>DEFAULT - |
<t>DEFAULT - |
4394 |
</t> |
</t> |
4395 |
<t>Where <map> is the numerical ID of the map and |
<t>Where <map> is the numerical ID of the map and |
4396 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
4397 |
have to be unique.</t> |
have to be unique (name MUST be encapsulated into apostrophes |
4398 |
|
and supports escape sequences as described in chapter |
4399 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
4400 |
|
</t> |
4401 |
|
|
4402 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4403 |
<t> |
<t> |
4444 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
4445 |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
4446 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
4447 |
of the instrument's file to be deployed (encapsulated into apostrophes), |
of the instrument's file to be deployed (encapsulated into apostrophes, |
4448 |
|
supporting escape sequences as described in chapter |
4449 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"), |
4450 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
4451 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
4452 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
4528 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
4529 |
mode by i.e. sending |
mode by i.e. sending |
4530 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4531 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
4532 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
4533 |
entry, useful for frontends for displaying an appropriate name for |
"<xref target="character_set">Character Set and Escape Sequences</xref>") for the |
4534 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
4535 |
mapped instruments (using |
mapped instruments (using |
4536 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
4537 |
</t> |
</t> |
4755 |
name for this mapped instrument. It can be set and |
name for this mapped instrument. It can be set and |
4756 |
changed with the |
changed with the |
4757 |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
4758 |
command and does not have to be unique.</t> |
command and does not have to be unique. |
4759 |
|
(note that this character string may contain |
4760 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4761 |
</list> |
</list> |
4762 |
</t> |
</t> |
4763 |
<t>"ENGINE_NAME" - |
<t>"ENGINE_NAME" - |
4768 |
</t> |
</t> |
4769 |
<t>"INSTRUMENT_FILE" - |
<t>"INSTRUMENT_FILE" - |
4770 |
<list> |
<list> |
4771 |
<t>File name of the instrument.</t> |
<t>File name of the instrument |
4772 |
|
(note that this path may contain |
4773 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4774 |
</list> |
</list> |
4775 |
</t> |
</t> |
4776 |
<t>"INSTRUMENT_NR" - |
<t>"INSTRUMENT_NR" - |
4782 |
<list> |
<list> |
4783 |
<t>Name of the loaded instrument as reflected by its file. |
<t>Name of the loaded instrument as reflected by its file. |
4784 |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
4785 |
cannot be changed.</t> |
cannot be changed (note that this character string may contain |
4786 |
|
<xref target="character_set">escape sequences</xref>).</t> |
4787 |
</list> |
</list> |
4788 |
</t> |
</t> |
4789 |
<t>"LOAD_MODE" - |
<t>"LOAD_MODE" - |
4871 |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
4872 |
<t>The following commands describe how to use and manage |
<t>The following commands describe how to use and manage |
4873 |
the instruments database.</t> |
the instruments database.</t> |
4874 |
|
<t>Notice:</t> |
4875 |
|
<t> |
4876 |
|
<list> |
4877 |
|
<t>All command arguments representing a path or |
4878 |
|
instrument/directory name support escape sequences as described in chapter |
4879 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>". |
4880 |
|
</t> |
4881 |
|
<t>All occurrences of a forward slash in instrument and directory |
4882 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
4883 |
|
</t> |
4884 |
|
</list> |
4885 |
|
</t> |
4886 |
|
|
4887 |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
4888 |
<t>The front-end can add a new instrument directory to the |
<t>The front-end can add a new instrument directory to the |
5060 |
<list> |
<list> |
5061 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
5062 |
<list> |
<list> |
5063 |
<t>A brief description of the directory content</t> |
<t>A brief description of the directory content. |
5064 |
|
Note that the character string may contain |
5065 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5066 |
</list> |
</list> |
5067 |
</t> |
</t> |
5068 |
<t>CREATED - |
<t>CREATED - |
5226 |
</list> |
</list> |
5227 |
</t> |
</t> |
5228 |
<t>Where <dir> is the absolute path name of the directory and |
<t>Where <dir> is the absolute path name of the directory and |
5229 |
<desc> is the new description for the directory.</t> |
<desc> is the new description for the directory |
5230 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5231 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5232 |
|
|
5233 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5234 |
<t> |
<t> |
5273 |
<t>NAME='<search-string>' |
<t>NAME='<search-string>' |
5274 |
<list> |
<list> |
5275 |
<t>Restricts the search to directories, which names |
<t>Restricts the search to directories, which names |
5276 |
satisfy the supplied search string.</t> |
satisfy the supplied search string (encapsulated into apostrophes, |
5277 |
|
supporting escape sequences as described in chapter |
5278 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5279 |
</list> |
</list> |
5280 |
</t> |
</t> |
5281 |
|
|
5306 |
<t>DESCRIPTION='<search-string>' |
<t>DESCRIPTION='<search-string>' |
5307 |
<list> |
<list> |
5308 |
<t>Restricts the search to directories with description |
<t>Restricts the search to directories with description |
5309 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string |
5310 |
|
(encapsulated into apostrophes, supporting escape |
5311 |
|
sequences as described in chapter |
5312 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5313 |
</list> |
</list> |
5314 |
</t> |
</t> |
5315 |
</t> |
</t> |
5350 |
to the instruments database by sending the following command:</t> |
to the instruments database by sending the following command:</t> |
5351 |
<t> |
<t> |
5352 |
<list> |
<list> |
5353 |
<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> |
5354 |
</list> |
</list> |
5355 |
</t> |
</t> |
5356 |
<t>Where <db_dir> is the absolute path name of a directory |
<t>Where <db_dir> is the absolute path name of a directory |
5368 |
scanning will be done and has exactly the following possibilities:</t> |
scanning will be done and has exactly the following possibilities:</t> |
5369 |
<t> |
<t> |
5370 |
<list> |
<list> |
5371 |
|
<t>"RECURSIVE" - |
5372 |
|
<list> |
5373 |
|
<t>All instruments will be processed, including those |
5374 |
|
in the subdirectories, and the respective subdirectory |
5375 |
|
tree structure will be recreated in the instruments |
5376 |
|
database</t> |
5377 |
|
</list> |
5378 |
|
</t> |
5379 |
<t>"NON_RECURSIVE" - |
<t>"NON_RECURSIVE" - |
5380 |
<list> |
<list> |
5381 |
<t>Only the instruments in the specified directory |
<t>Only the instruments in the specified directory |
5392 |
the specified database directory.</t> |
the specified database directory.</t> |
5393 |
</list> |
</list> |
5394 |
</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> |
|
5395 |
</list> |
</list> |
5396 |
</t> |
</t> |
5397 |
|
|
5398 |
|
<t>The difference between regular and NON_MODAL versions of the command |
5399 |
|
is that the regular command returns when the scanning is finished |
5400 |
|
while NON_MODAL version returns immediately and a background process is launched. |
5401 |
|
The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5402 |
|
command can be used to monitor the scanning progress.</t> |
5403 |
|
|
5404 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5405 |
<t> |
<t> |
5406 |
<list> |
<list> |
5407 |
<t>"OK" - |
<t>"OK" - |
5408 |
<list> |
<list> |
5409 |
<t>on success</t> |
<t>on success when NON_MODAL is not supplied</t> |
5410 |
|
</list> |
5411 |
|
</t> |
5412 |
|
<t>"OK[<job-id>]" - |
5413 |
|
<list> |
5414 |
|
<t>on success when NON_MODAL is supplied, where <job-id> |
5415 |
|
is a numerical ID used to obtain status information about the job progress. |
5416 |
|
See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5417 |
|
</t> |
5418 |
</list> |
</list> |
5419 |
</t> |
</t> |
5420 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
5570 |
<list> |
<list> |
5571 |
<t>INSTRUMENT_FILE - |
<t>INSTRUMENT_FILE - |
5572 |
<list> |
<list> |
5573 |
<t>File name of the instrument.</t> |
<t>File name of the instrument. |
5574 |
|
Note that the character string may contain |
5575 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5576 |
</list> |
</list> |
5577 |
</t> |
</t> |
5578 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
5611 |
</t> |
</t> |
5612 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
5613 |
<list> |
<list> |
5614 |
<t>A brief description of the instrument</t> |
<t>A brief description of the instrument. |
5615 |
|
Note that the character string may contain |
5616 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5617 |
</list> |
</list> |
5618 |
</t> |
</t> |
5619 |
<t>IS_DRUM - |
<t>IS_DRUM - |
5624 |
</t> |
</t> |
5625 |
<t>PRODUCT - |
<t>PRODUCT - |
5626 |
<list> |
<list> |
5627 |
<t>The product title of the instrument</t> |
<t>The product title of the instrument. |
5628 |
|
Note that the character string may contain |
5629 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5630 |
</list> |
</list> |
5631 |
</t> |
</t> |
5632 |
<t>ARTISTS - |
<t>ARTISTS - |
5633 |
<list> |
<list> |
5634 |
<t>Lists the artist names</t> |
<t>Lists the artist names. |
5635 |
|
Note that the character string may contain |
5636 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5637 |
</list> |
</list> |
5638 |
</t> |
</t> |
5639 |
<t>KEYWORDS - |
<t>KEYWORDS - |
5640 |
<list> |
<list> |
5641 |
<t>Provides a list of keywords that refer to the instrument. |
<t>Provides a list of keywords that refer to the instrument. |
5642 |
Keywords are separated with semicolon and blank.</t> |
Keywords are separated with semicolon and blank. |
5643 |
|
Note that the character string may contain |
5644 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5645 |
</list> |
</list> |
5646 |
</t> |
</t> |
5647 |
</list> |
</list> |
5798 |
</list> |
</list> |
5799 |
</t> |
</t> |
5800 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
5801 |
<desc> is the new description for the instrument.</t> |
<desc> is the new description for the instrument |
5802 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5803 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5804 |
|
|
5805 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
5806 |
<t> |
<t> |
5845 |
<t>NAME='<search-string>' |
<t>NAME='<search-string>' |
5846 |
<list> |
<list> |
5847 |
<t>Restricts the search to instruments, which names |
<t>Restricts the search to instruments, which names |
5848 |
satisfy the supplied search string.</t> |
satisfy the supplied search string (encapsulated into apostrophes, |
5849 |
|
supporting escape sequences as described in chapter |
5850 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5851 |
</list> |
</list> |
5852 |
</t> |
</t> |
5853 |
|
|
5854 |
<t>SIZE=[<min>]..[<max>] |
<t>SIZE=[<min>]..[<max>] |
5855 |
<list> |
<list> |
5856 |
<t>Restricts the search to instruments, which |
<t>Restricts the search to instruments, which |
5857 |
size is in the specified range. If <min> is omitted, |
size is in the specified range. If <min> is omitted, |
5858 |
the search results are restricted to instruments with size less then |
the search results are restricted to instruments with size less then |
5859 |
or equal to <max>. If <max> is omitted, the |
or equal to <max>. If <max> is omitted, the |
5889 |
<t>DESCRIPTION='<search-string>' |
<t>DESCRIPTION='<search-string>' |
5890 |
<list> |
<list> |
5891 |
<t>Restricts the search to instruments with description |
<t>Restricts the search to instruments with description |
5892 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5893 |
|
supporting escape sequences as described in chapter |
5894 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5895 |
</list> |
</list> |
5896 |
</t> |
</t> |
5897 |
|
|
5898 |
<t>PRODUCT='<search-string>' |
<t>PRODUCT='<search-string>' |
5899 |
<list> |
<list> |
5900 |
<t>Restricts the search to instruments with product info |
<t>Restricts the search to instruments with product info |
5901 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5902 |
|
supporting escape sequences as described in chapter |
5903 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5904 |
</list> |
</list> |
5905 |
</t> |
</t> |
5906 |
|
|
5907 |
<t>ARTISTS='<search-string>' |
<t>ARTISTS='<search-string>' |
5908 |
<list> |
<list> |
5909 |
<t>Restricts the search to instruments with artists info |
<t>Restricts the search to instruments with artists info |
5910 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5911 |
|
supporting escape sequences as described in chapter |
5912 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5913 |
</list> |
</list> |
5914 |
</t> |
</t> |
5915 |
|
|
5916 |
<t>KEYWORDS='<search-string>' |
<t>KEYWORDS='<search-string>' |
5917 |
<list> |
<list> |
5918 |
<t>Restricts the search to instruments with keyword list |
<t>Restricts the search to instruments with keyword list |
5919 |
that satisfies the supplied search string.</t> |
that satisfies the supplied search string (encapsulated into apostrophes, |
5920 |
|
supporting escape sequences as described in chapter |
5921 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5922 |
</list> |
</list> |
5923 |
</t> |
</t> |
5924 |
|
|
5925 |
<t>IS_DRUM=true | false |
<t>IS_DRUM=true | false |
5926 |
<list> |
<list> |
5927 |
<t>Either true or false. Restricts the search to |
<t>Either true or false. Restricts the search to |
5928 |
drum kits or chromatic instruments.</t> |
drum kits or chromatic instruments.</t> |
5929 |
</list> |
</list> |
5930 |
</t> |
</t> |
5968 |
</t> |
</t> |
5969 |
</section> |
</section> |
5970 |
|
|
5971 |
|
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO"> |
5972 |
|
<t>The front-end can ask for the current status of a |
5973 |
|
particular database instruments job by sending the following command:</t> |
5974 |
|
<t> |
5975 |
|
<list> |
5976 |
|
<t>GET DB_INSTRUMENTS_JOB INFO <job-id></t> |
5977 |
|
</list> |
5978 |
|
</t> |
5979 |
|
<t>Where <job-id> should be replaced by the numerical ID |
5980 |
|
of the job the front-end is interested in.</t> |
5981 |
|
|
5982 |
|
<t>Possible Answers:</t> |
5983 |
|
<t> |
5984 |
|
<list> |
5985 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
5986 |
|
Each answer line begins with the settings category name |
5987 |
|
followed by a colon and then a space character <SP> and finally |
5988 |
|
the info character string to that setting category. At the |
5989 |
|
moment the following categories are defined:</t> |
5990 |
|
|
5991 |
|
<t> |
5992 |
|
<list> |
5993 |
|
<t>FILES_TOTAL - |
5994 |
|
<list> |
5995 |
|
<t>The total number of files scheduled for scanning</t> |
5996 |
|
</list> |
5997 |
|
</t> |
5998 |
|
<t>FILES_SCANNED - |
5999 |
|
<list> |
6000 |
|
<t>The current number of scanned files</t> |
6001 |
|
</list> |
6002 |
|
</t> |
6003 |
|
<t>SCANNING - |
6004 |
|
<list> |
6005 |
|
<t>The absolute path name of the file which is currently |
6006 |
|
being scanned</t> |
6007 |
|
</list> |
6008 |
|
</t> |
6009 |
|
<t>STATUS - |
6010 |
|
<list> |
6011 |
|
<t>An integer value between 0 and 100 indicating the |
6012 |
|
scanning progress percentage of the file which is |
6013 |
|
currently being scanned</t> |
6014 |
|
</list> |
6015 |
|
</t> |
6016 |
|
</list> |
6017 |
|
</t> |
6018 |
|
</list> |
6019 |
|
</t> |
6020 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6021 |
|
|
6022 |
|
<t>Example:</t> |
6023 |
|
<t> |
6024 |
|
<list> |
6025 |
|
<t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t> |
6026 |
|
<t>S: "FILES_TOTAL: 12"</t> |
6027 |
|
<t> "FILES_SCANNED: 7"</t> |
6028 |
|
<t> "SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t> |
6029 |
|
<t> "STATUS: 42"</t> |
6030 |
|
<t> "."</t> |
6031 |
|
</list> |
6032 |
|
</t> |
6033 |
|
</section> |
6034 |
|
|
6035 |
|
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
6036 |
|
<t>The front-end can remove all instruments and directories and re-create |
6037 |
|
the instruments database structure (e.g., in case of a database corruption) |
6038 |
|
by sending the following command:</t> |
6039 |
|
<t> |
6040 |
|
<list> |
6041 |
|
<t>FORMAT INSTRUMENTS_DB</t> |
6042 |
|
</list> |
6043 |
|
</t> |
6044 |
|
|
6045 |
|
<t>Possible Answers:</t> |
6046 |
|
<t> |
6047 |
|
<list> |
6048 |
|
<t>"OK" - |
6049 |
|
<list> |
6050 |
|
<t>on success</t> |
6051 |
|
</list> |
6052 |
|
</t> |
6053 |
|
<t>"ERR:<error-code>:<error-message>" - |
6054 |
|
<list> |
6055 |
|
<t>If the formatting of the instruments database |
6056 |
|
failed.</t> |
6057 |
|
</list> |
6058 |
|
</t> |
6059 |
|
</list> |
6060 |
|
</t> |
6061 |
|
</section> |
6062 |
|
|
6063 |
|
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES"> |
6064 |
|
<t>The front-end can retrieve the list of all instrument files in the instruments database |
6065 |
|
that don't exist in the filesystem by sending the following command:</t> |
6066 |
|
<t> |
6067 |
|
<list> |
6068 |
|
<t>FIND LOST DB_INSTRUMENT_FILES</t> |
6069 |
|
</list> |
6070 |
|
</t> |
6071 |
|
|
6072 |
|
<t>Possible Answers:</t> |
6073 |
|
<t> |
6074 |
|
<list> |
6075 |
|
<t>A comma separated list with the absolute path names |
6076 |
|
(encapsulated into apostrophes) of all lost instrument files.</t> |
6077 |
|
<t>"ERR:<error-code>:<error-message>" - |
6078 |
|
<list> |
6079 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6080 |
|
</list> |
6081 |
|
</t> |
6082 |
|
</list> |
6083 |
|
</t> |
6084 |
|
<t>Example:</t> |
6085 |
|
<t> |
6086 |
|
<list> |
6087 |
|
<t>C: "FIND LOST DB_INSTRUMENT_FILES"</t> |
6088 |
|
<t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t> |
6089 |
|
</list> |
6090 |
|
</t> |
6091 |
|
</section> |
6092 |
|
|
6093 |
|
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH"> |
6094 |
|
<t>The front-end can substitute all occurrences of an instrument file |
6095 |
|
in the instruments database with a new one by sending the following command:</t> |
6096 |
|
<t> |
6097 |
|
<list> |
6098 |
|
<t>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path></t> |
6099 |
|
</list> |
6100 |
|
</t> |
6101 |
|
<t>Where <old_path> is the absolute path name of the instrument file |
6102 |
|
to substitute with <new_path>.</t> |
6103 |
|
|
6104 |
|
<t>Possible Answers:</t> |
6105 |
|
<t> |
6106 |
|
<list> |
6107 |
|
<t>"OK" - |
6108 |
|
<list> |
6109 |
|
<t>on success</t> |
6110 |
|
</list> |
6111 |
|
</t> |
6112 |
|
<t>"ERR:<error-code>:<error-message>" - |
6113 |
|
<list> |
6114 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6115 |
|
</list> |
6116 |
|
</t> |
6117 |
|
</list> |
6118 |
|
</t> |
6119 |
|
|
6120 |
|
<t>Example:</t> |
6121 |
|
<t> |
6122 |
|
<list> |
6123 |
|
<t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t> |
6124 |
|
<t>S: "OK"</t> |
6125 |
|
</list> |
6126 |
|
</t> |
6127 |
|
</section> |
6128 |
|
|
6129 |
</section> |
</section> |
6130 |
|
|
|
</section> |
|
6131 |
|
|
6132 |
|
|
6133 |
|
<section title="Editing Instruments" anchor="editing_instruments"> |
6134 |
|
<t>The sampler allows to edit instruments while playing with the |
6135 |
|
sampler by spawning an external (3rd party) instrument editor |
6136 |
|
application for a given instrument. The 3rd party instrument |
6137 |
|
editor applications have to place a respective plugin DLL file |
6138 |
|
into the sampler's plugins directory. The sampler will |
6139 |
|
automatically try to load all plugin DLLs in that directory on |
6140 |
|
startup and only on startup!</t> |
6141 |
|
<t>At the moment there is only one command for this feature set, |
6142 |
|
but this will most probably change in future.</t> |
6143 |
|
|
6144 |
|
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT"> |
6145 |
|
<t>The front-end can request to open an appropriate instrument |
6146 |
|
editor application by sending the following command:</t> |
6147 |
|
<t> |
6148 |
|
<list> |
6149 |
|
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6150 |
|
</list> |
6151 |
|
</t> |
6152 |
|
<t>Where <sampler-channel> should be replaced by the |
6153 |
|
number of the sampler channel as given by the |
6154 |
|
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
6155 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
6156 |
|
command.</t> |
6157 |
|
|
6158 |
|
<t>The sampler will try to ask all registered instrument |
6159 |
|
editors (or to be more specific: their sampler plugins) |
6160 |
|
whether they are capable to handle the instrument on the |
6161 |
|
given sampler channel. The sampler will simply use the first |
6162 |
|
instrument editor application which replied with a positive |
6163 |
|
answer and spawn that instrument editor application within |
6164 |
|
the sampler's process and provide that application access |
6165 |
|
to the instrument's data structures, so both applications |
6166 |
|
can share and access the same instruments data at the same |
6167 |
|
time, thus allowing to immediately hear changes with the |
6168 |
|
sampler made by the instrument editor.</t> |
6169 |
|
|
6170 |
|
<t>Note: consequently instrument editors are always spawned |
6171 |
|
locally on the same machine where the sampler is running |
6172 |
|
on!</t> |
6173 |
|
|
6174 |
|
<t>Possible Answers:</t> |
6175 |
|
<t> |
6176 |
|
<list> |
6177 |
|
<t>"OK" - |
6178 |
|
<list> |
6179 |
|
<t>when an appropriate instrument editor was |
6180 |
|
launched</t> |
6181 |
|
</list> |
6182 |
|
</t> |
6183 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6184 |
|
<list> |
6185 |
|
<t>when an appropriate instrument editor was |
6186 |
|
launched, but there are noteworthy issues</t> |
6187 |
|
</list> |
6188 |
|
</t> |
6189 |
|
<t>"ERR:<error-code>:<error-message>" - |
6190 |
|
<list> |
6191 |
|
<t>when an appropriate instrument editor |
6192 |
|
could not be launched</t> |
6193 |
|
</list> |
6194 |
|
</t> |
6195 |
|
</list> |
6196 |
|
</t> |
6197 |
|
|
6198 |
|
<t>Examples:</t> |
6199 |
|
<t> |
6200 |
|
<list> |
6201 |
|
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6202 |
|
<t>S: "OK"</t> |
6203 |
|
</list> |
6204 |
|
</t> |
6205 |
|
</section> |
6206 |
|
</section> |
6207 |
|
|
6208 |
|
<section title="Managing Files" anchor="file_management"> |
6209 |
|
<t>You can query detailed informations about files located |
6210 |
|
at the same system where the sampler instance is running on. |
6211 |
|
Using this command set allows to retrieve file informations |
6212 |
|
even remotely from another machine.</t> |
6213 |
|
|
6214 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
6215 |
|
<t>The front-end can retrieve the amount of instruments |
6216 |
|
within a given instrument file by sending the |
6217 |
|
following command:</t> |
6218 |
|
<t> |
6219 |
|
<list> |
6220 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
6221 |
|
</list> |
6222 |
|
</t> |
6223 |
|
<t>Where <filename> is the name of the instrument |
6224 |
|
file (encapsulated into apostrophes, supporting escape |
6225 |
|
sequences as described in chapter |
6226 |
|
"<xref target="character_set">Character Set and Escape |
6227 |
|
Sequences</xref>").</t> |
6228 |
|
|
6229 |
|
<t>The sampler will try to ask all sampler engines, |
6230 |
|
whether they support the given file and ask the first |
6231 |
|
engine with a positive answer for the amount of |
6232 |
|
instruments.</t> |
6233 |
|
|
6234 |
|
<t>Possible Answers:</t> |
6235 |
|
<t> |
6236 |
|
<list> |
6237 |
|
<t>On success, the sampler will answer by |
6238 |
|
returning the amount of instruments. |
6239 |
|
</t> |
6240 |
|
<t>"ERR:<error-code>:<error-message>" - |
6241 |
|
<list> |
6242 |
|
<t>if the file could not be handled</t> |
6243 |
|
</list> |
6244 |
|
</t> |
6245 |
|
</list> |
6246 |
|
</t> |
6247 |
|
|
6248 |
|
<t>Examples:</t> |
6249 |
|
<t> |
6250 |
|
<list> |
6251 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6252 |
|
<t>S: "10"</t> |
6253 |
|
</list> |
6254 |
|
</t> |
6255 |
|
</section> |
6256 |
|
|
6257 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
6258 |
|
<t>The front-end can retrieve a list of all instruments |
6259 |
|
within a given instrument file by sending the |
6260 |
|
following command:</t> |
6261 |
|
<t> |
6262 |
|
<list> |
6263 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
6264 |
|
</list> |
6265 |
|
</t> |
6266 |
|
<t>Where <filename> is the name of the instrument |
6267 |
|
file (encapsulated into apostrophes, supporting escape |
6268 |
|
sequences as described in chapter |
6269 |
|
"<xref target="character_set">Character Set and Escape |
6270 |
|
Sequences</xref>").</t> |
6271 |
|
|
6272 |
|
<t>The sampler will try to ask all sampler engines, |
6273 |
|
whether they support the given file and ask the first |
6274 |
|
engine with a positive answer for a list of IDs for the |
6275 |
|
instruments in the given file.</t> |
6276 |
|
|
6277 |
|
<t>Possible Answers:</t> |
6278 |
|
<t> |
6279 |
|
<list> |
6280 |
|
<t>On success, the sampler will answer by |
6281 |
|
returning a comma separated list of |
6282 |
|
instrument IDs. |
6283 |
|
</t> |
6284 |
|
<t>"ERR:<error-code>:<error-message>" - |
6285 |
|
<list> |
6286 |
|
<t>if the file could not be handled</t> |
6287 |
|
</list> |
6288 |
|
</t> |
6289 |
|
</list> |
6290 |
|
</t> |
6291 |
|
|
6292 |
|
<t>Examples:</t> |
6293 |
|
<t> |
6294 |
|
<list> |
6295 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6296 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
6297 |
|
</list> |
6298 |
|
</t> |
6299 |
|
</section> |
6300 |
|
|
6301 |
|
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
6302 |
|
<t>The front-end can retrieve detailed informations |
6303 |
|
about a specific instrument within a given instrument |
6304 |
|
file by sending the following command:</t> |
6305 |
|
<t> |
6306 |
|
<list> |
6307 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
6308 |
|
<instr-id></t> |
6309 |
|
</list> |
6310 |
|
</t> |
6311 |
|
<t>Where <filename> is the name of the instrument |
6312 |
|
file (encapsulated into apostrophes, supporting escape |
6313 |
|
sequences as described in chapter |
6314 |
|
"<xref target="character_set">Character Set and Escape |
6315 |
|
Sequences</xref>") and <instr-id> is the numeric |
6316 |
|
instrument ID as returned by the |
6317 |
|
<xref target="LIST FILE INSTRUMENTS"> |
6318 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
6319 |
|
|
6320 |
|
<t>The sampler will try to ask all sampler engines, |
6321 |
|
whether they support the given file and ask the first |
6322 |
|
engine with a positive answer for informations about the |
6323 |
|
specific instrument in the given file.</t> |
6324 |
|
|
6325 |
|
<t>Possible Answers:</t> |
6326 |
|
<t> |
6327 |
|
<list> |
6328 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6329 |
|
Each answer line begins with the settings category name |
6330 |
|
followed by a colon and then a space character <SP> and finally |
6331 |
|
the info character string to that setting category. At the |
6332 |
|
moment the following categories are defined:</t> |
6333 |
|
|
6334 |
|
<t> |
6335 |
|
<list> |
6336 |
|
<t>NAME - |
6337 |
|
<list> |
6338 |
|
<t>name of the instrument as |
6339 |
|
stored in the instrument file</t> |
6340 |
|
</list> |
6341 |
|
</t> |
6342 |
|
<t>FORMAT_FAMILY - |
6343 |
|
<list> |
6344 |
|
<t>name of the sampler format |
6345 |
|
of the given instrument</t> |
6346 |
|
</list> |
6347 |
|
</t> |
6348 |
|
<t>FORMAT_VERSION - |
6349 |
|
<list> |
6350 |
|
<t>version of the sampler format |
6351 |
|
the instrumen is stored as</t> |
6352 |
|
</list> |
6353 |
|
</t> |
6354 |
|
<t>PRODUCT - |
6355 |
|
<list> |
6356 |
|
<t>official product name of the |
6357 |
|
instrument as stored in the file |
6358 |
|
</t> |
6359 |
|
</list> |
6360 |
|
</t> |
6361 |
|
<t>ARTISTS - |
6362 |
|
<list> |
6363 |
|
<t>artists / sample library |
6364 |
|
vendor of the instrument</t> |
6365 |
|
</list> |
6366 |
|
</t> |
6367 |
|
<t>KEY_BINDINGS - |
6368 |
|
<list> |
6369 |
|
<t>comma separated list of integer values representing |
6370 |
|
the instrument's key mapping in the range between 0 .. 127, |
6371 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6372 |
|
</list> |
6373 |
|
</t> |
6374 |
|
<t>KEYSWITCH_BINDINGS - |
6375 |
|
<list> |
6376 |
|
<t>comma separated list of integer values representing |
6377 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
6378 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6379 |
|
</list> |
6380 |
|
</t> |
6381 |
|
</list> |
6382 |
|
</t> |
6383 |
|
</list> |
6384 |
|
</t> |
6385 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6386 |
|
|
6387 |
|
<t>Example:</t> |
6388 |
|
<t> |
6389 |
|
<list> |
6390 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
6391 |
|
<t>S: "NAME: Lunatic Loops"</t> |
6392 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6393 |
|
<t> "FORMAT_VERSION: 3"</t> |
6394 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
6395 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
6396 |
|
<t> "."</t> |
6397 |
|
</list> |
6398 |
|
</t> |
6399 |
|
</section> |
6400 |
|
</section> |
6401 |
|
</section> |
6402 |
|
|
6403 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
6404 |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
6405 |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
6482 |
</t> |
</t> |
6483 |
<t>/ COPY SP copy_instruction |
<t>/ COPY SP copy_instruction |
6484 |
</t> |
</t> |
6485 |
|
<t>/ EDIT SP edit_instruction |
6486 |
|
</t> |
6487 |
|
<t>/ FORMAT SP format_instruction |
6488 |
|
</t> |
6489 |
|
<t>SEND SP send_instruction |
6490 |
|
</t> |
6491 |
<t>/ RESET |
<t>/ RESET |
6492 |
</t> |
</t> |
6493 |
<t>/ QUIT |
<t>/ QUIT |
6498 |
<list> |
<list> |
6499 |
<t>CHANNEL |
<t>CHANNEL |
6500 |
</t> |
</t> |
6501 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6502 |
|
</t> |
6503 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
6504 |
|
</t> |
6505 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
6506 |
</t> |
</t> |
6507 |
<t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
6508 |
</t> |
</t> |
6509 |
<t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
6510 |
</t> |
</t> |
6511 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname |
<t>/ DB_INSTRUMENTS SP db_path SP filename |
6512 |
</t> |
</t> |
6513 |
<t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index |
<t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
6514 |
</t> |
</t> |
6515 |
<t>/ MIDI_INSTRUMENT_MAP |
<t>/ MIDI_INSTRUMENT_MAP |
6516 |
</t> |
</t> |
6530 |
</t> |
</t> |
6531 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6532 |
</t> |
</t> |
6533 |
|
<t>/ CHANNEL_MIDI |
6534 |
|
</t> |
6535 |
|
<t>/ DEVICE_MIDI |
6536 |
|
</t> |
6537 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6538 |
</t> |
</t> |
6539 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6562 |
</t> |
</t> |
6563 |
<t>/ DB_INSTRUMENT_INFO |
<t>/ DB_INSTRUMENT_INFO |
6564 |
</t> |
</t> |
6565 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
6566 |
|
</t> |
6567 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6568 |
</t> |
</t> |
6569 |
|
<t>/ TOTAL_STREAM_COUNT |
6570 |
|
</t> |
6571 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6572 |
</t> |
</t> |
6573 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6586 |
</t> |
</t> |
6587 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6588 |
</t> |
</t> |
6589 |
|
<t>/ CHANNEL_MIDI |
6590 |
|
</t> |
6591 |
|
<t>/ DEVICE_MIDI |
6592 |
|
</t> |
6593 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6594 |
</t> |
</t> |
6595 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6618 |
</t> |
</t> |
6619 |
<t>/ DB_INSTRUMENT_INFO |
<t>/ DB_INSTRUMENT_INFO |
6620 |
</t> |
</t> |
6621 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
6622 |
|
</t> |
6623 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
6624 |
</t> |
</t> |
6625 |
|
<t>/ TOTAL_STREAM_COUNT |
6626 |
|
</t> |
6627 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6628 |
</t> |
</t> |
6629 |
<t>/ GLOBAL_INFO |
<t>/ GLOBAL_INFO |
6656 |
</t> |
</t> |
6657 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
6658 |
</t> |
</t> |
6659 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
6660 |
</t> |
</t> |
6661 |
<t>/ DB_INSTRUMENT_DIRECTORY SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6662 |
</t> |
</t> |
6663 |
<t>/ DB_INSTRUMENT SP pathname |
<t>/ DB_INSTRUMENT SP db_path |
6664 |
</t> |
</t> |
6665 |
</list> |
</list> |
6666 |
</t> |
</t> |
6714 |
</t> |
</t> |
6715 |
<t>/ SERVER SP INFO |
<t>/ SERVER SP INFO |
6716 |
</t> |
</t> |
6717 |
|
<t>/ TOTAL_STREAM_COUNT |
6718 |
|
</t> |
6719 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
6720 |
</t> |
</t> |
6721 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
6734 |
</t> |
</t> |
6735 |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
6736 |
</t> |
</t> |
6737 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6738 |
</t> |
</t> |
6739 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6740 |
</t> |
</t> |
6741 |
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
6742 |
</t> |
</t> |
6743 |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6744 |
</t> |
</t> |
6745 |
<t>/ DB_INSTRUMENTS SP pathname |
<t>/ DB_INSTRUMENTS SP db_path |
6746 |
</t> |
</t> |
6747 |
<t>/ DB_INSTRUMENT SP INFO SP pathname |
<t>/ DB_INSTRUMENT SP INFO SP db_path |
6748 |
|
</t> |
6749 |
|
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
6750 |
</t> |
</t> |
6751 |
<t>/ VOLUME |
<t>/ VOLUME |
6752 |
</t> |
</t> |
6753 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
6754 |
|
</t> |
6755 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6756 |
|
</t> |
6757 |
</list> |
</list> |
6758 |
</t> |
</t> |
6759 |
<t>set_instruction = |
<t>set_instruction = |
6764 |
</t> |
</t> |
6765 |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
6766 |
</t> |
</t> |
6767 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
6768 |
|
</t> |
6769 |
<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 |
6770 |
</t> |
</t> |
6771 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
6780 |
</t> |
</t> |
6781 |
<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 |
6782 |
</t> |
</t> |
6783 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
6784 |
|
</t> |
6785 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
6786 |
</t> |
</t> |
6787 |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval |
<t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
6788 |
</t> |
</t> |
6789 |
<t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
6790 |
</t> |
</t> |
6791 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval |
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
6792 |
</t> |
</t> |
6793 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
6794 |
</t> |
</t> |
6828 |
</t> |
</t> |
6829 |
<t>find_instruction = |
<t>find_instruction = |
6830 |
<list> |
<list> |
6831 |
<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 |
6832 |
</t> |
</t> |
6833 |
<t>/ DB_INSTRUMENTS SP pathname SP query_val_list |
<t>/ DB_INSTRUMENTS SP db_path SP query_val_list |
6834 |
</t> |
</t> |
6835 |
<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 |
6836 |
</t> |
</t> |
6837 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
6838 |
|
</t> |
6839 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
6840 |
</t> |
</t> |
6841 |
</list> |
</list> |
6842 |
</t> |
</t> |
6843 |
<t>move_instruction = |
<t>move_instruction = |
6844 |
<list> |
<list> |
6845 |
<t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
6846 |
</t> |
</t> |
6847 |
<t>/ DB_INSTRUMENT SP pathname SP pathname |
<t>/ DB_INSTRUMENT SP db_path SP db_path |
6848 |
</t> |
</t> |
6849 |
</list> |
</list> |
6850 |
</t> |
</t> |
6851 |
<t>copy_instruction = |
<t>copy_instruction = |
6852 |
<list> |
<list> |
6853 |
<t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname |
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
6854 |
</t> |
</t> |
6855 |
<t>/ DB_INSTRUMENT SP pathname SP pathname |
<t>/ DB_INSTRUMENT SP db_path SP db_path |
6856 |
</t> |
</t> |
6857 |
</list> |
</list> |
6858 |
</t> |
</t> |
6906 |
</t> |
</t> |
6907 |
</list> |
</list> |
6908 |
</t> |
</t> |
6909 |
|
<t>edit_instruction = |
6910 |
|
<list> |
6911 |
|
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
6912 |
|
</t> |
6913 |
|
</list> |
6914 |
|
</t> |
6915 |
|
<t>format_instruction = |
6916 |
|
<list> |
6917 |
|
<t>INSTRUMENTS_DB |
6918 |
|
</t> |
6919 |
|
</list> |
6920 |
|
</t> |
6921 |
<t>modal_arg = |
<t>modal_arg = |
6922 |
<list> |
<list> |
6923 |
<t>/* epsilon (empty argument) */ |
<t>/* epsilon (empty argument) */ |
6964 |
</t> |
</t> |
6965 |
<t>/ FX_SENDS SP sampler_channel |
<t>/ FX_SENDS SP sampler_channel |
6966 |
</t> |
</t> |
6967 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6968 |
|
</t> |
6969 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6970 |
</t> |
</t> |
6971 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP pathname |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6972 |
</t> |
</t> |
6973 |
<t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname |
<t>/ DB_INSTRUMENTS SP db_path |
6974 |
</t> |
</t> |
6975 |
<t>/ DB_INSTRUMENTS SP pathname |
<t>/ FILE SP INSTRUMENTS SP filename |
6976 |
|
</t> |
6977 |
|
</list> |
6978 |
|
</t> |
6979 |
|
<t>send_instruction = |
6980 |
|
<list> |
6981 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
6982 |
</t> |
</t> |
6983 |
</list> |
</list> |
6984 |
</t> |
</t> |
7100 |
</t> |
</t> |
7101 |
</list> |
</list> |
7102 |
</t> |
</t> |
7103 |
<t>pathname = |
<t>filename = |
|
<list> |
|
|
<t>stringval |
|
|
</t> |
|
|
</list> |
|
|
</t> |
|
|
<t>dirname = |
|
7104 |
<list> |
<list> |
7105 |
<t>stringval |
<t>path |
7106 |
</t> |
</t> |
7107 |
</list> |
</list> |
7108 |
</t> |
</t> |
7109 |
<t>filename = |
<t>db_path = |
7110 |
<list> |
<list> |
7111 |
<t>stringval |
<t>path |
7112 |
</t> |
</t> |
7113 |
</list> |
</list> |
7114 |
</t> |
</t> |
7115 |
<t>map_name = |
<t>map_name = |
7116 |
<list> |
<list> |
7117 |
<t>stringval |
<t>stringval_escaped |
7118 |
</t> |
</t> |
7119 |
</list> |
</list> |
7120 |
</t> |
</t> |
7121 |
<t>entry_name = |
<t>entry_name = |
7122 |
<list> |
<list> |
7123 |
<t>stringval |
<t>stringval_escaped |
7124 |
</t> |
</t> |
7125 |
</list> |
</list> |
7126 |
</t> |
</t> |
7127 |
<t>fx_send_name = |
<t>fx_send_name = |
7128 |
<list> |
<list> |
7129 |
<t>stringval |
<t>stringval_escaped |
7130 |
</t> |
</t> |
7131 |
</list> |
</list> |
7132 |
</t> |
</t> |
7138 |
</t> |
</t> |
7139 |
</list> |
</list> |
7140 |
</t> |
</t> |
7141 |
|
|
7142 |
<t>param_val = |
<t>param_val = |
7143 |
<list> |
<list> |
7144 |
<t>string |
<t>string |
7161 |
</t> |
</t> |
7162 |
<t>query_val = |
<t>query_val = |
7163 |
<list> |
<list> |
7164 |
<t>string |
<t>text_escaped |
7165 |
</t> |
</t> |
7166 |
<t>/ stringval |
<t>/ stringval_escaped |
7167 |
|
</t> |
7168 |
|
</list> |
7169 |
|
</t> |
7170 |
|
<t>scan_mode = |
7171 |
|
<list> |
7172 |
|
<t>RECURSIVE |
7173 |
|
</t> |
7174 |
|
<t>/ NON_RECURSIVE |
7175 |
|
</t> |
7176 |
|
<t>/ FLAT |
7177 |
</t> |
</t> |
7178 |
</list> |
</list> |
7179 |
</t> |
</t> |
7180 |
|
|
7181 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
7182 |
|
|
7183 |
|
<section title="Character Set and Escape Sequences" anchor="character_set"> |
7184 |
|
<t>Older versions of this protocol up to and including v1.1 only |
7185 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
7186 |
|
<xref target="RFC20"/>, all younger versions of this protocol |
7187 |
|
however support the Extended ASCII character set (ASCII code |
7188 |
|
0 - 255). The same group of younger protocols also support |
7189 |
|
escape sequences, but only for certain, explicitly declared |
7190 |
|
parts of the protocol. The supported escape sequences are |
7191 |
|
defined as follows:</t> |
7192 |
|
<texttable> |
7193 |
|
<ttcol>ASCII Character Sequence</ttcol> |
7194 |
|
<ttcol>Translated into (Name)</ttcol> |
7195 |
|
<c>\n</c> <c>new line</c> |
7196 |
|
<c>\r</c> <c>carriage return</c> |
7197 |
|
<c>\f</c> <c>form feed</c> |
7198 |
|
<c>\t</c> <c>horizontal tab</c> |
7199 |
|
<c>\v</c> <c>vertical tab</c> |
7200 |
|
<c>\'</c> <c>apostrophe</c> |
7201 |
|
<c>\"</c> <c>quotation mark</c> |
7202 |
|
<c>\\</c> <c>backslash</c> |
7203 |
|
<c>\OOO</c> <c>three digit octal ASCII code of the character</c> |
7204 |
|
<c>\xHH</c> <c>two digit hex ASCII code of the character</c> |
7205 |
|
</texttable> |
7206 |
|
<t>Notice: due to the transition of certain parts of the |
7207 |
|
protocol which now support escape sequences, a slight backward |
7208 |
|
incompatibility to protocols version v1.1 and younger has been |
7209 |
|
introduced. The only difference is that in parts of the protocol |
7210 |
|
where escape characters are now supported, a backslash characters |
7211 |
|
MUST be escaped as well (that is as double backslash), whereas |
7212 |
|
in the old versions a single backslash was sufficient.</t> |
7213 |
|
|
7214 |
|
<t>The following LSCP commands support escape sequences as part |
7215 |
|
of their filename / path based arguments and / or may contain |
7216 |
|
a filename / path with escape sequences in their response: |
7217 |
|
<list> |
7218 |
|
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
7219 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
7220 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
7221 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
7222 |
|
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
7223 |
|
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
7224 |
|
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
7225 |
|
<t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t> |
7226 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7227 |
|
<t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7228 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
7229 |
|
<t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t> |
7230 |
|
<t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t> |
7231 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
7232 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
7233 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
7234 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
7235 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
7236 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
7237 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7238 |
|
<t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t> |
7239 |
|
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
7240 |
|
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
7241 |
|
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
7242 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
7243 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
7244 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
7245 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
7246 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
7247 |
|
</list> |
7248 |
|
Note that the forward slash character ('/') has a special meaning in |
7249 |
|
filename / path based arguments: it acts as separator of the nodes in |
7250 |
|
the path, thus if a directory- or filename includes a forward slash |
7251 |
|
(not intended as path node separator), you MUST escape that slash |
7252 |
|
either with the respective hex escape sequence ("\x2f") or with the |
7253 |
|
respective octal escape sequence ("\057"). |
7254 |
|
</t> |
7255 |
|
|
7256 |
|
<t> |
7257 |
|
Note for Windows: file path arguments in LSCP are expected |
7258 |
|
to use forward slashes as directory node separator similar |
7259 |
|
to Unix based operating systems. In contrast to Unix however |
7260 |
|
a Windows typical drive character is expected to be |
7261 |
|
prefixed to the path. That is an original Windows file path |
7262 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
7263 |
|
"D:/Sounds/My.gig". |
7264 |
|
</t> |
7265 |
|
|
7266 |
|
<t> |
7267 |
|
The following LSCP commands even support escape sequences as |
7268 |
|
part of at least one of their text-based arguments (i.e. entity name, |
7269 |
|
description) and / or may contain escape sequences in at least one of |
7270 |
|
their text-based fields in their response: |
7271 |
|
<list> |
7272 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
7273 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
7274 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
7275 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
7276 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
7277 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
7278 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
7279 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
7280 |
|
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
7281 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
7282 |
|
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
7283 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
7284 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
7285 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
7286 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
7287 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
7288 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
7289 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
7290 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
7291 |
|
</list> |
7292 |
|
Please note that these lists are manually maintained. If you |
7293 |
|
find a command that also supports escape sequences we forgot to |
7294 |
|
mention here, please report it! |
7295 |
|
</t> |
7296 |
|
</section> |
7297 |
</section> |
</section> |
7298 |
|
|
7299 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
7397 |
of sampler channels.</t> |
of sampler channels.</t> |
7398 |
</section> |
</section> |
7399 |
|
|
7400 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
7401 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
7402 |
|
back-end side, by issuing the following command:</t> |
7403 |
|
<t> |
7404 |
|
<list> |
7405 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
7406 |
|
</list> |
7407 |
|
</t> |
7408 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7409 |
|
<t> |
7410 |
|
<list> |
7411 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
7412 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
7413 |
|
</list> |
7414 |
|
</t> |
7415 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
7416 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7417 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7418 |
|
</t> |
7419 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7420 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7421 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7422 |
|
thread unaffected by this feature.</t> |
7423 |
|
</section> |
7424 |
|
|
7425 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
7426 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
7427 |
|
<t> |
7428 |
|
<list> |
7429 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
7430 |
|
</list> |
7431 |
|
</t> |
7432 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7433 |
|
<t> |
7434 |
|
<list> |
7435 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
7436 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
7437 |
|
</list> |
7438 |
|
</t> |
7439 |
|
<t>where <device-id> <port-id> will be replaced |
7440 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
7441 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7442 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7443 |
|
</t> |
7444 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7445 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7446 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7447 |
|
thread unaffected by this feature.</t> |
7448 |
|
</section> |
7449 |
|
|
7450 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
7451 |
<t>Client may want to be notified when the number of voices on the |
<t>Client may want to be notified when the number of voices on the |
7452 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7529 |
</section> |
</section> |
7530 |
|
|
7531 |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
7532 |
<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 |
7533 |
a particular sampler channel is changed by issuing the following command:</t> |
a particular sampler channel is changed by issuing the following command:</t> |
7534 |
<t> |
<t> |
7535 |
<list> |
<list> |
7584 |
all currently active voices.</t> |
all currently active voices.</t> |
7585 |
</section> |
</section> |
7586 |
|
|
7587 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
7588 |
|
<t>Client may want to be notified when the total number of disk streams on the |
7589 |
|
back-end changes by issuing the following command:</t> |
7590 |
|
<t> |
7591 |
|
<list> |
7592 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
7593 |
|
</list> |
7594 |
|
</t> |
7595 |
|
<t>Server will start sending the following notification messages:</t> |
7596 |
|
<t> |
7597 |
|
<list> |
7598 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
7599 |
|
</list> |
7600 |
|
</t> |
7601 |
|
<t>where <streams> will be replaced by the new number of |
7602 |
|
all currently active disk streams.</t> |
7603 |
|
</section> |
7604 |
|
|
7605 |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
7606 |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
<t>Client may want to be notified when the number of MIDI instrument maps on the |
7607 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7807 |
the new name of the instrument, encapsulated into apostrophes.</t> |
the new name of the instrument, encapsulated into apostrophes.</t> |
7808 |
</section> |
</section> |
7809 |
|
|
7810 |
|
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"> |
7811 |
|
<t>Client may want to be notified when the status of particular database |
7812 |
|
instruments job is changed by issuing the following command:</t> |
7813 |
|
<t> |
7814 |
|
<list> |
7815 |
|
<t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t> |
7816 |
|
</list> |
7817 |
|
</t> |
7818 |
|
<t>Server will start sending the following notification messages:</t> |
7819 |
|
<t> |
7820 |
|
<list> |
7821 |
|
<t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"</t> |
7822 |
|
</list> |
7823 |
|
</t> |
7824 |
|
<t>where <job-id> will be replaced by the numerical ID of the job, |
7825 |
|
which status is changed. The front-end will have to send the respective |
7826 |
|
command to actually get the status info. Because these messages |
7827 |
|
will be triggered by LSCP commands issued by other clients rather than real |
7828 |
|
time events happening on the server, it is believed that an empty notification |
7829 |
|
message is sufficient here.</t> |
7830 |
|
</section> |
7831 |
|
|
7832 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
7833 |
<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 |
7834 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
7907 |
</front> |
</front> |
7908 |
<seriesInfo name="RFC" value="2234" /> |
<seriesInfo name="RFC" value="2234" /> |
7909 |
</reference> |
</reference> |
7910 |
|
<reference anchor="RFC20"> |
7911 |
|
<front> |
7912 |
|
<title>ASCII format for Network Interchange</title> |
7913 |
|
<author> |
7914 |
|
<organization>UCLA</organization> |
7915 |
|
</author> |
7916 |
|
<date year="1969"></date> |
7917 |
|
</front> |
7918 |
|
<seriesInfo name="RFC" value="20" /> |
7919 |
|
</reference> |
7920 |
</references> |
</references> |
7921 |
</back> |
</back> |
7922 |
|
|