11 |
<?rfc symrefs="yes" ?> |
<?rfc symrefs="yes" ?> |
12 |
<?rfc sortrefs="yes"?> |
<?rfc sortrefs="yes"?> |
13 |
<?rfc iprnotified="no" ?> |
<?rfc iprnotified="no" ?> |
|
<?rfc strict="yes" ?> |
|
14 |
|
|
15 |
<rfc category="std" ipr="full2026" docName="lscp.txt"> |
<!-- FIXME: next attribute should actually be "yes", temporarily disbled due |
16 |
|
to an annoying "missing Normative/Informative References" error message --> |
17 |
|
<?rfc strict="no" ?> |
18 |
|
|
19 |
|
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
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="2005"/> |
<date month="March" year="2007"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
41 |
<t>The LinuxSampler Control Protocol (LSCP) is an |
<t>The LinuxSampler Control Protocol (LSCP) is an |
42 |
application-level protocol primarily intended for local and |
application-level protocol primarily intended for local and |
43 |
remote controlling the LinuxSampler main application, which is a |
remote controlling the LinuxSampler backend application, which is a |
44 |
sophisticated console application essentially playing back audio |
sophisticated server-like console application essentially playing |
45 |
samples and manipulating the samples in real time to certain |
back audio samples and manipulating the samples in real time to |
46 |
extent.</t> |
certain extent.</t> |
47 |
</abstract> |
</abstract> |
48 |
</front> |
</front> |
49 |
|
|
115 |
return and line feed characters respectively.</t> |
return and line feed characters respectively.</t> |
116 |
</section> |
</section> |
117 |
|
|
118 |
|
<section title="Versioning of this specification" anchor="LSCP versioning"> |
119 |
|
<t>LSCP will certainly be extended and enhanced by-and-by. Each official |
120 |
|
release of the LSCP specification will be tagged with a unique version |
121 |
|
tuple. The version tuple consists at least of a major and minor version |
122 |
|
number like: |
123 |
|
</t> |
124 |
|
<t> |
125 |
|
<list> |
126 |
|
<t>"1.2"</t> |
127 |
|
</list> |
128 |
|
</t> |
129 |
|
<t> |
130 |
|
In this example the major version number would be "1" and the minor |
131 |
|
version number would be "2". Note that the version tuple might also |
132 |
|
have more than two elements. The major version number defines a |
133 |
|
group of backward compatible versions. That means a frontend is |
134 |
|
compatible to the connected sampler if and only if the LSCP versions |
135 |
|
to which each of the two parties complies to, match both of the |
136 |
|
following rules: |
137 |
|
</t> |
138 |
|
<t>Compatibility:</t> |
139 |
|
<t> |
140 |
|
<list style="numbers"> |
141 |
|
<t>The frontend's LSCP major version and the sampler's LSCP |
142 |
|
major version are exactly equal.</t> |
143 |
|
<t>The frontend's LSCP minor version is less or equal than |
144 |
|
the sampler's LSCP minor version.</t> |
145 |
|
</list> |
146 |
|
</t> |
147 |
|
<t> |
148 |
|
Compatibility can only be claimed if both rules are true. |
149 |
|
The frontend can use the |
150 |
|
<xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to |
151 |
|
get the version of the LSCP specification the sampler complies with. |
152 |
|
</t> |
153 |
|
</section> |
154 |
|
|
155 |
<section title="Introduction"> |
<section title="Introduction"> |
156 |
<t>LinuxSampler is a so called software sampler application |
<t>LinuxSampler is a so called software sampler application |
157 |
capable to playback audio samples from a computer's Random |
capable to playback audio samples from a computer's Random |
164 |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
165 |
sampler channel 17 could be connected to an ALSA sequencer |
sampler channel 17 could be connected to an ALSA sequencer |
166 |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
167 |
engine will be assigned an own instance of one of the available |
channel will be associated with an instance of one of the available |
168 |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
169 |
each sampler channel can be routed to an arbitrary audio output |
each sampler channel can be routed to an arbitrary audio output |
170 |
method (ALSA / JACK) and an arbitrary audio output channel |
method (ALSA / JACK) and an arbitrary audio output channel |
194 |
methods will be described next.</t> |
methods will be described next.</t> |
195 |
|
|
196 |
<section title="Request/response communication method"> |
<section title="Request/response communication method"> |
197 |
<t>This simple communication method is based on TCP. The |
<t>This simple communication method is based on |
198 |
|
<xref target="RFC793">TCP</xref>. The |
199 |
front-end application establishes a TCP connection to the |
front-end application establishes a TCP connection to the |
200 |
LinuxSampler instance on a certain host system. Then the |
LinuxSampler instance on a certain host system. Then the |
201 |
front-end application will send certain ASCII based commands |
front-end application will send certain ASCII based commands |
466 |
</section> |
</section> |
467 |
</section> |
</section> |
468 |
|
|
469 |
<section title="Description for control commands"> |
<section title="Description for control commands" anchor="control_commands"> |
470 |
<t>This chapter will describe the available control commands |
<t>This chapter will describe the available control commands |
471 |
that can be sent on the TCP connection in detail. Some certain |
that can be sent on the TCP connection in detail. Some certain |
472 |
commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref> |
commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref> |
724 |
|
|
725 |
<t>DEPENDS - |
<t>DEPENDS - |
726 |
<list> |
<list> |
727 |
<t>comma separated list of paramters this parameter depends |
<t>comma separated list of parameters this parameter depends |
728 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
729 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
730 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
837 |
</t> |
</t> |
838 |
|
|
839 |
<t>Where <audio-output-driver> should be replaced by the desired audio |
<t>Where <audio-output-driver> should be replaced by the desired audio |
840 |
output system and <param-list> by an optional list of driver |
output system as returned by the |
841 |
|
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> |
842 |
|
command and <param-list> by an optional list of driver |
843 |
specific parameters in form of "key1=val1 key2=val2 ...", where |
specific parameters in form of "key1=val1 key2=val2 ...", where |
844 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
845 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
1060 |
</list> |
</list> |
1061 |
</t> |
</t> |
1062 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
1063 |
audio output device, <key> by the name of the parameter to change |
audio output device as given by the |
1064 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1065 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1066 |
|
command, <key> by the name of the parameter to change |
1067 |
and <value> by the new value for this parameter.</t> |
and <value> by the new value for this parameter.</t> |
1068 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1069 |
<t> |
<t> |
1104 |
<t>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan></t> |
<t>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan></t> |
1105 |
</list> |
</list> |
1106 |
</t> |
</t> |
1107 |
<t>Where <device-id> is the numerical ID of the audio output device |
<t>Where <device-id> is the numerical ID of the audio output device as given by the |
1108 |
and <audio-chan> the audio channel number.</t> |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1109 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1110 |
|
command and <audio-chan> the audio channel number.</t> |
1111 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1112 |
<t> |
<t> |
1113 |
<list> |
<list> |
1206 |
</list> |
</list> |
1207 |
</t> |
</t> |
1208 |
|
|
1209 |
<t>Where <dev-id> is the numerical ID of the audio output device as returned |
<t>Where <dev-id> is the numerical ID of the audio output device as returned by the |
1210 |
by the <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1211 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1212 |
command, <chan> the audio channel number |
command, <chan> the audio channel number |
1213 |
and <param> a specific channel parameter name for which information should |
and <param> a specific channel parameter name for which information should |
1214 |
be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO"> |
be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO"> |
1310 |
<t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value></t> |
<t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value></t> |
1311 |
</list> |
</list> |
1312 |
</t> |
</t> |
1313 |
<t>Where <dev-id> should be replaced by the numerical ID of the audio |
<t>Where <dev-id> should be replaced by the numerical ID of the audio output device as returned by the |
1314 |
device, <chn> by the audio channel number, <key> by the name of the |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1315 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1316 |
|
command, <chn> by the audio channel number, <key> by the name of the |
1317 |
parameter to change and <value> by the new value for this parameter.</t> |
parameter to change and <value> by the new value for this parameter.</t> |
1318 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1319 |
<t> |
<t> |
1437 |
<t>GET MIDI_INPUT_DRIVER INFO <midi-input-driver></t> |
<t>GET MIDI_INPUT_DRIVER INFO <midi-input-driver></t> |
1438 |
</list> |
</list> |
1439 |
</t> |
</t> |
1440 |
<t>Where <midi-input-driver> is the name of the MIDI input driver.</t> |
<t>Where <midi-input-driver> is the name of the MIDI input driver as returned |
1441 |
|
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1442 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t> |
1443 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1444 |
<t> |
<t> |
1445 |
<list> |
<list> |
1494 |
</list> |
</list> |
1495 |
</t> |
</t> |
1496 |
|
|
1497 |
<t>Where <midi-t> is the name of the MIDI input driver as returned |
<t>Where <midit> is the name of the MIDI input driver as returned |
1498 |
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1499 |
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, <param> a specific |
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, <param> a specific |
1500 |
parameter name for which information should be obtained (as returned by the |
parameter name for which information should be obtained (as returned by the |
1567 |
|
|
1568 |
<t>DEPENDS - |
<t>DEPENDS - |
1569 |
<list> |
<list> |
1570 |
<t>comma separated list of paramters this parameter depends |
<t>comma separated list of parameters this parameter depends |
1571 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
1572 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
1573 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
1649 |
</list> |
</list> |
1650 |
</t> |
</t> |
1651 |
|
|
1652 |
<t>Where <midi-input-driver> should be replaced by the desired MIDI input system and <param-list> by an |
<t>Where <midi-input-driver> should be replaced by the desired MIDI input system as returned |
1653 |
|
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1654 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and <param-list> by an |
1655 |
optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where |
optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where |
1656 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
1657 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
1698 |
<t>DESTROY MIDI_INPUT_DEVICE <device-id></t> |
<t>DESTROY MIDI_INPUT_DEVICE <device-id></t> |
1699 |
</list> |
</list> |
1700 |
</t> |
</t> |
1701 |
<t>Where <device-id> should be replaced by the device's numerical ID.</t> |
<t>Where <device-id> should be replaced by the device's numerical ID as returned by the |
1702 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1703 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1704 |
|
command.</t> |
1705 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1706 |
<t> |
<t> |
1707 |
<list> |
<list> |
1793 |
<t>GET MIDI_INPUT_DEVICE INFO <device-id></t> |
<t>GET MIDI_INPUT_DEVICE INFO <device-id></t> |
1794 |
</list> |
</list> |
1795 |
</t> |
</t> |
1796 |
<t>Where <device-id> is the numerical ID of the MIDI input device.</t> |
<t>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
1797 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1798 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1799 |
|
command.</t> |
1800 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1801 |
<t> |
<t> |
1802 |
<list> |
<list> |
1861 |
</t> |
</t> |
1862 |
|
|
1863 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
1864 |
MIDI input device, <key> by the name of the parameter to change and |
MIDI input device as returned by the |
1865 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1866 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1867 |
|
command, <key> by the name of the parameter to change and |
1868 |
<value> by the new value for this parameter.</t> |
<value> by the new value for this parameter.</t> |
1869 |
|
|
1870 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1905 |
<t>GET MIDI_INPUT_PORT INFO <device-id> <midi-port></t> |
<t>GET MIDI_INPUT_PORT INFO <device-id> <midi-port></t> |
1906 |
</list> |
</list> |
1907 |
</t> |
</t> |
1908 |
<t>Where <device-id> is the numerical ID of the MIDI input device |
<t>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
1909 |
and <midi-port> the MIDI input port number.</t> |
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1910 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1911 |
|
command and <midi-port> the MIDI input port number.</t> |
1912 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1913 |
<t> |
<t> |
1914 |
<list> |
<list> |
1950 |
</list> |
</list> |
1951 |
</t> |
</t> |
1952 |
|
|
1953 |
<t>Where <dev-id> is the numerical ID of the MIDI input device as returned |
<t>Where <dev-id> is the numerical ID of the MIDI input device as returned by the |
1954 |
by the <xref target="LIST MIDI_INPUT_DEVICES"> |
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1955 |
"LIST MIDI_INPUT_DEVICES"</xref> command, <port> the MIDI port number and |
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1956 |
|
command, <port> the MIDI port number and |
1957 |
<param> a specific port parameter name for which information should be |
<param> a specific port parameter name for which information should be |
1958 |
obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO"> |
obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO"> |
1959 |
"GET MIDI_INPUT_PORT INFO"</xref> command).</t> |
"GET MIDI_INPUT_PORT INFO"</xref> command).</t> |
2056 |
</t> |
</t> |
2057 |
|
|
2058 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
2059 |
MIDI device, <port> by the MIDI port number, <key> by the name of |
MIDI device as returned by the |
2060 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
2061 |
|
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 |
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.</t> |
2065 |
|
|
2095 |
</section> |
</section> |
2096 |
|
|
2097 |
<section title="Configuring sampler channels"> |
<section title="Configuring sampler channels"> |
2098 |
<t>The following commands describe how to add and remove sampler channels, deploy |
<t>The following commands describe how to add and remove sampler channels, associate a |
2099 |
sampler engines, load instruments and connect sampler channels to MIDI and audio devices.</t> |
sampler channel with a sampler engine, load instruments and connect sampler channels to |
2100 |
|
MIDI and audio devices.</t> |
2101 |
|
|
2102 |
<section title="Loading an instrument" anchor="LOAD INSTRUMENT"> |
<section title="Loading an instrument" anchor="LOAD INSTRUMENT"> |
2103 |
<t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t> |
<t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t> |
2157 |
</section> |
</section> |
2158 |
|
|
2159 |
<section title="Loading a sampler engine" anchor="LOAD ENGINE"> |
<section title="Loading a sampler engine" anchor="LOAD ENGINE"> |
2160 |
<t>A sample engine can be deployed and assigned to a specific sampler |
<t>A sampler engine type can be associated to a specific sampler |
2161 |
channel by the following command:</t> |
channel by the following command:</t> |
2162 |
<t> |
<t> |
2163 |
<list> |
<list> |
2167 |
|
|
2168 |
<t>Where <engine-name> is an engine name as obtained by the |
<t>Where <engine-name> is an engine name as obtained by the |
2169 |
<xref target="LIST AVAILABLE_ENGINES"> |
<xref target="LIST AVAILABLE_ENGINES"> |
2170 |
"LIST AVAILABLE_ENGINES"</xref> command and <sampler-channel> the sampler channel the |
"LIST AVAILABLE_ENGINES"</xref> command and <sampler-channel> |
2171 |
deployed engine should be assigned to. Even if the respective |
the sampler channel as returned by the |
2172 |
sampler channel has already a deployed engine with that engine |
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or |
2173 |
name, a new engine instance will be assigned to the sampler channel.</t> |
<xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where |
2174 |
|
the engine type should be assigned to. This command should be issued |
2175 |
|
after adding a new sampler channel and before any other control |
2176 |
|
commands on the new sampler channel. It can also be used to change |
2177 |
|
the engine type of a sampler channel. This command has (currently) no |
2178 |
|
way to define or force if a new engine instance should be created and |
2179 |
|
assigned to the given sampler channel or if an already existing |
2180 |
|
instance of that engine type, shared with other sampler channels, |
2181 |
|
should be used.</t> |
2182 |
|
|
2183 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2184 |
<t> |
<t> |
2284 |
<list> |
<list> |
2285 |
<t>in case a new sampler channel could be added, where |
<t>in case a new sampler channel could be added, where |
2286 |
<sampler-channel> reflects the channel number of the new |
<sampler-channel> reflects the channel number of the new |
2287 |
created sampler channel which should the be used to set up |
created sampler channel which should be used to set up |
2288 |
the sampler channel by sending subsequent intialization |
the sampler channel by sending subsequent initialization |
2289 |
commands</t> |
commands</t> |
2290 |
</list> |
</list> |
2291 |
</t> |
</t> |
2320 |
</list> |
</list> |
2321 |
</t> |
</t> |
2322 |
|
|
2323 |
<t>This will decrement the sampler channel count by one and also |
<t>Where <sampler-channel> should be replaced by the |
2324 |
decrement the channel numbers of all subsequent sampler channels by |
number of the sampler channel as given by the |
2325 |
one.</t> |
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2326 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
2327 |
|
command. The channel numbers of all subsequent sampler channels |
2328 |
|
remain the same.</t> |
2329 |
|
|
2330 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2331 |
<t> |
<t> |
2390 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2391 |
<t> |
<t> |
2392 |
<list> |
<list> |
2393 |
<t>LinuxSampler will answer by sending a comma separated character |
<t>LinuxSampler will answer by sending a comma separated list |
2394 |
string of the engines' names. Engine names can consist of lower and |
of the engines' names encapsulated into apostrophes ('). |
2395 |
upper cases, digits and underlines ("_" character).</t> |
Engine names can consist of lower and upper cases, |
2396 |
|
digits and underlines ("_" character).</t> |
2397 |
</list> |
</list> |
2398 |
</t> |
</t> |
2399 |
<t>Example:</t> |
<t>Example:</t> |
2400 |
<t> |
<t> |
2401 |
<list> |
<list> |
2402 |
<t>C: "LIST AVAILABLE_ENGINES"</t> |
<t>C: "LIST AVAILABLE_ENGINES"</t> |
2403 |
<t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t> |
<t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t> |
2404 |
</list> |
</list> |
2405 |
</t> |
</t> |
2406 |
</section> |
</section> |
2463 |
<t>GET CHANNEL INFO <sampler-channel></t> |
<t>GET CHANNEL INFO <sampler-channel></t> |
2464 |
</list> |
</list> |
2465 |
</t> |
</t> |
2466 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in |
2467 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2468 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2469 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2470 |
<t> |
<t> |
2471 |
<list> |
<list> |
2479 |
<list> |
<list> |
2480 |
<t>ENGINE_NAME - |
<t>ENGINE_NAME - |
2481 |
<list> |
<list> |
2482 |
<t>name of the engine that is deployed on the sampler |
<t>name of the engine that is associated with the sampler |
2483 |
channel, "NONE" if there's no engine deployed yet for |
channel, "NONE" if there's no engine associated yet for |
2484 |
this sampler channel</t> |
this sampler channel</t> |
2485 |
</list> |
</list> |
2486 |
</t> |
</t> |
2555 |
<t>VOLUME - |
<t>VOLUME - |
2556 |
<list> |
<list> |
2557 |
<t>optionally dotted number for the channel volume factor |
<t>optionally dotted number for the channel volume factor |
2558 |
(where a value < 1.0 means attenuation and a value > |
(where a value < 1.0 means attenuation and a value > |
2559 |
1.0 means amplification)</t> |
1.0 means amplification)</t> |
2560 |
</list> |
</list> |
2561 |
</t> |
</t> |
2562 |
|
<t>MUTE - |
2563 |
|
<list> |
2564 |
|
<t>Determines whether the channel is muted, "true" if the |
2565 |
|
channel is muted, "false" if the channel is not muted, and |
2566 |
|
"MUTED_BY_SOLO" if the channel is muted because of the |
2567 |
|
presence of a solo channel and will be unmuted when |
2568 |
|
there are no solo channels left</t> |
2569 |
|
</list> |
2570 |
|
</t> |
2571 |
|
<t>SOLO - |
2572 |
|
<list> |
2573 |
|
<t>Determines whether this is a solo channel, "true" if |
2574 |
|
the channel is a solo channel; "false" otherwise</t> |
2575 |
|
</list> |
2576 |
|
</t> |
2577 |
|
<t>MIDI_INSTRUMENT_MAP - |
2578 |
|
<list> |
2579 |
|
<t>Determines to which MIDI instrument map this sampler |
2580 |
|
channel is assigned to. Read chapter |
2581 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
2582 |
|
for a list of possible values.</t> |
2583 |
|
</list> |
2584 |
|
</t> |
2585 |
</list> |
</list> |
2586 |
</t> |
</t> |
2587 |
</list> |
</list> |
2604 |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
2605 |
<t> "MIDI_INPUT_PORT: 0"</t> |
<t> "MIDI_INPUT_PORT: 0"</t> |
2606 |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
2607 |
|
<t> "VOLUME: 1.0"</t> |
2608 |
|
<t> "MUTE: false"</t> |
2609 |
|
<t> "SOLO: false"</t> |
2610 |
|
<t> "MIDI_INSTRUMENT_MAP: NONE"</t> |
2611 |
<t> "."</t> |
<t> "."</t> |
2612 |
</list> |
</list> |
2613 |
</t> |
</t> |
2621 |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
2622 |
</list> |
</list> |
2623 |
</t> |
</t> |
2624 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in |
2625 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2626 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2627 |
|
|
2628 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2629 |
<t> |
<t> |
2648 |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
2649 |
</list> |
</list> |
2650 |
</t> |
</t> |
2651 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in |
2652 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2653 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2654 |
|
|
2655 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2656 |
<t> |
<t> |
2684 |
</list> |
</list> |
2685 |
</t> |
</t> |
2686 |
<t>to get the fill state in percent, where <sampler-channel> is the |
<t>to get the fill state in percent, where <sampler-channel> is the |
2687 |
sampler channel number the front-end is interested in.</t> |
sampler channel number the front-end is interested in |
2688 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2689 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
2690 |
|
|
2691 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2692 |
<t> |
<t> |
2730 |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
2731 |
</list> |
</list> |
2732 |
</t> |
</t> |
2733 |
<t>Where <audio-device-id> is the numerical ID of the audio output |
<t>Where <sampler-channel> is the respective sampler channel |
2734 |
device and <sampler-channel> is the respective sampler channel |
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2735 |
number.</t> |
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
2736 |
|
<audio-device-id> is the numerical ID of the audio output device as given by the |
2737 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
2738 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
2739 |
|
command.</t> |
2740 |
|
|
2741 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2742 |
<t> |
<t> |
2768 |
</t> |
</t> |
2769 |
</section> |
</section> |
2770 |
|
|
2771 |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYP"> |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE"> |
2772 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
2773 |
|
|
2774 |
<t>The front-end can alter the audio output type on a specific sampler |
<t>The front-end can alter the audio output type on a specific sampler |
2819 |
<t>SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out> <audio-in></t> |
<t>SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out> <audio-in></t> |
2820 |
</list> |
</list> |
2821 |
</t> |
</t> |
2822 |
<t>Where <sampler-chan> is the sampler channel number, <audio-out> is the |
<t>Where <sampler-chan> is the sampler channel number |
2823 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2824 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, <audio-out> is the |
2825 |
numerical ID of the sampler channel's audio output channel which should be |
numerical ID of the sampler channel's audio output channel which should be |
2826 |
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
2827 |
output device where <audio-out> should be routed to.</t> |
output device where <audio-out> should be routed to.</t> |
2864 |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
2865 |
</list> |
</list> |
2866 |
</t> |
</t> |
2867 |
<t>Where <sampler-channel> is the sampler channel number and <midi-device-id> is the |
<t>Where <sampler-channel> is the sampler channel number |
2868 |
the numerical ID of the MIDI input device.</t> |
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2869 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command |
2870 |
|
and <midi-device-id> is the numerical ID of the MIDI input device as returned by the |
2871 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
2872 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t> |
2873 |
|
|
2874 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2875 |
<t> |
<t> |
2973 |
</t> |
</t> |
2974 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
2975 |
<list> |
<list> |
2976 |
<t>in case it failed, providing an appropriate error code and error messag</t> |
<t>in case it failed, providing an appropriate error code and error message</t> |
2977 |
</list> |
</list> |
2978 |
</t> |
</t> |
2979 |
</list> |
</list> |
3071 |
</t> |
</t> |
3072 |
</section> |
</section> |
3073 |
|
|
3074 |
|
<section title="Muting a sampler channel" anchor="SET CHANNEL MUTE"> |
3075 |
|
<t>The front-end can mute/unmute a specific sampler |
3076 |
|
channel by sending the following command:</t> |
3077 |
|
<t> |
3078 |
|
<list> |
3079 |
|
<t>SET CHANNEL MUTE <sampler-channel> <mute></t> |
3080 |
|
</list> |
3081 |
|
</t> |
3082 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3083 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3084 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
3085 |
|
<mute> should be replaced either by "1" to mute the channel or "0" |
3086 |
|
to unmute the channel.</t> |
3087 |
|
|
3088 |
|
<t>Possible Answers:</t> |
3089 |
|
<t> |
3090 |
|
<list> |
3091 |
|
<t>"OK" - |
3092 |
|
<list> |
3093 |
|
<t>on success</t> |
3094 |
|
</list> |
3095 |
|
</t> |
3096 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3097 |
|
<list> |
3098 |
|
<t>if the channel was muted/unmuted, but there are noteworthy |
3099 |
|
issue(s) related, providing an appropriate warning code and |
3100 |
|
warning message</t> |
3101 |
|
</list> |
3102 |
|
</t> |
3103 |
|
<t>"ERR:<error-code>:<error-message>" - |
3104 |
|
<list> |
3105 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3106 |
|
</list> |
3107 |
|
</t> |
3108 |
|
</list> |
3109 |
|
</t> |
3110 |
|
<t>Examples:</t> |
3111 |
|
<t> |
3112 |
|
<list> |
3113 |
|
<t></t> |
3114 |
|
</list> |
3115 |
|
</t> |
3116 |
|
</section> |
3117 |
|
|
3118 |
|
<section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO"> |
3119 |
|
<t>The front-end can solo/unsolo a specific sampler channel |
3120 |
|
by sending the following command:</t> |
3121 |
|
<t> |
3122 |
|
<list> |
3123 |
|
<t>SET CHANNEL SOLO <sampler-channel> <solo></t> |
3124 |
|
</list> |
3125 |
|
</t> |
3126 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3127 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3128 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
3129 |
|
<solo> should be replaced either by "1" to solo the channel or "0" |
3130 |
|
to unsolo the channel.</t> |
3131 |
|
|
3132 |
|
<t>Possible Answers:</t> |
3133 |
|
<t> |
3134 |
|
<list> |
3135 |
|
<t>"OK" - |
3136 |
|
<list> |
3137 |
|
<t>on success</t> |
3138 |
|
</list> |
3139 |
|
</t> |
3140 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3141 |
|
<list> |
3142 |
|
<t>if the channel was soloed/unsoloed, but there are noteworthy |
3143 |
|
issue(s) related, providing an appropriate warning code and |
3144 |
|
warning message</t> |
3145 |
|
</list> |
3146 |
|
</t> |
3147 |
|
<t>"ERR:<error-code>:<error-message>" - |
3148 |
|
<list> |
3149 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3150 |
|
</list> |
3151 |
|
</t> |
3152 |
|
</list> |
3153 |
|
</t> |
3154 |
|
<t>Examples:</t> |
3155 |
|
<t> |
3156 |
|
<list> |
3157 |
|
<t></t> |
3158 |
|
</list> |
3159 |
|
</t> |
3160 |
|
</section> |
3161 |
|
|
3162 |
|
<section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP"> |
3163 |
|
<t>The front-end can assign a MIDI instrument map to a specific sampler channel |
3164 |
|
by sending the following command:</t> |
3165 |
|
<t> |
3166 |
|
<list> |
3167 |
|
<t>SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map></t> |
3168 |
|
</list> |
3169 |
|
</t> |
3170 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3171 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3172 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
3173 |
|
<map> can have the following possibilites:</t> |
3174 |
|
<t> |
3175 |
|
<list> |
3176 |
|
<t>"NONE" - |
3177 |
|
<list> |
3178 |
|
<t>This is the default setting. In this case |
3179 |
|
the sampler channel is not assigned any MIDI |
3180 |
|
instrument map and thus will ignore all MIDI |
3181 |
|
program change messages.</t> |
3182 |
|
</list> |
3183 |
|
</t> |
3184 |
|
<t>"DEFAULT" - |
3185 |
|
<list> |
3186 |
|
<t>The sampler channel will always use the |
3187 |
|
default MIDI instrument map to handle MIDI |
3188 |
|
program change messages.</t> |
3189 |
|
</list> |
3190 |
|
</t> |
3191 |
|
<t>numeric ID - |
3192 |
|
<list> |
3193 |
|
<t>You can assign a specific MIDI instrument map |
3194 |
|
by replacing <map> with the respective numeric |
3195 |
|
ID of the MIDI instrument map as returned by the |
3196 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
3197 |
|
command. Once that map will be deleted, the sampler |
3198 |
|
channel would fall back to "NONE".</t> |
3199 |
|
</list> |
3200 |
|
</t> |
3201 |
|
</list> |
3202 |
|
</t> |
3203 |
|
<t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref> |
3204 |
|
for details regarding MIDI instrument mapping.</t> |
3205 |
|
|
3206 |
|
<t>Possible Answers:</t> |
3207 |
|
<t> |
3208 |
|
<list> |
3209 |
|
<t>"OK" - |
3210 |
|
<list> |
3211 |
|
<t>on success</t> |
3212 |
|
</list> |
3213 |
|
</t> |
3214 |
|
<t>"ERR:<error-code>:<error-message>" - |
3215 |
|
<list> |
3216 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3217 |
|
</list> |
3218 |
|
</t> |
3219 |
|
</list> |
3220 |
|
</t> |
3221 |
|
|
3222 |
|
<t>Examples:</t> |
3223 |
|
<t> |
3224 |
|
<list> |
3225 |
|
<t></t> |
3226 |
|
</list> |
3227 |
|
</t> |
3228 |
|
</section> |
3229 |
|
|
3230 |
|
<section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND"> |
3231 |
|
<t>The front-end can create an additional effect send on a specific sampler channel |
3232 |
|
by sending the following command:</t> |
3233 |
|
<t> |
3234 |
|
<list> |
3235 |
|
<t>CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]</t> |
3236 |
|
</list> |
3237 |
|
</t> |
3238 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3239 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3240 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the |
3241 |
|
sampler channel on which the effect send should be created on, <midi-ctrl> |
3242 |
|
is a number between 0..127 defining the MIDI controller which can alter the |
3243 |
|
effect send level and <name> is an optional argument defining a name |
3244 |
|
for the effect send entity. The name does not have to be unique.</t> |
3245 |
|
|
3246 |
|
<t>By default, that is as initial routing, the effect send's audio channels |
3247 |
|
are automatically routed to the last audio channels of the sampler channel's |
3248 |
|
audio output device, that way you can i.e. first increase the amount of audio |
3249 |
|
channels on the audio output device for having dedicated effect send output |
3250 |
|
channels and when "CREATE FX_SEND" is called, those channels will automatically |
3251 |
|
be picked. You can alter the destination channels however with |
3252 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>. |
3253 |
|
</t> |
3254 |
|
|
3255 |
|
<t>Note: Create effect sends on a sampler channel only when needed, because having effect |
3256 |
|
sends on a sampler channel will decrease runtime performance, because for implementing channel |
3257 |
|
effect sends, separate (sampler channel local) audio buffers are needed to render and mix |
3258 |
|
the voices and route the audio signal afterwards to the master outputs and effect send |
3259 |
|
outputs (along with their respective effect send levels). A sampler channel without effect |
3260 |
|
sends however can mix its voices directly into the audio output devices's audio buffers |
3261 |
|
and is thus faster. |
3262 |
|
</t> |
3263 |
|
|
3264 |
|
<t>Possible Answers:</t> |
3265 |
|
<t> |
3266 |
|
<list> |
3267 |
|
<t>"OK[<fx-send-id>]" - |
3268 |
|
<list> |
3269 |
|
<t>in case a new effect send could be added to the |
3270 |
|
sampler channel, where <fx-send-id> reflects the |
3271 |
|
unique ID of the newly created effect send entity</t> |
3272 |
|
</list> |
3273 |
|
</t> |
3274 |
|
<t>"ERR:<error-code>:<error-message>" - |
3275 |
|
<list> |
3276 |
|
<t>when a new effect send could not be added, i.e. |
3277 |
|
due to invalid parameters</t> |
3278 |
|
</list> |
3279 |
|
</t> |
3280 |
|
</list> |
3281 |
|
</t> |
3282 |
|
|
3283 |
|
<t>Examples:</t> |
3284 |
|
<t> |
3285 |
|
<list> |
3286 |
|
<t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t> |
3287 |
|
<t>S: "OK[0]"</t> |
3288 |
|
</list> |
3289 |
|
</t> |
3290 |
|
<t> |
3291 |
|
<list> |
3292 |
|
<t>C: "CREATE FX_SEND 0 93"</t> |
3293 |
|
<t>S: "OK[1]"</t> |
3294 |
|
</list> |
3295 |
|
</t> |
3296 |
|
</section> |
3297 |
|
|
3298 |
|
<section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND"> |
3299 |
|
<t>The front-end can remove an existing effect send on a specific sampler channel |
3300 |
|
by sending the following command:</t> |
3301 |
|
<t> |
3302 |
|
<list> |
3303 |
|
<t>DESTROY FX_SEND <sampler-channel> <fx-send-id></t> |
3304 |
|
</list> |
3305 |
|
</t> |
3306 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3307 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3308 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the |
3309 |
|
sampler channel from which the effect send should be removed from and |
3310 |
|
<fx-send-id> is the respective effect send number as returned by the |
3311 |
|
<xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3312 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t> |
3313 |
|
|
3314 |
|
<t>Possible Answers:</t> |
3315 |
|
<t> |
3316 |
|
<list> |
3317 |
|
<t>"OK" - |
3318 |
|
<list> |
3319 |
|
<t>on success</t> |
3320 |
|
</list> |
3321 |
|
</t> |
3322 |
|
<t>"ERR:<error-code>:<error-message>" - |
3323 |
|
<list> |
3324 |
|
<t>in case it failed, providing an appropriate error code and |
3325 |
|
error message</t> |
3326 |
|
</list> |
3327 |
|
</t> |
3328 |
|
</list> |
3329 |
|
</t> |
3330 |
|
|
3331 |
|
<t>Example:</t> |
3332 |
|
<t> |
3333 |
|
<list> |
3334 |
|
<t>C: "DESTROY FX_SEND 0 0"</t> |
3335 |
|
<t>S: "OK"</t> |
3336 |
|
</list> |
3337 |
|
</t> |
3338 |
|
</section> |
3339 |
|
|
3340 |
|
<section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS"> |
3341 |
|
<t>The front-end can ask for the amount of effect sends on a specific sampler channel |
3342 |
|
by sending the following command:</t> |
3343 |
|
<t> |
3344 |
|
<list> |
3345 |
|
<t>GET FX_SENDS <sampler-channel></t> |
3346 |
|
</list> |
3347 |
|
</t> |
3348 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3349 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3350 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
3351 |
|
|
3352 |
|
<t>Possible Answers:</t> |
3353 |
|
<t> |
3354 |
|
<list> |
3355 |
|
<t>The sampler will answer by returning the number of effect |
3356 |
|
sends on the given sampler channel.</t> |
3357 |
|
</list> |
3358 |
|
</t> |
3359 |
|
|
3360 |
|
<t>Example:</t> |
3361 |
|
<t> |
3362 |
|
<list> |
3363 |
|
<t>C: "GET FX_SENDS 0"</t> |
3364 |
|
<t>S: "2"</t> |
3365 |
|
</list> |
3366 |
|
</t> |
3367 |
|
</section> |
3368 |
|
|
3369 |
|
<section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS"> |
3370 |
|
<t>The front-end can ask for a list of effect sends on a specific sampler channel |
3371 |
|
by sending the following command:</t> |
3372 |
|
<t> |
3373 |
|
<list> |
3374 |
|
<t>LIST FX_SENDS <sampler-channel></t> |
3375 |
|
</list> |
3376 |
|
</t> |
3377 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3378 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3379 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
3380 |
|
|
3381 |
|
<t>Possible Answers:</t> |
3382 |
|
<t> |
3383 |
|
<list> |
3384 |
|
<t>The sampler will answer by returning a comma separated list |
3385 |
|
with all effect sends' numerical IDs on the given sampler |
3386 |
|
channel.</t> |
3387 |
|
</list> |
3388 |
|
</t> |
3389 |
|
|
3390 |
|
<t>Examples:</t> |
3391 |
|
<t> |
3392 |
|
<list> |
3393 |
|
<t>C: "LIST FX_SENDS 0"</t> |
3394 |
|
<t>S: "0,1"</t> |
3395 |
|
</list> |
3396 |
|
</t> |
3397 |
|
<t> |
3398 |
|
<list> |
3399 |
|
<t>C: "LIST FX_SENDS 1"</t> |
3400 |
|
<t>S: ""</t> |
3401 |
|
</list> |
3402 |
|
</t> |
3403 |
|
</section> |
3404 |
|
|
3405 |
|
<section title="Getting effect send information" anchor="GET FX_SEND INFO"> |
3406 |
|
<t>The front-end can ask for the current settings of an effect send entity |
3407 |
|
by sending the following command:</t> |
3408 |
|
<t> |
3409 |
|
<list> |
3410 |
|
<t>GET FX_SEND INFO <sampler-channel> <fx-send-id></t> |
3411 |
|
</list> |
3412 |
|
</t> |
3413 |
|
<t>Where <sampler-channel> is the sampler channel number |
3414 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3415 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
3416 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3417 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3418 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command. |
3419 |
|
</t> |
3420 |
|
|
3421 |
|
<t>Possible Answers:</t> |
3422 |
|
<t> |
3423 |
|
<list> |
3424 |
|
<t>The sampler will answer by sending a <CRLF> separated list. |
3425 |
|
Each answer line begins with the settings category name |
3426 |
|
followed by a colon and then a space character <SP> and finally |
3427 |
|
the info character string to that setting category. At the |
3428 |
|
moment the following categories are defined:</t> |
3429 |
|
|
3430 |
|
<t> |
3431 |
|
<list> |
3432 |
|
<t>NAME - |
3433 |
|
<list> |
3434 |
|
<t>name of the effect send entity</t> |
3435 |
|
</list> |
3436 |
|
</t> |
3437 |
|
<t>MIDI_CONTROLLER - |
3438 |
|
<list> |
3439 |
|
<t>a value between 0 and 127 reflecting the MIDI controller |
3440 |
|
which is able to modify the effect send's send level</t> |
3441 |
|
</list> |
3442 |
|
</t> |
3443 |
|
<t>LEVEL - |
3444 |
|
<list> |
3445 |
|
<t>optionally dotted number reflecting the effect send's |
3446 |
|
current send level (where a value < 1.0 means attenuation |
3447 |
|
and a value > 1.0 means amplification)</t> |
3448 |
|
</list> |
3449 |
|
</t> |
3450 |
|
<t>AUDIO_OUTPUT_ROUTING - |
3451 |
|
<list> |
3452 |
|
<t>comma separated list which reflects to which audio |
3453 |
|
channel of the selected audio output device each |
3454 |
|
effect send output channel is routed to, e.g. "0,3" would |
3455 |
|
mean the effect send's output channel 0 is routed to channel |
3456 |
|
0 of the audio output device and the effect send's output |
3457 |
|
channel 1 is routed to the channel 3 of the audio |
3458 |
|
output device (see |
3459 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
3460 |
|
for details)</t> |
3461 |
|
</list> |
3462 |
|
</t> |
3463 |
|
</list> |
3464 |
|
</t> |
3465 |
|
</list> |
3466 |
|
</t> |
3467 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
3468 |
|
|
3469 |
|
<t>Example:</t> |
3470 |
|
<t> |
3471 |
|
<list> |
3472 |
|
<t>C: "GET FX_SEND INFO 0 0"</t> |
3473 |
|
<t>S: "NAME: Reverb Send"</t> |
3474 |
|
<t> "MIDI_CONTROLLER: 91"</t> |
3475 |
|
<t> "LEVEL: 0.3"</t> |
3476 |
|
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
3477 |
|
<t> "."</t> |
3478 |
|
</list> |
3479 |
|
</t> |
3480 |
|
</section> |
3481 |
|
|
3482 |
|
<section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL"> |
3483 |
|
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
3484 |
|
sampler channel by sending the following command:</t> |
3485 |
|
<t> |
3486 |
|
<list> |
3487 |
|
<t>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst></t> |
3488 |
|
</list> |
3489 |
|
</t> |
3490 |
|
<t>Where <sampler-chan> is the sampler channel number |
3491 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3492 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3493 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3494 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3495 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
3496 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
3497 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
3498 |
|
the audio channel of the selected audio output device where <audio-src> |
3499 |
|
should be routed to.</t> |
3500 |
|
|
3501 |
|
<t>Note that effect sends can only route audio to the same audio output |
3502 |
|
device as assigned to the effect send's sampler channel. Also note that an |
3503 |
|
effect send entity does always have exactly as much audio channels as its |
3504 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
3505 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
3506 |
|
channels on a sampler channel might be dependant not only to the deployed |
3507 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
3508 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
3509 |
|
send into a mono one by simply altering its audio routing appropriately.</t> |
3510 |
|
|
3511 |
|
<t>Possible Answers:</t> |
3512 |
|
<t> |
3513 |
|
<list> |
3514 |
|
<t>"OK" - |
3515 |
|
<list> |
3516 |
|
<t>on success</t> |
3517 |
|
</list> |
3518 |
|
</t> |
3519 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3520 |
|
<list> |
3521 |
|
<t>if audio output channel was set, but there are noteworthy |
3522 |
|
issue(s) related, providing an appropriate warning code and |
3523 |
|
warning message</t> |
3524 |
|
</list> |
3525 |
|
</t> |
3526 |
|
<t>"ERR:<error-code>:<error-message>" - |
3527 |
|
<list> |
3528 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3529 |
|
</list> |
3530 |
|
</t> |
3531 |
|
</list> |
3532 |
|
</t> |
3533 |
|
<t>Example:</t> |
3534 |
|
<t> |
3535 |
|
<list> |
3536 |
|
<t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t> |
3537 |
|
<t>S: "OK"</t> |
3538 |
|
</list> |
3539 |
|
</t> |
3540 |
|
</section> |
3541 |
|
|
3542 |
|
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
3543 |
|
<t>The front-end can alter the MIDI controller of an effect |
3544 |
|
send entity by sending the following command:</t> |
3545 |
|
<t> |
3546 |
|
<list> |
3547 |
|
<t>SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl></t> |
3548 |
|
</list> |
3549 |
|
</t> |
3550 |
|
<t>Where <sampler-chan> is the sampler channel number |
3551 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3552 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3553 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3554 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3555 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3556 |
|
<midi-ctrl> reflects the MIDI controller which shall be |
3557 |
|
able to modify the effect send's send level.</t> |
3558 |
|
|
3559 |
|
<t>Possible Answers:</t> |
3560 |
|
<t> |
3561 |
|
<list> |
3562 |
|
<t>"OK" - |
3563 |
|
<list> |
3564 |
|
<t>on success</t> |
3565 |
|
</list> |
3566 |
|
</t> |
3567 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3568 |
|
<list> |
3569 |
|
<t>if MIDI controller was set, but there are noteworthy |
3570 |
|
issue(s) related, providing an appropriate warning code and |
3571 |
|
warning message</t> |
3572 |
|
</list> |
3573 |
|
</t> |
3574 |
|
<t>"ERR:<error-code>:<error-message>" - |
3575 |
|
<list> |
3576 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3577 |
|
</list> |
3578 |
|
</t> |
3579 |
|
</list> |
3580 |
|
</t> |
3581 |
|
<t>Example:</t> |
3582 |
|
<t> |
3583 |
|
<list> |
3584 |
|
<t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t> |
3585 |
|
<t>S: "OK"</t> |
3586 |
|
</list> |
3587 |
|
</t> |
3588 |
|
</section> |
3589 |
|
|
3590 |
|
<section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL"> |
3591 |
|
<t>The front-end can alter the current send level of an effect |
3592 |
|
send entity by sending the following command:</t> |
3593 |
|
<t> |
3594 |
|
<list> |
3595 |
|
<t>SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume></t> |
3596 |
|
</list> |
3597 |
|
</t> |
3598 |
|
<t>Where <sampler-chan> is the sampler channel number |
3599 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3600 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3601 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3602 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3603 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3604 |
|
<volume> is an optionally dotted positive number (a value |
3605 |
|
smaller than 1.0 means attenuation, whereas a value greater than |
3606 |
|
1.0 means amplification) reflecting the new send level.</t> |
3607 |
|
|
3608 |
|
<t>Possible Answers:</t> |
3609 |
|
<t> |
3610 |
|
<list> |
3611 |
|
<t>"OK" - |
3612 |
|
<list> |
3613 |
|
<t>on success</t> |
3614 |
|
</list> |
3615 |
|
</t> |
3616 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3617 |
|
<list> |
3618 |
|
<t>if new send level was set, but there are noteworthy |
3619 |
|
issue(s) related, providing an appropriate warning code and |
3620 |
|
warning message</t> |
3621 |
|
</list> |
3622 |
|
</t> |
3623 |
|
<t>"ERR:<error-code>:<error-message>" - |
3624 |
|
<list> |
3625 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3626 |
|
</list> |
3627 |
|
</t> |
3628 |
|
</list> |
3629 |
|
</t> |
3630 |
|
<t>Example:</t> |
3631 |
|
<t> |
3632 |
|
<list> |
3633 |
|
<t>C: "SET FX_SEND LEVEL 0 0 0.15"</t> |
3634 |
|
<t>S: "OK"</t> |
3635 |
|
</list> |
3636 |
|
</t> |
3637 |
|
</section> |
3638 |
|
|
3639 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3640 |
<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> |
3641 |
<t> |
<t> |
3821 |
<section title="Global commands"> |
<section title="Global commands"> |
3822 |
<t>The following commands have global impact on the sampler.</t> |
<t>The following commands have global impact on the sampler.</t> |
3823 |
|
|
3824 |
|
<section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT"> |
3825 |
|
<t>The front-end can ask for the current number of active voices on |
3826 |
|
the sampler by sending the following command:</t> |
3827 |
|
<t> |
3828 |
|
<list> |
3829 |
|
<t>GET TOTAL_VOICE_COUNT</t> |
3830 |
|
</list> |
3831 |
|
</t> |
3832 |
|
|
3833 |
|
<t>Possible Answers:</t> |
3834 |
|
<t> |
3835 |
|
<list> |
3836 |
|
<t>LinuxSampler will answer by returning the number of all active |
3837 |
|
voices on the sampler.</t> |
3838 |
|
</list> |
3839 |
|
</t> |
3840 |
|
</section> |
3841 |
|
|
3842 |
|
<section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX"> |
3843 |
|
<t>The front-end can ask for the maximum number of active voices |
3844 |
|
by sending the following command:</t> |
3845 |
|
<t> |
3846 |
|
<list> |
3847 |
|
<t>GET TOTAL_VOICE_COUNT_MAX</t> |
3848 |
|
</list> |
3849 |
|
</t> |
3850 |
|
|
3851 |
|
<t>Possible Answers:</t> |
3852 |
|
<t> |
3853 |
|
<list> |
3854 |
|
<t>LinuxSampler will answer by returning the maximum number |
3855 |
|
of active voices.</t> |
3856 |
|
</list> |
3857 |
|
</t> |
3858 |
|
</section> |
3859 |
|
|
3860 |
<section title="Reset sampler" anchor="RESET"> |
<section title="Reset sampler" anchor="RESET"> |
3861 |
<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> |
3862 |
<t> |
<t> |
3882 |
</list> |
</list> |
3883 |
</t> |
</t> |
3884 |
</section> |
</section> |
3885 |
|
|
3886 |
|
<section title="General sampler informations" anchor="GET SERVER INFO"> |
3887 |
|
<t>The client can ask for general informations about the LinuxSampler |
3888 |
|
instance by sending the following command:</t> |
3889 |
|
<t> |
3890 |
|
<list> |
3891 |
|
<t>GET SERVER INFO</t> |
3892 |
|
</list> |
3893 |
|
</t> |
3894 |
|
<t>Possible Answers:</t> |
3895 |
|
<t> |
3896 |
|
<list> |
3897 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
3898 |
|
Each answer line begins with the information category name |
3899 |
|
followed by a colon and then a space character <SP> and finally |
3900 |
|
the info character string to that information category. At the |
3901 |
|
moment the following categories are defined: |
3902 |
|
</t> |
3903 |
|
<t> |
3904 |
|
<list> |
3905 |
|
<t>DESCRIPTION - |
3906 |
|
<list> |
3907 |
|
<t>arbitrary textual description about the sampler</t> |
3908 |
|
</list> |
3909 |
|
</t> |
3910 |
|
<t>VERSION - |
3911 |
|
<list> |
3912 |
|
<t>version of the sampler</t> |
3913 |
|
</list> |
3914 |
|
</t> |
3915 |
|
<t>PROTOCOL_VERSION - |
3916 |
|
<list> |
3917 |
|
<t>version of the LSCP specification the sampler |
3918 |
|
complies with (see <xref target="LSCP versioning" /> for details)</t> |
3919 |
|
</list> |
3920 |
|
</t> |
3921 |
|
</list> |
3922 |
|
</t> |
3923 |
|
</list> |
3924 |
|
</t> |
3925 |
|
<t>The mentioned fields above don't have to be in particular order. |
3926 |
|
Other fields might be added in future.</t> |
3927 |
|
</section> |
3928 |
|
|
3929 |
|
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
3930 |
|
<t>The client can ask for the current global sampler-wide volume |
3931 |
|
attenuation by sending the following command:</t> |
3932 |
|
<t> |
3933 |
|
<list> |
3934 |
|
<t>GET VOLUME</t> |
3935 |
|
</list> |
3936 |
|
</t> |
3937 |
|
<t>Possible Answers:</t> |
3938 |
|
<t> |
3939 |
|
<list> |
3940 |
|
<t>The sampler will always answer by returning the optional |
3941 |
|
dotted floating point coefficient, reflecting the current |
3942 |
|
global volume attenuation. |
3943 |
|
</t> |
3944 |
|
</list> |
3945 |
|
</t> |
3946 |
|
<t>Note: it is up to the respective sampler engine whether to obey |
3947 |
|
that global volume parameter or not, but in general all engines SHOULD |
3948 |
|
use this parameter.</t> |
3949 |
|
</section> |
3950 |
|
|
3951 |
|
<section title="Setting global volume attenuation" anchor="SET VOLUME"> |
3952 |
|
<t>The client can alter the current global sampler-wide volume |
3953 |
|
attenuation by sending the following command:</t> |
3954 |
|
<t> |
3955 |
|
<list> |
3956 |
|
<t>SET VOLUME <volume></t> |
3957 |
|
</list> |
3958 |
|
</t> |
3959 |
|
<t>Where <volume> should be replaced by the optional dotted |
3960 |
|
floating point value, reflecting the new global volume parameter. |
3961 |
|
This value might usually be in the range between 0.0 and 1.0, that |
3962 |
|
is for attenuating the overall volume.</t> |
3963 |
|
|
3964 |
|
<t>Possible Answers:</t> |
3965 |
|
<t> |
3966 |
|
<list> |
3967 |
|
<t>"OK" - |
3968 |
|
<list> |
3969 |
|
<t>on success</t> |
3970 |
|
</list> |
3971 |
|
</t> |
3972 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3973 |
|
<list> |
3974 |
|
<t>if the global volume was set, but there are noteworthy |
3975 |
|
issue(s) related, providing an appropriate warning code and |
3976 |
|
warning message</t> |
3977 |
|
</list> |
3978 |
|
</t> |
3979 |
|
<t>"ERR:<error-code>:<error-message>" - |
3980 |
|
<list> |
3981 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3982 |
|
</list> |
3983 |
|
</t> |
3984 |
|
</list> |
3985 |
|
</t> |
3986 |
|
</section> |
3987 |
</section> |
</section> |
3988 |
|
|
3989 |
|
|
3990 |
|
<section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping"> |
3991 |
|
<t>The MIDI protocol provides a way to switch between instruments |
3992 |
|
by sending so called MIDI bank select and MIDI program change |
3993 |
|
messages which are essentially just numbers. The following commands |
3994 |
|
allow to actually map arbitrary MIDI bank select / program change |
3995 |
|
numbers with real instruments.</t> |
3996 |
|
<t>The sampler allows to manage an arbitrary amount of MIDI |
3997 |
|
instrument maps which define which instrument to load on |
3998 |
|
which MIDI program change message.</t> |
3999 |
|
<t>By default, that is when the sampler is launched, there is no |
4000 |
|
map, thus the sampler will simply ignore all program change |
4001 |
|
messages. The front-end has to explicitly create at least one |
4002 |
|
map, add entries to the map and tell the respective sampler |
4003 |
|
channel(s) which MIDI instrument map to use, so the sampler |
4004 |
|
knows how to react on a given program change message on the |
4005 |
|
respective sampler channel, that is by switching to the |
4006 |
|
respectively defined engine type and loading the respective |
4007 |
|
instrument. See command |
4008 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
4009 |
|
for how to assign a MIDI instrument map to a sampler channel.</t> |
4010 |
|
<t>Also note per MIDI specification a bank select message does not |
4011 |
|
cause to switch to another instrument. Instead when receiving a |
4012 |
|
bank select message the bank value will be stored and a subsequent |
4013 |
|
program change message (which may occur at any time) will finally |
4014 |
|
cause the sampler to switch to the respective instrument as |
4015 |
|
reflected by the current MIDI instrument map.</t> |
4016 |
|
|
4017 |
|
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP"> |
4018 |
|
<t>The front-end can add a new MIDI instrument map by sending |
4019 |
|
the following command:</t> |
4020 |
|
<t> |
4021 |
|
<list> |
4022 |
|
<t>ADD MIDI_INSTRUMENT_MAP [<name>]</t> |
4023 |
|
</list> |
4024 |
|
</t> |
4025 |
|
<t>Where <name> is an optional argument allowing to |
4026 |
|
assign a custom name to the new map. MIDI instrument Map |
4027 |
|
names do not have to be unique.</t> |
4028 |
|
|
4029 |
|
<t>Possible Answers:</t> |
4030 |
|
<t> |
4031 |
|
<list> |
4032 |
|
<t>"OK[<map>]" - |
4033 |
|
<list> |
4034 |
|
<t>in case a new MIDI instrument map could |
4035 |
|
be added, where <map> reflects the |
4036 |
|
unique ID of the newly created MIDI |
4037 |
|
instrument map</t> |
4038 |
|
</list> |
4039 |
|
</t> |
4040 |
|
<t>"ERR:<error-code>:<error-message>" - |
4041 |
|
<list> |
4042 |
|
<t>when a new map could not be created, which |
4043 |
|
might never occur in practice</t> |
4044 |
|
</list> |
4045 |
|
</t> |
4046 |
|
</list> |
4047 |
|
</t> |
4048 |
|
|
4049 |
|
<t>Examples:</t> |
4050 |
|
<t> |
4051 |
|
<list> |
4052 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t> |
4053 |
|
<t>S: "OK[0]"</t> |
4054 |
|
</list> |
4055 |
|
</t> |
4056 |
|
<t> |
4057 |
|
<list> |
4058 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t> |
4059 |
|
<t>S: "OK[1]"</t> |
4060 |
|
</list> |
4061 |
|
</t> |
4062 |
|
<t> |
4063 |
|
<list> |
4064 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP"</t> |
4065 |
|
<t>S: "OK[5]"</t> |
4066 |
|
</list> |
4067 |
|
</t> |
4068 |
|
</section> |
4069 |
|
|
4070 |
|
<section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP"> |
4071 |
|
<t>The front-end can delete a particular MIDI instrument map |
4072 |
|
by sending the following command:</t> |
4073 |
|
<t> |
4074 |
|
<list> |
4075 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP <map></t> |
4076 |
|
</list> |
4077 |
|
</t> |
4078 |
|
<t>Where <map> reflects the unique ID of the map to delete |
4079 |
|
as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
4080 |
|
command.</t> |
4081 |
|
<t>The front-end can delete all MIDI instrument maps by |
4082 |
|
sending the following command:</t> |
4083 |
|
<t> |
4084 |
|
<list> |
4085 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP ALL</t> |
4086 |
|
</list> |
4087 |
|
</t> |
4088 |
|
|
4089 |
|
<t>Possible Answers:</t> |
4090 |
|
<t> |
4091 |
|
<list> |
4092 |
|
<t>"OK" - |
4093 |
|
<list> |
4094 |
|
<t>in case the map(s) could be deleted</t> |
4095 |
|
</list> |
4096 |
|
</t> |
4097 |
|
<t>"ERR:<error-code>:<error-message>" - |
4098 |
|
<list> |
4099 |
|
<t>when the given map does not exist</t> |
4100 |
|
</list> |
4101 |
|
</t> |
4102 |
|
</list> |
4103 |
|
</t> |
4104 |
|
|
4105 |
|
<t>Examples:</t> |
4106 |
|
<t> |
4107 |
|
<list> |
4108 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t> |
4109 |
|
<t>S: "OK"</t> |
4110 |
|
</list> |
4111 |
|
</t> |
4112 |
|
<t> |
4113 |
|
<list> |
4114 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t> |
4115 |
|
<t>S: "OK"</t> |
4116 |
|
</list> |
4117 |
|
</t> |
4118 |
|
</section> |
4119 |
|
|
4120 |
|
<section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS"> |
4121 |
|
<t>The front-end can retrieve the current amount of MIDI |
4122 |
|
instrument maps by sending the following command:</t> |
4123 |
|
<t> |
4124 |
|
<list> |
4125 |
|
<t>GET MIDI_INSTRUMENT_MAPS</t> |
4126 |
|
</list> |
4127 |
|
</t> |
4128 |
|
|
4129 |
|
<t>Possible Answers:</t> |
4130 |
|
<t> |
4131 |
|
<list> |
4132 |
|
<t>The sampler will answer by returning the current |
4133 |
|
number of MIDI instrument maps.</t> |
4134 |
|
</list> |
4135 |
|
</t> |
4136 |
|
|
4137 |
|
<t>Example:</t> |
4138 |
|
<t> |
4139 |
|
<list> |
4140 |
|
<t>C: "GET MIDI_INSTRUMENT_MAPS"</t> |
4141 |
|
<t>S: "2"</t> |
4142 |
|
</list> |
4143 |
|
</t> |
4144 |
|
</section> |
4145 |
|
|
4146 |
|
<section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS"> |
4147 |
|
<t>The number of MIDI instrument maps can change on runtime. To get the |
4148 |
|
current list of MIDI instrument maps, the front-end can send the |
4149 |
|
following command:</t> |
4150 |
|
<t> |
4151 |
|
<list> |
4152 |
|
<t>LIST MIDI_INSTRUMENT_MAPS</t> |
4153 |
|
</list> |
4154 |
|
</t> |
4155 |
|
<t>Possible Answers:</t> |
4156 |
|
<t> |
4157 |
|
<list> |
4158 |
|
<t>The sampler will answer by returning a comma separated list |
4159 |
|
with all MIDI instrument maps' numerical IDs.</t> |
4160 |
|
</list> |
4161 |
|
</t> |
4162 |
|
<t>Example:</t> |
4163 |
|
<t> |
4164 |
|
<list> |
4165 |
|
<t>C: "LIST MIDI_INSTRUMENT_MAPS"</t> |
4166 |
|
<t>S: "0,1,5,12"</t> |
4167 |
|
</list> |
4168 |
|
</t> |
4169 |
|
</section> |
4170 |
|
|
4171 |
|
<section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO"> |
4172 |
|
<t>The front-end can ask for the current settings of a MIDI |
4173 |
|
instrument map by sending the following command:</t> |
4174 |
|
<t> |
4175 |
|
<list> |
4176 |
|
<t>GET MIDI_INSTRUMENT_MAP INFO <map></t> |
4177 |
|
</list> |
4178 |
|
</t> |
4179 |
|
<t>Where <map> is the numerical ID of the map the |
4180 |
|
front-end is interested in as returned by the |
4181 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
4182 |
|
command.</t> |
4183 |
|
|
4184 |
|
<t>Possible Answers:</t> |
4185 |
|
<t> |
4186 |
|
<list> |
4187 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
4188 |
|
Each answer line begins with the settings category name |
4189 |
|
followed by a colon and then a space character <SP> and finally |
4190 |
|
the info character string to that setting category. At the |
4191 |
|
moment the following categories are defined:</t> |
4192 |
|
|
4193 |
|
<t> |
4194 |
|
<list> |
4195 |
|
<t>NAME - |
4196 |
|
<list> |
4197 |
|
<t>custom name of the given map, |
4198 |
|
which does not have to be unique</t> |
4199 |
|
</list> |
4200 |
|
</t> |
4201 |
|
</list> |
4202 |
|
</t> |
4203 |
|
</list> |
4204 |
|
</t> |
4205 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
4206 |
|
|
4207 |
|
<t>Example:</t> |
4208 |
|
<t> |
4209 |
|
<list> |
4210 |
|
<t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t> |
4211 |
|
<t>S: "NAME: Standard Map"</t> |
4212 |
|
<t> "."</t> |
4213 |
|
</list> |
4214 |
|
</t> |
4215 |
|
</section> |
4216 |
|
|
4217 |
|
<section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME"> |
4218 |
|
<t>The front-end can alter the custom name of a MIDI |
4219 |
|
instrument map by sending the following command:</t> |
4220 |
|
<t> |
4221 |
|
<list> |
4222 |
|
<t>SET MIDI_INSTRUMENT_MAP NAME <map> <name></t> |
4223 |
|
</list> |
4224 |
|
</t> |
4225 |
|
<t>Where <map> is the numerical ID of the map and |
4226 |
|
<name> the new custom name of the map, which does not |
4227 |
|
have to be unique.</t> |
4228 |
|
|
4229 |
|
<t>Possible Answers:</t> |
4230 |
|
<t> |
4231 |
|
<list> |
4232 |
|
<t>"OK" - |
4233 |
|
<list> |
4234 |
|
<t>on success</t> |
4235 |
|
</list> |
4236 |
|
</t> |
4237 |
|
<t>"ERR:<error-code>:<error-message>" - |
4238 |
|
<list> |
4239 |
|
<t>in case the given map does not exist</t> |
4240 |
|
</list> |
4241 |
|
</t> |
4242 |
|
</list> |
4243 |
|
</t> |
4244 |
|
|
4245 |
|
<t>Example:</t> |
4246 |
|
<t> |
4247 |
|
<list> |
4248 |
|
<t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t> |
4249 |
|
<t>S: "OK"</t> |
4250 |
|
</list> |
4251 |
|
</t> |
4252 |
|
</section> |
4253 |
|
|
4254 |
|
<section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT"> |
4255 |
|
<t>The front-end can create a new or replace an existing entry |
4256 |
|
in a sampler's MIDI instrument map by sending the following |
4257 |
|
command:</t> |
4258 |
|
<t> |
4259 |
|
<list> |
4260 |
|
<t>MAP MIDI_INSTRUMENT [NON_MODAL] <map> |
4261 |
|
<midi_bank> <midi_prog> <engine_name> |
4262 |
|
<filename> <instrument_index> <volume_value> |
4263 |
|
[<instr_load_mode>] [<name>]</t> |
4264 |
|
</list> |
4265 |
|
</t> |
4266 |
|
<t>Where <map> is the numeric ID of the map to alter, |
4267 |
|
<midi_bank> is an integer value between |
4268 |
|
0..16383 reflecting the MIDI bank select index, |
4269 |
|
<midi_prog> an |
4270 |
|
integer value between 0..127 reflecting the MIDI program change |
4271 |
|
index, <engine_name> a sampler engine name as returned by |
4272 |
|
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
4273 |
|
command (not encapsulated into apostrophes), <filename> the name |
4274 |
|
of the instrument's file to be deployed (encapsulated into apostrophes), |
4275 |
|
<instrument_index> the index (integer value) of the instrument |
4276 |
|
within the given file, <volume_value> reflects the master |
4277 |
|
volume of the instrument as optionally dotted number (where a |
4278 |
|
value < 1.0 means attenuation and a value > 1.0 means |
4279 |
|
amplification). This parameter easily allows to adjust the |
4280 |
|
volume of all intruments within a custom instrument map |
4281 |
|
without having to adjust their instrument files. The |
4282 |
|
OPTIONAL <instr_load_mode> argument defines the life |
4283 |
|
time of the instrument, that is when the instrument should |
4284 |
|
be loaded, when freed and has exactly the following |
4285 |
|
possibilities:</t> |
4286 |
|
<t> |
4287 |
|
<list> |
4288 |
|
<t>"ON_DEMAND" - |
4289 |
|
<list> |
4290 |
|
<t>The instrument will be loaded when needed, |
4291 |
|
that is when demanded by at least one sampler |
4292 |
|
channel. It will immediately be freed from memory |
4293 |
|
when not needed by any sampler channel anymore.</t> |
4294 |
|
</list> |
4295 |
|
</t> |
4296 |
|
<t>"ON_DEMAND_HOLD" - |
4297 |
|
<list> |
4298 |
|
<t>The instrument will be loaded when needed, |
4299 |
|
that is when demanded by at least one sampler |
4300 |
|
channel. It will be kept in memory even when |
4301 |
|
not needed by any sampler channel anymore. |
4302 |
|
Instruments with this mode are only freed |
4303 |
|
when the sampler is reset or all mapping |
4304 |
|
entries with this mode (and respective |
4305 |
|
instrument) are explicitly changed to |
4306 |
|
"ON_DEMAND" and no sampler channel is using |
4307 |
|
the instrument anymore.</t> |
4308 |
|
</list> |
4309 |
|
</t> |
4310 |
|
<t>"PERSISTENT" - |
4311 |
|
<list> |
4312 |
|
<t>The instrument will immediately be loaded |
4313 |
|
into memory when this mapping |
4314 |
|
command is sent and the instrument is kept all |
4315 |
|
the time. Instruments with this mode are |
4316 |
|
only freed when the sampler is reset or all |
4317 |
|
mapping entries with this mode (and |
4318 |
|
respective instrument) are explicitly |
4319 |
|
changed to "ON_DEMAND" and no sampler |
4320 |
|
channel is using the instrument anymore.</t> |
4321 |
|
</list> |
4322 |
|
</t> |
4323 |
|
<t>not supplied - |
4324 |
|
<list> |
4325 |
|
<t>In case there is no <instr_load_mode> |
4326 |
|
argument given, it will be up to the |
4327 |
|
InstrumentManager to decide which mode to use. |
4328 |
|
Usually it will use "ON_DEMAND" if an entry |
4329 |
|
for the given instrument does not exist in |
4330 |
|
the InstrumentManager's list yet, otherwise |
4331 |
|
if an entry already exists, it will simply |
4332 |
|
stick with the mode currently reflected by |
4333 |
|
the already existing entry, that is it will |
4334 |
|
not change the mode.</t> |
4335 |
|
</list> |
4336 |
|
</t> |
4337 |
|
</list> |
4338 |
|
</t> |
4339 |
|
<t> |
4340 |
|
The <instr_load_mode> argument thus allows to define an |
4341 |
|
appropriate strategy (low memory consumption vs. fast |
4342 |
|
instrument switching) for each instrument individually. Note, the |
4343 |
|
following restrictions apply to this argument: "ON_DEMAND_HOLD" and |
4344 |
|
"PERSISTENT" have to be supported by the respective sampler engine |
4345 |
|
(which is technically the case when the engine provides an |
4346 |
|
InstrumentManager for its format). If this is not the case the |
4347 |
|
argument will automatically fall back to the default value |
4348 |
|
"ON_DEMAND". Also the load mode of one instrument may |
4349 |
|
automatically change the laod mode of other instrument(s), i.e. |
4350 |
|
because the instruments are part of the same file and the |
4351 |
|
engine does not allow a way to manage load modes for them |
4352 |
|
individually. Due to this, in case the frontend shows the |
4353 |
|
load modes of entries, the frontend should retrieve the actual |
4354 |
|
mode by i.e. sending |
4355 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4356 |
|
command(s). Finally the OPTIONAL <name> argument allows to |
4357 |
|
set a custom name (encapsulated into apostrophes) for the mapping |
4358 |
|
entry, useful for frontends for displaying an appropriate name for |
4359 |
|
mapped instruments (using |
4360 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
4361 |
|
</t> |
4362 |
|
<t> |
4363 |
|
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
4364 |
|
completely established in the sampler. The OPTIONAL "NON_MODAL" argument |
4365 |
|
however causes the respective "MAP MIDI_INSTRUMENT" command to return |
4366 |
|
immediately, that is to let the sampler establish the mapping in the |
4367 |
|
background. So this argument might be especially useful for mappings with |
4368 |
|
a "PERSISTENT" type, because these have to load the respective instruments |
4369 |
|
immediately and might thus block for a very long time. It is recommended |
4370 |
|
however to use the OPTIONAL "NON_MODAL" argument only if really necessary, |
4371 |
|
because it has the following drawbacks: as "NON_MODAL" instructions return |
4372 |
|
immediately, they may not necessarily return an error i.e. when the given |
4373 |
|
instrument file turns out to be corrupt, beside that subsequent commands |
4374 |
|
in a LSCP instruction sequence might fail, because mandatory mappings are |
4375 |
|
not yet completed. |
4376 |
|
</t> |
4377 |
|
|
4378 |
|
<t>Possible Answers:</t> |
4379 |
|
<t> |
4380 |
|
<list> |
4381 |
|
<t>"OK" - |
4382 |
|
<list> |
4383 |
|
<t>usually</t> |
4384 |
|
</list> |
4385 |
|
</t> |
4386 |
|
<t>"ERR:<error-code>:<error-message>" - |
4387 |
|
<list> |
4388 |
|
<t>when the given map or engine does not exist or a value |
4389 |
|
is out of range</t> |
4390 |
|
</list> |
4391 |
|
</t> |
4392 |
|
</list> |
4393 |
|
</t> |
4394 |
|
|
4395 |
|
<t>Examples:</t> |
4396 |
|
<t> |
4397 |
|
<list> |
4398 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t> |
4399 |
|
<t>S: "OK"</t> |
4400 |
|
</list> |
4401 |
|
</t> |
4402 |
|
<t> |
4403 |
|
<list> |
4404 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t> |
4405 |
|
<t>S: "OK"</t> |
4406 |
|
</list> |
4407 |
|
</t> |
4408 |
|
<t> |
4409 |
|
<list> |
4410 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t> |
4411 |
|
<t>S: "OK"</t> |
4412 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t> |
4413 |
|
<t>S: "OK"</t> |
4414 |
|
</list> |
4415 |
|
</t> |
4416 |
|
<t> |
4417 |
|
<list> |
4418 |
|
<t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t> |
4419 |
|
<t>S: "OK"</t> |
4420 |
|
</list> |
4421 |
|
</t> |
4422 |
|
</section> |
4423 |
|
|
4424 |
|
<section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS"> |
4425 |
|
<t>The front-end can query the amount of currently existing |
4426 |
|
entries in a MIDI instrument map by sending the following |
4427 |
|
command:</t> |
4428 |
|
<t> |
4429 |
|
<list> |
4430 |
|
<t>GET MIDI_INSTRUMENTS <map></t> |
4431 |
|
</list> |
4432 |
|
</t> |
4433 |
|
<t>The front-end can query the amount of currently existing |
4434 |
|
entries in all MIDI instrument maps by sending the following |
4435 |
|
command:</t> |
4436 |
|
<t> |
4437 |
|
<list> |
4438 |
|
<t>GET MIDI_INSTRUMENTS ALL</t> |
4439 |
|
</list> |
4440 |
|
</t> |
4441 |
|
<t>Possible Answers:</t> |
4442 |
|
<t> |
4443 |
|
<list> |
4444 |
|
<t>The sampler will answer by sending the current number of |
4445 |
|
entries in the MIDI instrument map(s).</t> |
4446 |
|
</list> |
4447 |
|
</t> |
4448 |
|
|
4449 |
|
<t>Example:</t> |
4450 |
|
<t> |
4451 |
|
<list> |
4452 |
|
<t>C: "GET MIDI_INSTRUMENTS 0"</t> |
4453 |
|
<t>S: "234"</t> |
4454 |
|
</list> |
4455 |
|
</t> |
4456 |
|
<t> |
4457 |
|
<list> |
4458 |
|
<t>C: "GET MIDI_INSTRUMENTS ALL"</t> |
4459 |
|
<t>S: "954"</t> |
4460 |
|
</list> |
4461 |
|
</t> |
4462 |
|
</section> |
4463 |
|
|
4464 |
|
<section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS"> |
4465 |
|
<t>The front-end can query a list of all currently existing |
4466 |
|
entries in a certain MIDI instrument map by sending the following |
4467 |
|
command:</t> |
4468 |
|
<t> |
4469 |
|
<list> |
4470 |
|
<t>LIST MIDI_INSTRUMENTS <map></t> |
4471 |
|
</list> |
4472 |
|
</t> |
4473 |
|
<t>Where <map> is the numeric ID of the MIDI instrument map.</t> |
4474 |
|
<t>The front-end can query a list of all currently existing |
4475 |
|
entries of all MIDI instrument maps by sending the following |
4476 |
|
command:</t> |
4477 |
|
<t> |
4478 |
|
<list> |
4479 |
|
<t>LIST MIDI_INSTRUMENTS ALL</t> |
4480 |
|
</list> |
4481 |
|
</t> |
4482 |
|
|
4483 |
|
<t>Possible Answers:</t> |
4484 |
|
<t> |
4485 |
|
<list> |
4486 |
|
<t>The sampler will answer by sending a comma separated |
4487 |
|
list of map ID - MIDI bank - MIDI program triples, where |
4488 |
|
each triple is encapsulated into curly braces. The |
4489 |
|
list is returned in one single line. Each triple |
4490 |
|
just reflects the key of the respective map entry, |
4491 |
|
thus subsequent |
4492 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4493 |
|
command(s) are necessary to retrieve detailed informations |
4494 |
|
about each entry.</t> |
4495 |
|
</list> |
4496 |
|
</t> |
4497 |
|
|
4498 |
|
<t>Example:</t> |
4499 |
|
<t> |
4500 |
|
<list> |
4501 |
|
<t>C: "LIST MIDI_INSTRUMENTS 0"</t> |
4502 |
|
<t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t> |
4503 |
|
</list> |
4504 |
|
</t> |
4505 |
|
</section> |
4506 |
|
|
4507 |
|
<section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT"> |
4508 |
|
<t>The front-end can delete an entry from a MIDI instrument |
4509 |
|
map by sending the following command:</t> |
4510 |
|
<t> |
4511 |
|
<list> |
4512 |
|
<t>UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog></t> |
4513 |
|
</list> |
4514 |
|
</t> |
4515 |
|
<t> |
4516 |
|
Where <map> is the numeric ID of the MIDI instrument map, |
4517 |
|
<midi_bank> is an integer value between 0..16383 |
4518 |
|
reflecting the MIDI bank value and |
4519 |
|
<midi_prog> an integer value between |
4520 |
|
0..127 reflecting the MIDI program value of the map's entrie's key |
4521 |
|
index triple. |
4522 |
|
</t> |
4523 |
|
|
4524 |
|
<t>Possible Answers:</t> |
4525 |
|
<t> |
4526 |
|
<list> |
4527 |
|
<t>"OK" - |
4528 |
|
<list> |
4529 |
|
<t>usually</t> |
4530 |
|
</list> |
4531 |
|
</t> |
4532 |
|
<t>"ERR:<error-code>:<error-message>" - |
4533 |
|
<list> |
4534 |
|
<t>when index out of bounds</t> |
4535 |
|
</list> |
4536 |
|
</t> |
4537 |
|
</list> |
4538 |
|
</t> |
4539 |
|
|
4540 |
|
<t>Example:</t> |
4541 |
|
<t> |
4542 |
|
<list> |
4543 |
|
<t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t> |
4544 |
|
<t>S: "OK"</t> |
4545 |
|
</list> |
4546 |
|
</t> |
4547 |
|
</section> |
4548 |
|
|
4549 |
|
<section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO"> |
4550 |
|
<t>The front-end can retrieve the current settings of a certain |
4551 |
|
instrument map entry by sending the following command:</t> |
4552 |
|
<t> |
4553 |
|
<list> |
4554 |
|
<t>GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog></t> |
4555 |
|
</list> |
4556 |
|
</t> |
4557 |
|
<t> |
4558 |
|
Where <map> is the numeric ID of the MIDI instrument map, |
4559 |
|
<midi_bank> is an integer value between 0..16383 |
4560 |
|
reflecting the MIDI bank value, <midi_bank> |
4561 |
|
and <midi_prog> an integer value between |
4562 |
|
0..127 reflecting the MIDI program value of the map's entrie's key |
4563 |
|
index triple. |
4564 |
|
</t> |
4565 |
|
|
4566 |
|
<t>Possible Answers:</t> |
4567 |
|
<t> |
4568 |
|
<list> |
4569 |
|
<t>LinuxSampler will answer by sending a <CRLF> |
4570 |
|
separated list. Each answer line begins with the |
4571 |
|
information category name followed by a colon and then |
4572 |
|
a space character <SP> and finally the info |
4573 |
|
character string to that info category. At the moment |
4574 |
|
the following categories are defined:</t> |
4575 |
|
<t>"NAME" - |
4576 |
|
<list> |
4577 |
|
<t>Name for this MIDI instrument map entry (if defined). |
4578 |
|
This name shall be used by frontends for displaying a |
4579 |
|
name for this mapped instrument. It can be set and |
4580 |
|
changed with the |
4581 |
|
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
4582 |
|
command and does not have to be unique.</t> |
4583 |
|
</list> |
4584 |
|
</t> |
4585 |
|
<t>"ENGINE_NAME" - |
4586 |
|
<list> |
4587 |
|
<t>Name of the engine to be deployed for this |
4588 |
|
instrument.</t> |
4589 |
|
</list> |
4590 |
|
</t> |
4591 |
|
<t>"INSTRUMENT_FILE" - |
4592 |
|
<list> |
4593 |
|
<t>File name of the instrument.</t> |
4594 |
|
</list> |
4595 |
|
</t> |
4596 |
|
<t>"INSTRUMENT_NR" - |
4597 |
|
<list> |
4598 |
|
<t>Index of the instrument within the file.</t> |
4599 |
|
</list> |
4600 |
|
</t> |
4601 |
|
<t>"INSTRUMENT_NAME" - |
4602 |
|
<list> |
4603 |
|
<t>Name of the loaded instrument as reflected by its file. |
4604 |
|
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
4605 |
|
cannot be changed.</t> |
4606 |
|
</list> |
4607 |
|
</t> |
4608 |
|
<t>"LOAD_MODE" - |
4609 |
|
<list> |
4610 |
|
<t>Life time of instrument |
4611 |
|
(see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t> |
4612 |
|
</list> |
4613 |
|
</t> |
4614 |
|
<t>"VOLUME" - |
4615 |
|
<list> |
4616 |
|
<t>master volume of the instrument as optionally |
4617 |
|
dotted number (where a value < 1.0 means attenuation |
4618 |
|
and a value > 1.0 means amplification)</t> |
4619 |
|
</list> |
4620 |
|
</t> |
4621 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
4622 |
|
</list> |
4623 |
|
</t> |
4624 |
|
|
4625 |
|
<t>Example:</t> |
4626 |
|
<t> |
4627 |
|
<list> |
4628 |
|
<t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t> |
4629 |
|
<t>S: "NAME: Drums for Foo Song"</t> |
4630 |
|
<t> "ENGINE_NAME: GigEngine"</t> |
4631 |
|
<t> "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t> |
4632 |
|
<t> "INSTRUMENT_NR: 0"</t> |
4633 |
|
<t> "INSTRUMENT_NAME: Joe's Drumkit"</t> |
4634 |
|
<t> "LOAD_MODE: PERSISTENT"</t> |
4635 |
|
<t> "VOLUME: 1.0"</t> |
4636 |
|
<t> "."</t> |
4637 |
|
</list> |
4638 |
|
</t> |
4639 |
|
</section> |
4640 |
|
|
4641 |
|
<section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS"> |
4642 |
|
<t>The front-end can clear a whole MIDI instrument map, that |
4643 |
|
is delete all its entries by sending the following command:</t> |
4644 |
|
<t> |
4645 |
|
<list> |
4646 |
|
<t>CLEAR MIDI_INSTRUMENTS <map></t> |
4647 |
|
</list> |
4648 |
|
</t> |
4649 |
|
<t>Where <map> is the numeric ID of the map to clear.</t> |
4650 |
|
<t>The front-end can clear all MIDI instrument maps, that |
4651 |
|
is delete all entries of all maps by sending the following |
4652 |
|
command:</t> |
4653 |
|
<t> |
4654 |
|
<list> |
4655 |
|
<t>CLEAR MIDI_INSTRUMENTS ALL</t> |
4656 |
|
</list> |
4657 |
|
</t> |
4658 |
|
<t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the |
4659 |
|
maps, only their entries, thus the map's settings like |
4660 |
|
custom name will be preservevd.</t> |
4661 |
|
|
4662 |
|
<t>Possible Answers:</t> |
4663 |
|
<t> |
4664 |
|
<list> |
4665 |
|
<t>"OK" - |
4666 |
|
<list> |
4667 |
|
<t>always</t> |
4668 |
|
</list> |
4669 |
|
</t> |
4670 |
|
</list> |
4671 |
|
</t> |
4672 |
|
|
4673 |
|
<t>Examples:</t> |
4674 |
|
<t> |
4675 |
|
<list> |
4676 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS 0"</t> |
4677 |
|
<t>S: "OK"</t> |
4678 |
|
</list> |
4679 |
|
</t> |
4680 |
|
<t> |
4681 |
|
<list> |
4682 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t> |
4683 |
|
<t>S: "OK"</t> |
4684 |
|
</list> |
4685 |
|
</t> |
4686 |
|
</section> |
4687 |
|
</section> |
4688 |
|
|
4689 |
</section> |
</section> |
4690 |
|
|
4691 |
|
|
4692 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
4693 |
<t>TODO: will soon automatically included from src/network/lscp.y, |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
4694 |
meanwhile have a look at that file to get the exact definition of |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
4695 |
the command syntax.</t> |
where applicable. |
4696 |
|
</t> |
4697 |
|
<!-- |
4698 |
|
This section is automatically generated by scripts/update_grammar.pl |
4699 |
|
from src/network/lscp.y (yacc input file). Do not modify this section |
4700 |
|
manually ! |
4701 |
|
--> |
4702 |
|
<!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! --> |
4703 |
|
|
4704 |
|
<t>input = |
4705 |
|
<list> |
4706 |
|
<t>line LF |
4707 |
|
</t> |
4708 |
|
<t>/ line CR LF |
4709 |
|
</t> |
4710 |
|
</list> |
4711 |
|
</t> |
4712 |
|
<t>line = |
4713 |
|
<list> |
4714 |
|
<t>/* epsilon (empty line ignored) */ |
4715 |
|
</t> |
4716 |
|
<t>/ comment |
4717 |
|
</t> |
4718 |
|
<t>/ command |
4719 |
|
</t> |
4720 |
|
<t>/ error |
4721 |
|
</t> |
4722 |
|
</list> |
4723 |
|
</t> |
4724 |
|
<t>comment = |
4725 |
|
<list> |
4726 |
|
<t>'#' |
4727 |
|
</t> |
4728 |
|
<t>/ comment '#' |
4729 |
|
</t> |
4730 |
|
<t>/ comment SP |
4731 |
|
</t> |
4732 |
|
<t>/ comment number |
4733 |
|
</t> |
4734 |
|
<t>/ comment string |
4735 |
|
</t> |
4736 |
|
</list> |
4737 |
|
</t> |
4738 |
|
<t>command = |
4739 |
|
<list> |
4740 |
|
<t>ADD SP add_instruction |
4741 |
|
</t> |
4742 |
|
<t>/ MAP SP map_instruction |
4743 |
|
</t> |
4744 |
|
<t>/ UNMAP SP unmap_instruction |
4745 |
|
</t> |
4746 |
|
<t>/ GET SP get_instruction |
4747 |
|
</t> |
4748 |
|
<t>/ CREATE SP create_instruction |
4749 |
|
</t> |
4750 |
|
<t>/ DESTROY SP destroy_instruction |
4751 |
|
</t> |
4752 |
|
<t>/ LIST SP list_instruction |
4753 |
|
</t> |
4754 |
|
<t>/ LOAD SP load_instruction |
4755 |
|
</t> |
4756 |
|
<t>/ REMOVE SP remove_instruction |
4757 |
|
</t> |
4758 |
|
<t>/ SET SP set_instruction |
4759 |
|
</t> |
4760 |
|
<t>/ SUBSCRIBE SP subscribe_event |
4761 |
|
</t> |
4762 |
|
<t>/ UNSUBSCRIBE SP unsubscribe_event |
4763 |
|
</t> |
4764 |
|
<t>/ SELECT SP text |
4765 |
|
</t> |
4766 |
|
<t>/ RESET SP reset_instruction |
4767 |
|
</t> |
4768 |
|
<t>/ CLEAR SP clear_instruction |
4769 |
|
</t> |
4770 |
|
<t>/ RESET |
4771 |
|
</t> |
4772 |
|
<t>/ QUIT |
4773 |
|
</t> |
4774 |
|
</list> |
4775 |
|
</t> |
4776 |
|
<t>add_instruction = |
4777 |
|
<list> |
4778 |
|
<t>CHANNEL |
4779 |
|
</t> |
4780 |
|
<t>/ MIDI_INSTRUMENT_MAP |
4781 |
|
</t> |
4782 |
|
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
4783 |
|
</t> |
4784 |
|
</list> |
4785 |
|
</t> |
4786 |
|
<t>subscribe_event = |
4787 |
|
<list> |
4788 |
|
<t>AUDIO_OUTPUT_DEVICE_COUNT |
4789 |
|
</t> |
4790 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
4791 |
|
</t> |
4792 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
4793 |
|
</t> |
4794 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
4795 |
|
</t> |
4796 |
|
<t>/ CHANNEL_COUNT |
4797 |
|
</t> |
4798 |
|
<t>/ VOICE_COUNT |
4799 |
|
</t> |
4800 |
|
<t>/ STREAM_COUNT |
4801 |
|
</t> |
4802 |
|
<t>/ BUFFER_FILL |
4803 |
|
</t> |
4804 |
|
<t>/ CHANNEL_INFO |
4805 |
|
</t> |
4806 |
|
<t>/ FX_SEND_COUNT |
4807 |
|
</t> |
4808 |
|
<t>/ FX_SEND_INFO |
4809 |
|
</t> |
4810 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
4811 |
|
</t> |
4812 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
4813 |
|
</t> |
4814 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
4815 |
|
</t> |
4816 |
|
<t>/ MIDI_INSTRUMENT_INFO |
4817 |
|
</t> |
4818 |
|
<t>/ MISCELLANEOUS |
4819 |
|
</t> |
4820 |
|
<t>/ TOTAL_VOICE_COUNT |
4821 |
|
</t> |
4822 |
|
<t>/ GLOBAL_INFO |
4823 |
|
</t> |
4824 |
|
</list> |
4825 |
|
</t> |
4826 |
|
<t>unsubscribe_event = |
4827 |
|
<list> |
4828 |
|
<t>AUDIO_OUTPUT_DEVICE_COUNT |
4829 |
|
</t> |
4830 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
4831 |
|
</t> |
4832 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
4833 |
|
</t> |
4834 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
4835 |
|
</t> |
4836 |
|
<t>/ CHANNEL_COUNT |
4837 |
|
</t> |
4838 |
|
<t>/ VOICE_COUNT |
4839 |
|
</t> |
4840 |
|
<t>/ STREAM_COUNT |
4841 |
|
</t> |
4842 |
|
<t>/ BUFFER_FILL |
4843 |
|
</t> |
4844 |
|
<t>/ CHANNEL_INFO |
4845 |
|
</t> |
4846 |
|
<t>/ FX_SEND_COUNT |
4847 |
|
</t> |
4848 |
|
<t>/ FX_SEND_INFO |
4849 |
|
</t> |
4850 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
4851 |
|
</t> |
4852 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
4853 |
|
</t> |
4854 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
4855 |
|
</t> |
4856 |
|
<t>/ MIDI_INSTRUMENT_INFO |
4857 |
|
</t> |
4858 |
|
<t>/ MISCELLANEOUS |
4859 |
|
</t> |
4860 |
|
<t>/ TOTAL_VOICE_COUNT |
4861 |
|
</t> |
4862 |
|
<t>/ GLOBAL_INFO |
4863 |
|
</t> |
4864 |
|
</list> |
4865 |
|
</t> |
4866 |
|
<t>map_instruction = |
4867 |
|
<list> |
4868 |
|
<t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
4869 |
|
</t> |
4870 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode |
4871 |
|
</t> |
4872 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name |
4873 |
|
</t> |
4874 |
|
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name |
4875 |
|
</t> |
4876 |
|
</list> |
4877 |
|
</t> |
4878 |
|
<t>unmap_instruction = |
4879 |
|
<list> |
4880 |
|
<t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog |
4881 |
|
</t> |
4882 |
|
</list> |
4883 |
|
</t> |
4884 |
|
<t>remove_instruction = |
4885 |
|
<list> |
4886 |
|
<t>CHANNEL SP sampler_channel |
4887 |
|
</t> |
4888 |
|
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
4889 |
|
</t> |
4890 |
|
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
4891 |
|
</t> |
4892 |
|
</list> |
4893 |
|
</t> |
4894 |
|
<t>get_instruction = |
4895 |
|
<list> |
4896 |
|
<t>AVAILABLE_ENGINES |
4897 |
|
</t> |
4898 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
4899 |
|
</t> |
4900 |
|
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
4901 |
|
</t> |
4902 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string |
4903 |
|
</t> |
4904 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
4905 |
|
</t> |
4906 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
4907 |
|
</t> |
4908 |
|
<t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string |
4909 |
|
</t> |
4910 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string |
4911 |
|
</t> |
4912 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
4913 |
|
</t> |
4914 |
|
<t>/ AUDIO_OUTPUT_DEVICES |
4915 |
|
</t> |
4916 |
|
<t>/ MIDI_INPUT_DEVICES |
4917 |
|
</t> |
4918 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number |
4919 |
|
</t> |
4920 |
|
<t>/ MIDI_INPUT_DEVICE SP INFO SP number |
4921 |
|
</t> |
4922 |
|
<t>/ MIDI_INPUT_PORT SP INFO SP number SP number |
4923 |
|
</t> |
4924 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string |
4925 |
|
</t> |
4926 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number |
4927 |
|
</t> |
4928 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string |
4929 |
|
</t> |
4930 |
|
<t>/ CHANNELS |
4931 |
|
</t> |
4932 |
|
<t>/ CHANNEL SP INFO SP sampler_channel |
4933 |
|
</t> |
4934 |
|
<t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel |
4935 |
|
</t> |
4936 |
|
<t>/ CHANNEL SP STREAM_COUNT SP sampler_channel |
4937 |
|
</t> |
4938 |
|
<t>/ CHANNEL SP VOICE_COUNT SP sampler_channel |
4939 |
|
</t> |
4940 |
|
<t>/ ENGINE SP INFO SP engine_name |
4941 |
|
</t> |
4942 |
|
<t>/ SERVER SP INFO |
4943 |
|
</t> |
4944 |
|
<t>/ TOTAL_VOICE_COUNT |
4945 |
|
</t> |
4946 |
|
<t>/ TOTAL_VOICE_COUNT_MAX |
4947 |
|
</t> |
4948 |
|
<t>/ MIDI_INSTRUMENTS SP midi_map |
4949 |
|
</t> |
4950 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
4951 |
|
</t> |
4952 |
|
<t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog |
4953 |
|
</t> |
4954 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
4955 |
|
</t> |
4956 |
|
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
4957 |
|
</t> |
4958 |
|
<t>/ FX_SENDS SP sampler_channel |
4959 |
|
</t> |
4960 |
|
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
4961 |
|
</t> |
4962 |
|
<t>/ VOLUME |
4963 |
|
</t> |
4964 |
|
</list> |
4965 |
|
</t> |
4966 |
|
<t>set_instruction = |
4967 |
|
<list> |
4968 |
|
<t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
4969 |
|
</t> |
4970 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list |
4971 |
|
</t> |
4972 |
|
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
4973 |
|
</t> |
4974 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
4975 |
|
</t> |
4976 |
|
<t>/ CHANNEL SP set_chan_instruction |
4977 |
|
</t> |
4978 |
|
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
4979 |
|
</t> |
4980 |
|
<t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
4981 |
|
</t> |
4982 |
|
<t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl |
4983 |
|
</t> |
4984 |
|
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
4985 |
|
</t> |
4986 |
|
<t>/ ECHO SP boolean |
4987 |
|
</t> |
4988 |
|
<t>/ VOLUME SP volume_value |
4989 |
|
</t> |
4990 |
|
</list> |
4991 |
|
</t> |
4992 |
|
<t>create_instruction = |
4993 |
|
<list> |
4994 |
|
<t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
4995 |
|
</t> |
4996 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP string |
4997 |
|
</t> |
4998 |
|
<t>/ MIDI_INPUT_DEVICE SP string SP key_val_list |
4999 |
|
</t> |
5000 |
|
<t>/ MIDI_INPUT_DEVICE SP string |
5001 |
|
</t> |
5002 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl |
5003 |
|
</t> |
5004 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
5005 |
|
</t> |
5006 |
|
</list> |
5007 |
|
</t> |
5008 |
|
<t>reset_instruction = |
5009 |
|
<list> |
5010 |
|
<t>CHANNEL SP sampler_channel |
5011 |
|
</t> |
5012 |
|
</list> |
5013 |
|
</t> |
5014 |
|
<t>clear_instruction = |
5015 |
|
<list> |
5016 |
|
<t>MIDI_INSTRUMENTS SP midi_map |
5017 |
|
</t> |
5018 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
5019 |
|
</t> |
5020 |
|
</list> |
5021 |
|
</t> |
5022 |
|
<t>destroy_instruction = |
5023 |
|
<list> |
5024 |
|
<t>AUDIO_OUTPUT_DEVICE SP number |
5025 |
|
</t> |
5026 |
|
<t>/ MIDI_INPUT_DEVICE SP number |
5027 |
|
</t> |
5028 |
|
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
5029 |
|
</t> |
5030 |
|
</list> |
5031 |
|
</t> |
5032 |
|
<t>load_instruction = |
5033 |
|
<list> |
5034 |
|
<t>INSTRUMENT SP load_instr_args |
5035 |
|
</t> |
5036 |
|
<t>/ ENGINE SP load_engine_args |
5037 |
|
</t> |
5038 |
|
</list> |
5039 |
|
</t> |
5040 |
|
<t>set_chan_instruction = |
5041 |
|
<list> |
5042 |
|
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
5043 |
|
</t> |
5044 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index |
5045 |
|
</t> |
5046 |
|
<t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name |
5047 |
|
</t> |
5048 |
|
<t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index |
5049 |
|
</t> |
5050 |
|
<t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index |
5051 |
|
</t> |
5052 |
|
<t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index |
5053 |
|
</t> |
5054 |
|
<t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index |
5055 |
|
</t> |
5056 |
|
<t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name |
5057 |
|
</t> |
5058 |
|
<t>/ VOLUME SP sampler_channel SP volume_value |
5059 |
|
</t> |
5060 |
|
<t>/ MUTE SP sampler_channel SP boolean |
5061 |
|
</t> |
5062 |
|
<t>/ SOLO SP sampler_channel SP boolean |
5063 |
|
</t> |
5064 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
5065 |
|
</t> |
5066 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
5067 |
|
</t> |
5068 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
5069 |
|
</t> |
5070 |
|
</list> |
5071 |
|
</t> |
5072 |
|
<t>modal_arg = |
5073 |
|
<list> |
5074 |
|
<t>/* epsilon (empty argument) */ |
5075 |
|
</t> |
5076 |
|
<t>/ NON_MODAL SP |
5077 |
|
</t> |
5078 |
|
</list> |
5079 |
|
</t> |
5080 |
|
<t>key_val_list = |
5081 |
|
<list> |
5082 |
|
<t>string '=' param_val_list |
5083 |
|
</t> |
5084 |
|
<t>/ key_val_list SP string '=' param_val_list |
5085 |
|
</t> |
5086 |
|
</list> |
5087 |
|
</t> |
5088 |
|
<t>buffer_size_type = |
5089 |
|
<list> |
5090 |
|
<t>BYTES |
5091 |
|
</t> |
5092 |
|
<t>/ PERCENTAGE |
5093 |
|
</t> |
5094 |
|
</list> |
5095 |
|
</t> |
5096 |
|
<t>list_instruction = |
5097 |
|
<list> |
5098 |
|
<t>AUDIO_OUTPUT_DEVICES |
5099 |
|
</t> |
5100 |
|
<t>/ MIDI_INPUT_DEVICES |
5101 |
|
</t> |
5102 |
|
<t>/ CHANNELS |
5103 |
|
</t> |
5104 |
|
<t>/ AVAILABLE_ENGINES |
5105 |
|
</t> |
5106 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
5107 |
|
</t> |
5108 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
5109 |
|
</t> |
5110 |
|
<t>/ MIDI_INSTRUMENTS SP midi_map |
5111 |
|
</t> |
5112 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
5113 |
|
</t> |
5114 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
5115 |
|
</t> |
5116 |
|
<t>/ FX_SENDS SP sampler_channel |
5117 |
|
</t> |
5118 |
|
</list> |
5119 |
|
</t> |
5120 |
|
<t>load_instr_args = |
5121 |
|
<list> |
5122 |
|
<t>filename SP instrument_index SP sampler_channel |
5123 |
|
</t> |
5124 |
|
<t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel |
5125 |
|
</t> |
5126 |
|
</list> |
5127 |
|
</t> |
5128 |
|
<t>load_engine_args = |
5129 |
|
<list> |
5130 |
|
<t>engine_name SP sampler_channel |
5131 |
|
</t> |
5132 |
|
</list> |
5133 |
|
</t> |
5134 |
|
<t>instr_load_mode = |
5135 |
|
<list> |
5136 |
|
<t>ON_DEMAND |
5137 |
|
</t> |
5138 |
|
<t>/ ON_DEMAND_HOLD |
5139 |
|
</t> |
5140 |
|
<t>/ PERSISTENT |
5141 |
|
</t> |
5142 |
|
</list> |
5143 |
|
</t> |
5144 |
|
<t>device_index = |
5145 |
|
<list> |
5146 |
|
<t>number |
5147 |
|
</t> |
5148 |
|
</list> |
5149 |
|
</t> |
5150 |
|
<t>audio_channel_index = |
5151 |
|
<list> |
5152 |
|
<t>number |
5153 |
|
</t> |
5154 |
|
</list> |
5155 |
|
</t> |
5156 |
|
<t>audio_output_type_name = |
5157 |
|
<list> |
5158 |
|
<t>string |
5159 |
|
</t> |
5160 |
|
</list> |
5161 |
|
</t> |
5162 |
|
<t>midi_input_port_index = |
5163 |
|
<list> |
5164 |
|
<t>number |
5165 |
|
</t> |
5166 |
|
</list> |
5167 |
|
</t> |
5168 |
|
<t>midi_input_channel_index = |
5169 |
|
<list> |
5170 |
|
<t>number |
5171 |
|
</t> |
5172 |
|
<t>/ ALL |
5173 |
|
</t> |
5174 |
|
</list> |
5175 |
|
</t> |
5176 |
|
<t>midi_input_type_name = |
5177 |
|
<list> |
5178 |
|
<t>string |
5179 |
|
</t> |
5180 |
|
</list> |
5181 |
|
</t> |
5182 |
|
<t>midi_map = |
5183 |
|
<list> |
5184 |
|
<t>number |
5185 |
|
</t> |
5186 |
|
</list> |
5187 |
|
</t> |
5188 |
|
<t>midi_bank = |
5189 |
|
<list> |
5190 |
|
<t>number |
5191 |
|
</t> |
5192 |
|
</list> |
5193 |
|
</t> |
5194 |
|
<t>midi_prog = |
5195 |
|
<list> |
5196 |
|
<t>number |
5197 |
|
</t> |
5198 |
|
</list> |
5199 |
|
</t> |
5200 |
|
<t>midi_ctrl = |
5201 |
|
<list> |
5202 |
|
<t>number |
5203 |
|
</t> |
5204 |
|
</list> |
5205 |
|
</t> |
5206 |
|
<t>volume_value = |
5207 |
|
<list> |
5208 |
|
<t>dotnum |
5209 |
|
</t> |
5210 |
|
<t>/ number |
5211 |
|
</t> |
5212 |
|
</list> |
5213 |
|
</t> |
5214 |
|
<t>sampler_channel = |
5215 |
|
<list> |
5216 |
|
<t>number |
5217 |
|
</t> |
5218 |
|
</list> |
5219 |
|
</t> |
5220 |
|
<t>instrument_index = |
5221 |
|
<list> |
5222 |
|
<t>number |
5223 |
|
</t> |
5224 |
|
</list> |
5225 |
|
</t> |
5226 |
|
<t>fx_send_id = |
5227 |
|
<list> |
5228 |
|
<t>number |
5229 |
|
</t> |
5230 |
|
</list> |
5231 |
|
</t> |
5232 |
|
<t>engine_name = |
5233 |
|
<list> |
5234 |
|
<t>string |
5235 |
|
</t> |
5236 |
|
</list> |
5237 |
|
</t> |
5238 |
|
<t>filename = |
5239 |
|
<list> |
5240 |
|
<t>stringval |
5241 |
|
</t> |
5242 |
|
</list> |
5243 |
|
</t> |
5244 |
|
<t>map_name = |
5245 |
|
<list> |
5246 |
|
<t>stringval |
5247 |
|
</t> |
5248 |
|
</list> |
5249 |
|
</t> |
5250 |
|
<t>entry_name = |
5251 |
|
<list> |
5252 |
|
<t>stringval |
5253 |
|
</t> |
5254 |
|
</list> |
5255 |
|
</t> |
5256 |
|
<t>fx_send_name = |
5257 |
|
<list> |
5258 |
|
<t>stringval |
5259 |
|
</t> |
5260 |
|
</list> |
5261 |
|
</t> |
5262 |
|
<t>param_val_list = |
5263 |
|
<list> |
5264 |
|
<t>param_val |
5265 |
|
</t> |
5266 |
|
<t>/ param_val_list','param_val |
5267 |
|
</t> |
5268 |
|
</list> |
5269 |
|
</t> |
5270 |
|
<t>param_val = |
5271 |
|
<list> |
5272 |
|
<t>string |
5273 |
|
</t> |
5274 |
|
<t>/ stringval |
5275 |
|
</t> |
5276 |
|
<t>/ number |
5277 |
|
</t> |
5278 |
|
<t>/ dotnum |
5279 |
|
</t> |
5280 |
|
</list> |
5281 |
|
</t> |
5282 |
|
|
5283 |
|
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
5284 |
</section> |
</section> |
5285 |
|
|
5286 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
5287 |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
5288 |
|
|
5289 |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL"> |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"> |
5290 |
|
<t>Client may want to be notified when the total number of audio output devices on the |
5291 |
|
back-end changes by issuing the following command:</t> |
5292 |
|
<t> |
5293 |
|
<list> |
5294 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t> |
5295 |
|
</list> |
5296 |
|
</t> |
5297 |
|
<t>Server will start sending the following notification messages:</t> |
5298 |
|
<t> |
5299 |
|
<list> |
5300 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"</t> |
5301 |
|
</list> |
5302 |
|
</t> |
5303 |
|
<t>where <devices> will be replaced by the new number |
5304 |
|
of audio output devices.</t> |
5305 |
|
</section> |
5306 |
|
|
5307 |
|
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"> |
5308 |
|
<t>Client may want to be notified when changes were made to audio output devices on the |
5309 |
|
back-end by issuing the following command:</t> |
5310 |
|
<t> |
5311 |
|
<list> |
5312 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t> |
5313 |
|
</list> |
5314 |
|
</t> |
5315 |
|
<t>Server will start sending the following notification messages:</t> |
5316 |
|
<t> |
5317 |
|
<list> |
5318 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"</t> |
5319 |
|
</list> |
5320 |
|
</t> |
5321 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio output device, |
5322 |
|
which settings has been changed. The front-end will have to send |
5323 |
|
the respective command to actually get the audio output device info. Because these messages |
5324 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5325 |
|
time events happening on the server, it is believed that an empty notification |
5326 |
|
message is sufficient here.</t> |
5327 |
|
</section> |
5328 |
|
|
5329 |
|
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"> |
5330 |
|
<t>Client may want to be notified when the total number of MIDI input devices on the |
5331 |
|
back-end changes by issuing the following command:</t> |
5332 |
|
<t> |
5333 |
|
<list> |
5334 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t> |
5335 |
|
</list> |
5336 |
|
</t> |
5337 |
|
<t>Server will start sending the following notification messages:</t> |
5338 |
|
<t> |
5339 |
|
<list> |
5340 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"</t> |
5341 |
|
</list> |
5342 |
|
</t> |
5343 |
|
<t>where <devices> will be replaced by the new number |
5344 |
|
of MIDI input devices.</t> |
5345 |
|
</section> |
5346 |
|
|
5347 |
|
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"> |
5348 |
|
<t>Client may want to be notified when changes were made to MIDI input devices on the |
5349 |
|
back-end by issuing the following command:</t> |
5350 |
|
<t> |
5351 |
|
<list> |
5352 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t> |
5353 |
|
</list> |
5354 |
|
</t> |
5355 |
|
<t>Server will start sending the following notification messages:</t> |
5356 |
|
<t> |
5357 |
|
<list> |
5358 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"</t> |
5359 |
|
</list> |
5360 |
|
</t> |
5361 |
|
<t>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
5362 |
|
which settings has been changed. The front-end will have to send |
5363 |
|
the respective command to actually get the MIDI input device info. Because these messages |
5364 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5365 |
|
time events happening on the server, it is believed that an empty notification |
5366 |
|
message is sufficient here.</t> |
5367 |
|
</section> |
5368 |
|
|
5369 |
|
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT"> |
5370 |
<t>Client may want to be notified when the total number of channels on the |
<t>Client may want to be notified when the total number of channels on the |
5371 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
5372 |
<t> |
<t> |
5373 |
<list> |
<list> |
5374 |
<t>SUBSCRIBE CHANNELS</t> |
<t>SUBSCRIBE CHANNEL_COUNT</t> |
5375 |
</list> |
</list> |
5376 |
</t> |
</t> |
5377 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
5378 |
<t> |
<t> |
5379 |
<list> |
<list> |
5380 |
<t>"NOTIFY:CHANNELS:<channels>"</t> |
<t>"NOTIFY:CHANNEL_COUNT:<channels>"</t> |
5381 |
</list> |
</list> |
5382 |
</t> |
</t> |
5383 |
<t>where <channels> will be replaced by the new number |
<t>where <channels> will be replaced by the new number |
5395 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
5396 |
<t> |
<t> |
5397 |
<list> |
<list> |
5398 |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices></t> |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"</t> |
5399 |
</list> |
</list> |
5400 |
</t> |
</t> |
5401 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
5443 |
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
5444 |
</section> |
</section> |
5445 |
|
|
5446 |
<section title="Channel information changed" anchor="SUBSCRIBE INFO"> |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO"> |
5447 |
<t>Client may want to be notified when changes were made to sampler channels on the |
<t>Client may want to be notified when changes were made to sampler channels on the |
5448 |
back-end changes by issuing the following command:</t> |
back-end by issuing the following command:</t> |
5449 |
<t> |
<t> |
5450 |
<list> |
<list> |
5451 |
<t>SUBSCRIBE INFO</t> |
<t>SUBSCRIBE CHANNEL_INFO</t> |
5452 |
</list> |
</list> |
5453 |
</t> |
</t> |
5454 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
5455 |
<t> |
<t> |
5456 |
<list> |
<list> |
5457 |
<t>"NOTIFY:INFO:<sampler-channel>"</t> |
<t>"NOTIFY:CHANNEL_INFO:<sampler-channel>"</t> |
5458 |
</list> |
</list> |
5459 |
</t> |
</t> |
5460 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
5465 |
message is sufficient here.</t> |
message is sufficient here.</t> |
5466 |
</section> |
</section> |
5467 |
|
|
5468 |
|
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
5469 |
|
<t>Client may want to be notified when the number of effect sends on |
5470 |
|
a particular sampler channel is changed by issuing the following command:</t> |
5471 |
|
<t> |
5472 |
|
<list> |
5473 |
|
<t>SUBSCRIBE FX_SEND_COUNT</t> |
5474 |
|
</list> |
5475 |
|
</t> |
5476 |
|
<t>Server will start sending the following notification messages:</t> |
5477 |
|
<t> |
5478 |
|
<list> |
5479 |
|
<t>"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"</t> |
5480 |
|
</list> |
5481 |
|
</t> |
5482 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
5483 |
|
channel, on which the effect sends number is changed and <fx-sends> will |
5484 |
|
be replaced by the new number of effect sends on that channel.</t> |
5485 |
|
</section> |
5486 |
|
|
5487 |
|
<section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO"> |
5488 |
|
<t>Client may want to be notified when changes were made to effect sends on a |
5489 |
|
a particular sampler channel by issuing the following command:</t> |
5490 |
|
<t> |
5491 |
|
<list> |
5492 |
|
<t>SUBSCRIBE FX_SEND_INFO</t> |
5493 |
|
</list> |
5494 |
|
</t> |
5495 |
|
<t>Server will start sending the following notification messages:</t> |
5496 |
|
<t> |
5497 |
|
<list> |
5498 |
|
<t>"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"</t> |
5499 |
|
</list> |
5500 |
|
</t> |
5501 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
5502 |
|
channel, on which an effect send entity is changed and <fx-send-id> will |
5503 |
|
be replaced by the numerical ID of the changed effect send.</t> |
5504 |
|
</section> |
5505 |
|
|
5506 |
|
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT"> |
5507 |
|
<t>Client may want to be notified when the total number of voices on the |
5508 |
|
back-end changes by issuing the following command:</t> |
5509 |
|
<t> |
5510 |
|
<list> |
5511 |
|
<t>SUBSCRIBE TOTAL_VOICE_COUNT</t> |
5512 |
|
</list> |
5513 |
|
</t> |
5514 |
|
<t>Server will start sending the following notification messages:</t> |
5515 |
|
<t> |
5516 |
|
<list> |
5517 |
|
<t>"NOTIFY:TOTAL_VOICE_COUNT:<voices>"</t> |
5518 |
|
</list> |
5519 |
|
</t> |
5520 |
|
<t>where <voices> will be replaced by the new number of |
5521 |
|
all currently active voices.</t> |
5522 |
|
</section> |
5523 |
|
|
5524 |
|
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
5525 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
5526 |
|
back-end changes by issuing the following command:</t> |
5527 |
|
<t> |
5528 |
|
<list> |
5529 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t> |
5530 |
|
</list> |
5531 |
|
</t> |
5532 |
|
<t>Server will start sending the following notification messages:</t> |
5533 |
|
<t> |
5534 |
|
<list> |
5535 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"</t> |
5536 |
|
</list> |
5537 |
|
</t> |
5538 |
|
<t>where <maps> will be replaced by the new number |
5539 |
|
of MIDI instrument maps.</t> |
5540 |
|
</section> |
5541 |
|
|
5542 |
|
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"> |
5543 |
|
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
5544 |
|
back-end by issuing the following command:</t> |
5545 |
|
<t> |
5546 |
|
<list> |
5547 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t> |
5548 |
|
</list> |
5549 |
|
</t> |
5550 |
|
<t>Server will start sending the following notification messages:</t> |
5551 |
|
<t> |
5552 |
|
<list> |
5553 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"</t> |
5554 |
|
</list> |
5555 |
|
</t> |
5556 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
5557 |
|
for which information changes occurred. The front-end will have to send |
5558 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
5559 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5560 |
|
time events happening on the server, it is believed that an empty notification |
5561 |
|
message is sufficient here.</t> |
5562 |
|
</section> |
5563 |
|
|
5564 |
|
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT"> |
5565 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
5566 |
|
back-end changes by issuing the following command:</t> |
5567 |
|
<t> |
5568 |
|
<list> |
5569 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t> |
5570 |
|
</list> |
5571 |
|
</t> |
5572 |
|
<t>Server will start sending the following notification messages:</t> |
5573 |
|
<t> |
5574 |
|
<list> |
5575 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
5576 |
|
</list> |
5577 |
|
</t> |
5578 |
|
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
5579 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
5580 |
|
the new number of MIDI instruments in the specified map.</t> |
5581 |
|
</section> |
5582 |
|
|
5583 |
|
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO"> |
5584 |
|
<t>Client may want to be notified when changes were made to MIDI instruments on the |
5585 |
|
back-end by issuing the following command:</t> |
5586 |
|
<t> |
5587 |
|
<list> |
5588 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t> |
5589 |
|
</list> |
5590 |
|
</t> |
5591 |
|
<t>Server will start sending the following notification messages:</t> |
5592 |
|
<t> |
5593 |
|
<list> |
5594 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"</t> |
5595 |
|
</list> |
5596 |
|
</t> |
5597 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
5598 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
5599 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
5600 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
5601 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5602 |
|
time events happening on the server, it is believed that an empty notification |
5603 |
|
message is sufficient here.</t> |
5604 |
|
</section> |
5605 |
|
|
5606 |
|
<section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO"> |
5607 |
|
<t>Client may want to be notified when changes to the global settings |
5608 |
|
of the sampler were made by issuing the following command:</t> |
5609 |
|
<t> |
5610 |
|
<list> |
5611 |
|
<t>SUBSCRIBE GLOBAL_INFO</t> |
5612 |
|
</list> |
5613 |
|
</t> |
5614 |
|
<t>Server will start sending the following types of notification messages:</t> |
5615 |
|
<t> |
5616 |
|
<list> |
5617 |
|
<t>"NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the |
5618 |
|
golbal volume of the sampler is changed, where <volume> will be |
5619 |
|
replaced by the optional dotted floating point value, reflecting the |
5620 |
|
new global volume parameter.</t> |
5621 |
|
</list> |
5622 |
|
</t> |
5623 |
|
</section> |
5624 |
|
|
5625 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
5626 |
<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 |
5627 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
5658 |
<t>Rui Nuno Capela</t> |
<t>Rui Nuno Capela</t> |
5659 |
<t>Vladimir Senkov</t> |
<t>Vladimir Senkov</t> |
5660 |
<t>Mark Knecht</t> |
<t>Mark Knecht</t> |
5661 |
|
<t>Grigor Iliev</t> |
5662 |
</list> |
</list> |
5663 |
</t> |
</t> |
5664 |
</section> |
</section> |
5666 |
</middle> |
</middle> |
5667 |
|
|
5668 |
<back> |
<back> |
5669 |
<references>&rfc2119;</references> |
<references> |
5670 |
|
<reference anchor="RFC2119"> |
5671 |
|
<front> |
5672 |
|
<title>Key words for use in RFCs to Indicate Requirement Levels</title> |
5673 |
|
<author initials="S." surname="Bradner" fullname="Scott Bradner"> |
5674 |
|
<organization>Harvard University</organization> |
5675 |
|
</author> |
5676 |
|
<date year="1997"></date> |
5677 |
|
</front> |
5678 |
|
<seriesInfo name="RFC" value="2119" /> |
5679 |
|
</reference> |
5680 |
|
<reference anchor="RFC793"> |
5681 |
|
<front> |
5682 |
|
<title>TRANSMISSION CONTROL PROTOCOL</title> |
5683 |
|
<author> |
5684 |
|
<organization>Defense Advanced Research Projects Agency</organization> |
5685 |
|
</author> |
5686 |
|
<date year="1981"></date> |
5687 |
|
</front> |
5688 |
|
<seriesInfo name="RFC" value="793" /> |
5689 |
|
</reference> |
5690 |
|
<reference anchor="RFC2234"> |
5691 |
|
<front> |
5692 |
|
<title>Augmented BNF for Syntax Specifications</title> |
5693 |
|
<author initials="D.H." surname="Crocker" fullname="David H. Crocker"> |
5694 |
|
<organization>Internet Mail Consortium</organization> |
5695 |
|
</author> |
5696 |
|
<author initials="P." surname="Overell" fullname="Paul Overell"> |
5697 |
|
<organization>Demon Internet Ltd</organization> |
5698 |
|
</author> |
5699 |
|
<date year="1997"></date> |
5700 |
|
</front> |
5701 |
|
<seriesInfo name="RFC" value="2234" /> |
5702 |
|
</reference> |
5703 |
|
</references> |
5704 |
</back> |
</back> |
5705 |
|
|
5706 |
</rfc> |
</rfc> |