1 /*****************************************************************************
2 * *
3 * LSCP documentation reference built into LSCP shell. *
4 * *
5 * Copyright (c) 2014 - 2016 Christian Schoenebeck *
6 * *
7 * This program is part of LinuxSampler and released under the same terms. *
8 * *
9 * This source file is auto generated by 'generate_lscp_shell_reference.pl' *
10 * from 'lscp.xml'. Thus do not modify this C++ file directly! *
11 * *
12 *****************************************************************************/
13
14 /*
15 This C++ file should automatically be re-generated if lscp.xml was
16 modified, if not, you may call "make parser" explicitly.
17 */
18
19 #include "lscp_shell_reference.h"
20 #include <string.h>
21
22 static lscp_ref_entry_t lscp_reference[] = {
23 { "GET AUDIO_OUTPUT_CHANNEL INFO",
24 "Use the following command to get information about an audio channel:\n"
25 "\nGET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>\n\nWhere <dev"
26 "ice-id> is the numerical ID of the audio output device as given by the"
27 " \"CREATE AUDIO_OUTPUT_DEVICE\" or \"LIST AUDIO_OUTPUT_DEVICES\" comma"
28 "nd and <audio-chan> the audio channel number.\n\nPossible Answers:\n\n"
29 "LinuxSampler will answer by sending a <CRLF> separated list. Each answ"
30 "er line begins with the information category name followed by a colon"
31 "and then a space character <SP> and finally the info character string"
32 "to that info category. At the moment the following information categor"
33 "ies are defined:\n\nNAME - arbitrary character string naming the chann"
34 "el, which doesn't have to be unique (always returned by all audio chan"
35 "nels)\n\nIS_MIX_CHANNEL - either true or false, a mix-channel is not a"
36 " real, independent audio channel, but a virtual channel which is mixed"
37 " to another real channel, this mechanism is needed for sampler engines"
38 " which need more audio channels than the used audio system might be ab"
39 "le to offer (always returned by all audio channels)\n\nMIX_CHANNEL_DES"
40 "TINATION - numerical ID (positive integer including 0) which reflects"
41 "the real audio channel (of the same audio output device) this mix chan"
42 "nel refers to, means where the audio signal actually will be routed /"
43 "added to (only returned in case the audio channel is mix channel)\n\nT"
44 "he mentioned fields above don't have to be in particular order. The fi"
45 "elds above are only those fields which are generally returned for the"
46 "described cases by all audio channels regardless of the audio driver."
47 "Every audio channel might have its own, additional driver and channel"
48 "specific parameters.\n\nExamples:\n\nC: \"GET AUDIO_OUTPUT_CHANNEL INF"
49 "O 0 0\"\n\nS: \"NAME: studio monitor left\"\n\n\"IS_MIX_CHANNEL: false"
50 "\"\n\n\".\"\n\nC: \"GET AUDIO_OUTPUT_CHANNEL INFO 0 1\"\n\nS: \"NAME:"
51 "studio monitor right\"\n\n\"IS_MIX_CHANNEL: false\"\n\n\".\"\n\nC: \"G"
52 "ET AUDIO_OUTPUT_CHANNEL INFO 0 2\"\n\nS: \"NAME: studio monitor left\""
53 "\n\n\"IS_MIX_CHANNEL: true\"\n\n\"MIX_CHANNEL_DESTINATION: 1\"\n\n\"."
54 "\"\n\nC: \"GET AUDIO_OUTPUT_CHANNEL INFO 1 0\"\n\nS: \"NAME: 'ardour (l"
55 "eft)'\"\n\n\"IS_MIX_CHANNEL: false\"\n\n\"JACK_BINDINGS: 'ardour:0'\""
56 "\n\n\".\"\n\n"
57 },
58 { "SET CHANNEL SOLO",
59 "The front-end can solo/unsolo a specific sampler channel by sending th"
60 "e following command:\n\nSET CHANNEL SOLO <sampler-channel> <solo>\n\nW"
61 "here <sampler-channel> is the respective sampler channel number as ret"
62 "urned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" command and <solo> s"
63 "hould be replaced either by \"1\" to solo the channel or \"0\" to unso"
64 "lo the channel.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"WRN:<"
65 "warning-code>:<warning-message>\" - if the channel was soloed/unsoloed"
66 ", but there are noteworthy issue(s) related, providing an appropriate"
67 "warning code and warning message\n\n\"ERR:<error-code>:<error-message>"
68 "\" - in case it failed, providing an appropriate error code and error"
69 "message\n\nExamples:\n\n\n\n"
70 },
71 { "SUBSCRIBE DB_INSTRUMENT_COUNT",
72 "Client may want to be notified when the number of instruments in a par"
73 "ticular directory in the instruments database is changed by issuing th"
74 "e following command:\n\nSUBSCRIBE DB_INSTRUMENT_COUNT\n\nServer will s"
75 "tart sending the following notification messages:\n\n\"NOTIFY:DB_INSTR"
76 "UMENT_COUNT:<dir-path>\"\n\nwhere <dir-path> will be replaced by the a"
77 "bsolute path name of the directory in the instruments database, in whi"
78 "ch the number of instruments is changed.\n\nNote that when a non-empty"
79 " directory is removed, this event is not sent for the instruments in t"
80 "hat directory.\n\n"
81 },
82 { "SUBSCRIBE MIDI_INSTRUMENT_COUNT",
83 "Client may want to be notified when the number of MIDI instrument maps"
84 " on the back-end changes by issuing the following command:\n\nSUBSCRIB"
85 "E MIDI_INSTRUMENT_COUNT\n\nServer will start sending the following not"
86 "ification messages:\n\n\"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instru"
87 "ments>\"\n\nwhere <map-id> is the numerical ID of the MIDI instrument"
88 "map, in which the nuber of instruments has changed and <instruments> w"
89 "ill be replaced by the new number of MIDI instruments in the specified"
90 " map.\n\n"
91 },
92 { "CLEAR MIDI_INSTRUMENTS",
93 "The front-end can clear a whole MIDI instrument map, that is delete al"
94 "l its entries by sending the following command:\n\nCLEAR MIDI_INSTRUME"
95 "NTS <map>\n\nWhere <map> is the numeric ID of the map to clear.\n\nThe"
96 " front-end can clear all MIDI instrument maps, that is delete all entr"
97 "ies of all maps by sending the following command:\n\nCLEAR MIDI_INSTRU"
98 "MENTS ALL\n\nThe command \"CLEAR MIDI_INSTRUMENTS ALL\" does not delet"
99 "e the maps, only their entries, thus the map's settings like custom na"
100 "me will be preservevd.\n\nPossible Answers:\n\n\"OK\" - always\n\nExam"
101 "ples:\n\nC: \"CLEAR MIDI_INSTRUMENTS 0\"\n\nS: \"OK\"\n\nC: \"CLEAR MI"
102 "DI_INSTRUMENTS ALL\"\n\nS: \"OK\"\n\n"
103 },
104 { "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE",
105 "The front-end can alter the current value of an effect parameter by se"
106 "nding the following command:\n\nSET EFFECT_INSTANCE_INPUT_CONTROL VALU"
107 "E <effect-instance> <input-control> <value>\n\nWhere <effect-instance>"
108 " is the numerical ID of the effect instance as returned by the \"CREAT"
109 "E EFFECT_INSTANCE\" or \"LIST EFFECT_INSTANCES\" command, <input-contr"
110 "ol> is the index of the input control within the numerical bounds as r"
111 "eturned by the \"INPUT_CONTROLS\" field of the \"GET EFFECT_INSTANCE I"
112 "NFO\" command and <value> is the new (optional dotted) floating point"
113 "value for this effect parameter.\n\nPossible Answers:\n\n\"OK\" - in c"
114 "ase the effect was altered successfully\n\n\"ERR:<error-code>:<error-m"
115 "essage>\" - in case it failed, providing an appropriate error code and"
116 " error message\n\nExamples:\n\nC: \"SET EFFECT_INSTANCE_INPUT_CONTROL"
117 "VALUE 0 1 0.5\"\n\nS: \"OK\"\n\n"
118 },
119 { "GET VOLUME",
120 "The client can ask for the current global sampler-wide volume attenuat"
121 "ion by sending the following command:\n\nGET VOLUME\n\nPossible Answer"
122 "s:\n\nThe sampler will always answer by returning the optional dotted"
123 "floating point coefficient, reflecting the current global volume atten"
124 "uation.\n\nNote: it is up to the respective sampler engine whether to"
125 "obey that global volume parameter or not, but in general all engines S"
126 "HOULD use this parameter.\n\n"
127 },
128 { "REMOVE SEND_EFFECT_CHAIN",
129 "The front-end can remove a send effect chain by sending the following"
130 "command:\n\nREMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain>\n\n"
131 "Where <audio-device> should be replaced by the numerical ID of the aud"
132 "io output device as given by the \"CREATE AUDIO_OUTPUT_DEVICE\" or \"L"
133 "IST AUDIO_OUTPUT_DEVICES\" command and <effect-chain> by the numerical"
134 " ID as returned by the \"ADD SEND_EFFECT_CHAIN\" or \"LIST SEND_EFFECT"
135 "_CHAINS\" command.\n\nPossible Answers:\n\n\"OK\" - in case the send e"
136 "ffect chain was removed successfully\n\n\"ERR:<error-code>:<error-mess"
137 "age>\" - if the send effect chain could not be removed\n\nExamples:\n"
138 "\nC: \"REMOVE SEND_EFFECT_CHAIN 0 2\"\n\nS: \"OK\"\n\n"
139 },
140 { "SET CHANNEL MIDI_INSTRUMENT_MAP",
141 "The front-end can assign a MIDI instrument map to a specific sampler c"
142 "hannel by sending the following command:\n\nSET CHANNEL MIDI_INSTRUMEN"
143 "T_MAP <sampler-channel> <map>\n\nWhere <sampler-channel> is the respec"
144 "tive sampler channel number as returned by the \"ADD CHANNEL\" or \"LI"
145 "ST CHANNELS\" command and <map> can have the following possibilites:\n"
146 "\n\"NONE\" - This is the default setting. In this case the sampler cha"
147 "nnel is not assigned any MIDI instrument map and thus will ignore all"
148 "MIDI program change messages.\n\n\"DEFAULT\" - The sampler channel wil"
149 "l always use the default MIDI instrument map to handle MIDI program ch"
150 "ange messages.\n\nnumeric ID - You can assign a specific MIDI instrume"
151 "nt map by replacing <map> with the respective numeric ID of the MIDI i"
152 "nstrument map as returned by the \"LIST MIDI_INSTRUMENT_MAPS\" command"
153 ". Once that map will be deleted, the sampler channel would fall back t"
154 "o \"NONE\".\n\nRead chapter \"MIDI Instrument Mapping\" for details re"
155 "garding MIDI instrument mapping.\n\nPossible Answers:\n\n\"OK\" - on s"
156 "uccess\n\n\"ERR:<error-code>:<error-message>\" - in case it failed, pr"
157 "oviding an appropriate error code and error message\n\nExamples:\n\n\n"
158 "\n"
159 },
160 { "LIST EFFECT_INSTANCES",
161 "The front-end can retrieve the current list of effect instances by sen"
162 "ding the following command:\n\nLIST EFFECT_INSTANCES\n\nPossible Answe"
163 "rs:\n\nThe sampler will answer by returning a comma separated list wit"
164 "h numerical IDs of effects instances.\n\nExample:\n\nC: \"LIST EFFECT_"
165 "INSTANCES\"\n\nS: \"9,11,14,15,16,17,25\"\n\n"
166 },
167 { "SET MIDI_INPUT_PORT_PARAMETER",
168 "Use the following command to alter a specific setting of a MIDI input"
169 "port:\n\nSET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value"
170 ">\n\nWhere <device-id> should be replaced by the numerical ID of the M"
171 "IDI device as returned by the \"CREATE MIDI_INPUT_DEVICE\" or \"LIST M"
172 "IDI_INPUT_DEVICES\" command, <port> by the MIDI port number, <key> by"
173 "the name of the parameter to change and <value> by the new value for t"
174 "his parameter (encapsulated into apostrophes) or NONE (not encapsulate"
175 "d into apostrophes) for specifying no value for parameters allowing a"
176 "list of values.\n\nPossible Answers:\n\n\"OK\" - in case setting was s"
177 "uccessfully changed\n\n\"WRN:<warning-code>:<warning-message>\" - in c"
178 "ase setting was changed successfully, but there are noteworthy issue(s"
179 ") related, providing an appropriate warning code and warning message\n"
180 "\n\"ERR:<error-code>:<error-message>\" - in case it failed, providing"
181 "an appropriate error code and error message\n\nExample:\n\nC: \"SET MI"
182 "DI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'\"\n\nS: \"OK\"\n"
183 "\nC: \"SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE\"\n\nS:"
184 " \"OK\"\n\n"
185 },
186 { "SET CHANNEL AUDIO_OUTPUT_TYPE",
187 "DEPRECATED: THIS COMMAND WILL DISAPPEAR!\n\nThe front-end can alter th"
188 "e audio output type on a specific sampler channel by sending the follo"
189 "wing command:\n\nSET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audi"
190 "o-output-type>\n\nWhere <audio-output-type> is currently either \"ALSA"
191 "\" or \"JACK\" and <sampler-channel> is the respective sampler channel"
192 " number.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"WRN:<warning"
193 "-code>:<warning-message>\" - if audio output type was set, but there a"
194 "re noteworthy issue(s) related, providing an appropriate warning code"
195 "and warning message\n\n\"ERR:<error-code>:<error-message>\" - in case"
196 "it failed, providing an appropriate error code and error message\n\nEx"
197 "amples:\n\n\n\nDeprecated:\n\nShould not be used anymore. This command"
198 " is currently only preserved for backward compatibility.\n\nThis comma"
199 "nd is a relict from times where there was no sophisticated driver mana"
200 "gement yet. Use \"CREATE AUDIO_OUTPUT_DEVICE\" and \"SET CHANNEL AUDIO"
201 "_OUTPUT_DEVICE\" instead.\n\n"
202 },
203 { "GET AVAILABLE_ENGINES",
204 "The front-end can ask for the number of available engines by sending t"
205 "he following command:\n\nGET AVAILABLE_ENGINES\n\nPossible Answers:\n"
206 "\nLinuxSampler will answer by sending the number of available engines."
207 "\n\nExample:\n\nC: \"GET AVAILABLE_ENGINES\"\n\nS: \"4\"\n\n"
208 },
209 { "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS",
210 "Use the following command to list all audio output drivers currently a"
211 "vailable for the LinuxSampler instance:\n\nLIST AVAILABLE_AUDIO_OUTPUT"
212 "_DRIVERS\n\nPossible Answers:\n\nLinuxSampler will answer by sending c"
213 "omma separated character strings, each symbolizing an audio output dri"
214 "ver.\n\nExample:\n\nC: \"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS\"\n\nS: "
215 "\"ALSA,JACK\"\n\n"
216 },
217 { "GET ENGINE INFO",
218 "The front-end can ask for information about a specific engine by sendi"
219 "ng the following command:\n\nGET ENGINE INFO <engine-name>\n\nWhere <e"
220 "ngine-name> is an engine name as obtained by the \"LIST AVAILABLE_ENGI"
221 "NES\" command.\n\nPossible Answers:\n\nLinuxSampler will answer by sen"
222 "ding a <CRLF> separated list. Each answer line begins with the informa"
223 "tion category name followed by a colon and then a space character <SP>"
224 " and finally the info character string to that info category. At the m"
225 "oment the following categories are defined:\n\nDESCRIPTION - arbitrary"
226 " description text about the engine (note that the character string may"
227 " contain escape sequences )\n\nVERSION - arbitrary character string re"
228 "garding the engine's version\n\nThe mentioned fields above don't have"
229 "to be in particular order.\n\nExamples:\n\nC: \"GET ENGINE INFO gig\""
230 "\n\nS: \"DESCRIPTION: GigaSampler Format Engine\"\n\n\"VERSION: 1.110\""
231 "\n\n\".\"\n\nC: \"GET ENGINE INFO sf2\"\n\nS: \"DESCRIPTION: SoundFont"
232 " Format Engine\"\n\n\"VERSION: 1.4\"\n\n\".\"\n\nC: \"GET ENGINE INFO"
233 "sfz\"\n\nS: \"DESCRIPTION: SFZ Format Engine\"\n\n\"VERSION: 1.11\"\n"
234 "\n\".\"\n\n"
235 },
236 { "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO",
237 "Use the following command to get detailed information about a specific"
238 " audio output driver parameter:\n\nGET AUDIO_OUTPUT_DRIVER_PARAMETER I"
239 "NFO <audio> <prm> [<deplist>]\n\nWhere <audio> is the name of the audi"
240 "o output driver as returned by the \"LIST AVAILABLE_AUDIO_OUTPUT_DRIVE"
241 "RS\" command, <prm> a specific parameter name for which information sh"
242 "ould be obtained (as returned by the \"GET AUDIO_OUTPUT_DRIVER INFO\""
243 "command) and <deplist> is an optional list of parameters on which the"
244 "sought parameter <prm> depends on, <deplist> is a list of key-value pa"
245 "irs in form of \"key1=val1 key2=val2 ...\", where character string val"
246 "ues are encapsulated into apostrophes ('). Arguments given with <depli"
247 "st> which are not dependency parameters of <prm> will be ignored, mean"
248 "s the front-end application can simply put all parameters into <deplis"
249 "t> with the values already selected by the user.\n\nPossible Answers:"
250 "\n\nLinuxSampler will answer by sending a <CRLF> separated list. Each a"
251 "nswer line begins with the information category name followed by a col"
252 "on and then a space character <SP> and finally the info character stri"
253 "ng to that info category. There are information which is always return"
254 "ed, independently of the given driver parameter and there are optional"
255 " information which is only shown dependently to given driver parameter"
256 ". At the moment the following information categories are defined:\n\nT"
257 "YPE - either \"BOOL\" for boolean value(s) or \"INT\" for integer valu"
258 "e(s) or \"FLOAT\" for dotted number(s) or \"STRING\" for character str"
259 "ing(s) (always returned, no matter which driver parameter)\n\nDESCRIPT"
260 "ION - arbitrary text describing the purpose of the parameter (always r"
261 "eturned, no matter which driver parameter)\n\nMANDATORY - either true"
262 "or false, defines if this parameter must be given when the device is t"
263 "o be created with the 'CREATE AUDIO_OUTPUT_DEVICE' command (always ret"
264 "urned, no matter which driver parameter)\n\nFIX - either true or false"
265 ", if false then this parameter can be changed at any time, once the de"
266 "vice is created by the 'CREATE AUDIO_OUTPUT_DEVICE' command (always re"
267 "turned, no matter which driver parameter)\n\nMULTIPLICITY - either tru"
268 "e or false, defines if this parameter allows only one value or a list"
269 "of values, where true means multiple values and false only a single va"
270 "lue allowed (always returned, no matter which driver parameter)\n\nDEP"
271 "ENDS - comma separated list of parameters this parameter depends on, m"
272 "eans the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX' and 'PO"
273 "SSIBILITIES' might depend on these listed parameters, for example assu"
274 "ming that an audio driver (like the ALSA driver) offers parameters 'ca"
275 "rd' and 'samplerate' then parameter 'samplerate' would depend on 'card"
276 "' because the possible values for 'samplerate' depends on the sound ca"
277 "rd which can be chosen by the 'card' parameter (optionally returned, d"
278 "ependent to driver parameter)\n\nDEFAULT - reflects the default value"
279 "for this parameter which is used when the device is created and not ex"
280 "plicitly given with the 'CREATE AUDIO_OUTPUT_DEVICE' command, in case"
281 "of MULTIPLCITY=true, this is a comma separated list, that's why charac"
282 "ter strings are encapsulated into apostrophes (') (optionally returned"
283 ", dependent to driver parameter)\n\nRANGE_MIN - defines lower limit of"
284 " the allowed value range for this parameter, can be an integer value a"
285 "s well as a dotted number, this parameter is often used in conjunction"
286 " with RANGE_MAX, but may also appear without (optionally returned, dep"
287 "endent to driver parameter)\n\nRANGE_MAX - defines upper limit of the"
288 "allowed value range for this parameter, can be an integer value as wel"
289 "l as a dotted number, this parameter is often used in conjunction with"
290 " RANGE_MIN, but may also appear without (optionally returned, dependen"
291 "t to driver parameter)\n\nPOSSIBILITIES - comma separated list of poss"
292 "ible values for this parameter, character strings are encapsulated int"
293 "o apostrophes (optionally returned, dependent to driver parameter)\n\n"
294 "The mentioned fields above don't have to be in particular order.\n\nEx"
295 "amples:\n\nC: \"GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD\"\n\n"
296 "S: \"DESCRIPTION: sound card to be used\"\n\n\"TYPE: STRING\"\n\n\"MAN"
297 "DATORY: false\"\n\n\"FIX: true\"\n\n\"MULTIPLICITY: false\"\n\n\"DEFAU"
298 "LT: '0,0'\"\n\n\"POSSIBILITIES: '0,0','1,0','2,0'\"\n\n\".\"\n\nC: \"G"
299 "ET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE\"\n\nS: \"DESCRI"
300 "PTION: output sample rate in Hz\"\n\n\"TYPE: INT\"\n\n\"MANDATORY: fal"
301 "se\"\n\n\"FIX: false\"\n\n\"MULTIPLICITY: false\"\n\n\"DEPENDS: card\""
302 "\n\n\"DEFAULT: 44100\"\n\n\".\"\n\nC: \"GET AUDIO_OUTPUT_DRIVER_PARAME"
303 "TER INFO ALSA SAMPLERATE CARD='0,0'\"\n\nS: \"DESCRIPTION: output samp"
304 "le rate in Hz\"\n\n\"TYPE: INT\"\n\n\"MANDATORY: false\"\n\n\"FIX: fal"
305 "se\"\n\n\"MULTIPLICITY: false\"\n\n\"DEPENDS: card\"\n\n\"DEFAULT: 441"
306 "00\"\n\n\"RANGE_MIN: 22050\"\n\n\"RANGE_MAX: 96000\"\n\n\".\"\n\n"
307 },
308 { "SEND CHANNEL MIDI_DATA",
309 "The front-end can send MIDI events to a specific sampler channel by se"
310 "nding the following command:\n\nSEND CHANNEL MIDI_DATA <midi-msg> <sam"
311 "pler-chan> <arg1> <arg2>\n\nWhere <sampler-chan> is the sampler channe"
312 "l number as returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" comma"
313 "nd, <arg1> and <arg2> arguments depend on the <midi-msg> argument, whi"
314 "ch specifies the MIDI message type. Currently, the following MIDI mess"
315 "ages are supported:\n\n\"NOTE_ON\" - For turning on MIDI notes, where"
316 "<arg1> specifies the key number and <arg2> the velocity as described i"
317 "n the MIDI specification.\n\n\"NOTE_OFF\" - For turning a currently pl"
318 "aying MIDI note off, where <arg1> specifies the key number and <arg2>"
319 "the velocity as described in the MIDI specification.\n\n\"CC\" - For c"
320 "hanging a MIDI controller, where <arg1> specifies the controller numbe"
321 "r and <arg2> the new value of the controller as described in the Contr"
322 "ol Change section of the MIDI specification.\n\nCAUTION: This command"
323 "is provided for implementations of virtual MIDI keyboards and no realt"
324 "ime guarantee whatsoever will be made!\n\nPossible Answers:\n\n\"OK\""
325 "- on success\n\n\"ERR:<error-code>:<error-message>\" - in case it fail"
326 "ed, providing an appropriate error code and error message\n\nExample:"
327 "\n\nC: \"SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112\"\n\nS: \"OK\"\n\n"
328 },
329 { "EDIT INSTRUMENT",
330 "The front-end can request to open an appropriate instrument editor app"
331 "lication by sending the following command:\n\nEDIT CHANNEL INSTRUMENT"
332 "<sampler-channel>\n\nWhere <sampler-channel> should be replaced by the"
333 " number of the sampler channel as given by the \"ADD CHANNEL\" or \"LI"
334 "ST CHANNELS\" command.\n\nThe sampler will try to ask all registered i"
335 "nstrument editors (or to be more specific: their sampler plugins) whet"
336 "her they are capable to handle the instrument on the given sampler cha"
337 "nnel. The sampler will simply use the first instrument editor applicat"
338 "ion which replied with a positive answer and spawn that instrument edi"
339 "tor application within the sampler's process and provide that applicat"
340 "ion access to the instrument's data structures, so both applications c"
341 "an share and access the same instruments data at the same time, thus a"
342 "llowing to immediately hear changes with the sampler made by the instr"
343 "ument editor.\n\nNote: consequently instrument editors are always spaw"
344 "ned locally on the same machine where the sampler is running on!\n\nPo"
345 "ssible Answers:\n\n\"OK\" - when an appropriate instrument editor was"
346 "launched\n\n\"WRN:<warning-code>:<warning-message>\" - when an appropr"
347 "iate instrument editor was launched, but there are noteworthy issues\n"
348 "\n\"ERR:<error-code>:<error-message>\" - when an appropriate instrumen"
349 "t editor could not be launched\n\nExamples:\n\nC: \"EDIT CHANNEL INSTR"
350 "UMENT 0\"\n\nS: \"OK\"\n\n"
351 },
352 { "ADD DB_INSTRUMENT_DIRECTORY",
353 "The front-end can add a new instrument directory to the instruments da"
354 "tabase by sending the following command:\n\nADD DB_INSTRUMENT_DIRECTOR"
355 "Y <dir>\n\nWhere <dir> is the absolute path name of the directory to b"
356 "e created (encapsulated into apostrophes).\n\nPossible Answers:\n\n\"O"
357 "K\" - on success\n\n\"ERR:<error-code>:<error-message>\" - when the di"
358 "rectory could not be created, which can happen if the directory alread"
359 "y exists or the name contains not allowed symbols\n\nExamples:\n\nC: "
360 "\"ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'\"\n\nS: \"OK\"\n\n"
361 },
362 { "REMOVE DB_INSTRUMENT",
363 "The front-end can remove a particular instrument from the instruments"
364 "database by sending the following command:\n\nREMOVE DB_INSTRUMENT <in"
365 "str_path>\n\nWhere <instr_path> is the absolute path name (in the inst"
366 "ruments database) of the instrument to remove.\n\nPossible Answers:\n"
367 "\n\"OK\" - if the instrument is removed successfully\n\n\"ERR:<error-co"
368 "de>:<error-message>\" - if the given path does not exist or is a direc"
369 "tory.\n\nExamples:\n\nC: \"REMOVE DB_INSTRUMENT '/Piano Collection/Bos"
370 "endorfer 290'\"\n\nS: \"OK\"\n\n"
371 },
372 { "GET MIDI_INSTRUMENT_MAPS",
373 "The front-end can retrieve the current amount of MIDI instrument maps"
374 "by sending the following command:\n\nGET MIDI_INSTRUMENT_MAPS\n\nPossi"
375 "ble Answers:\n\nThe sampler will answer by returning the current numbe"
376 "r of MIDI instrument maps.\n\nExample:\n\nC: \"GET MIDI_INSTRUMENT_MAP"
377 "S\"\n\nS: \"2\"\n\n"
378 },
379 { "SET CHANNEL AUDIO_OUTPUT_DEVICE",
380 "The front-end can set the audio output device on a specific sampler ch"
381 "annel by sending the following command:\n\nSET CHANNEL AUDIO_OUTPUT_DE"
382 "VICE <sampler-channel> <audio-device-id>\n\nWhere <sampler-channel> is"
383 " the respective sampler channel number as returned by the \"ADD CHANNE"
384 "L\" or \"LIST CHANNELS\" command and <audio-device-id> is the numerica"
385 "l ID of the audio output device as given by the \"CREATE AUDIO_OUTPUT_"
386 "DEVICE\" or \"LIST AUDIO_OUTPUT_DEVICES\" command.\n\nPossible Answers"
387 ":\n\n\"OK\" - on success\n\n\"WRN:<warning-code>:<warning-message>\" -"
388 " if audio output device was set, but there are noteworthy issue(s) rel"
389 "ated, providing an appropriate warning code and warning message\n\n\"E"
390 "RR:<error-code>:<error-message>\" - in case it failed, providing an ap"
391 "propriate error code and error message\n\nExamples:\n\n\n\n"
392 },
393 { "REMOVE CHANNEL MIDI_INPUT",
394 "The front-end can remove one ore more MIDI input(s) on a specific samp"
395 "ler channel by sending the following command:\n\nREMOVE CHANNEL MIDI_I"
396 "NPUT <sampler-channel> [<midi-device-id> [<midi-input-port>]]\n\nWhere"
397 " <sampler-channel> is the sampler channel number as returned by the \""
398 "ADD CHANNEL\" or \"LIST CHANNELS\" command and <midi-device-id> and <m"
399 "idi-input-port> are optional numerical IDs defining the MIDI input dev"
400 "ice and one of its MIDI ports as returned by the \"LIST CHANNEL MIDI_I"
401 "NPUTS\" command.\n\nIf <midi-input-port> is omitted, then all MIDI inp"
402 "ut ports of <midi-device-id> are disconnected from this sampler channe"
403 "l.\n\nIf both, <midi-device-id> and <midi-input-port> are omitted, the"
404 "n all MIDI input ports currently connected to this sampler channel are"
405 " disconnected from this sampler channel.\n\nPossible Answers:\n\n\"OK"
406 "\" - on success\n\n\"WRN:<warning-code>:<warning-message>\" - if MIDI i"
407 "nput porst were disconnected, but there are noteworthy issue(s) relate"
408 "d, providing an appropriate warning code and warning message\n\n\"ERR:"
409 "<error-code>:<error-message>\" - in case it failed, providing an appro"
410 "priate error code and error message\n\nExamples:\n\nC: \"REMOVE CHANNE"
411 "L MIDI_INPUT 0\"\n\nS: \"OK\"\n\nC: \"REMOVE CHANNEL MIDI_INPUT 1\"\n"
412 "\nS: \"OK\"\n\nC: \"REMOVE CHANNEL MIDI_INPUT 1 2 0\"\n\nS: \"OK\"\n\nS"
413 "ince:\n\nIntroduced with LSCP v1.6\n\n"
414 },
415 { "SUBSCRIBE GLOBAL_INFO",
416 "Client may want to be notified when changes to the global settings of"
417 "the sampler were made by issuing the following command:\n\nSUBSCRIBE G"
418 "LOBAL_INFO\n\nServer will start sending the following types of notific"
419 "ation messages:\n\n\"NOTIFY:GLOBAL_INFO:VOLUME <volume>\" - Notifies t"
420 "hat the golbal volume of the sampler is changed, where <volume> will b"
421 "e replaced by the optional dotted floating point value, reflecting the"
422 " new global volume parameter.\n\n\"NOTIFY:GLOBAL_INFO:VOICES <max-voic"
423 "es>\" - Notifies that the golbal limit of the sampler for maximum voic"
424 "es is changed, where <max-voices> will be an integer value, reflecting"
425 " the new global voice limit parameter.\n\n\"NOTIFY:GLOBAL_INFO:STREAMS"
426 " <max-streams>\" - Notifies that the golbal limit of the sampler for m"
427 "aximum disk streams is changed, where <max-streams> will be an integer"
428 " value, reflecting the new global disk streams limit parameter.\n\n"
429 },
430 { "MOVE DB_INSTRUMENT",
431 "The front-end can move a specific instrument to another directory by s"
432 "ending the following command:\n\nMOVE DB_INSTRUMENT <instr> <dst>\n\nW"
433 "here <instr> is the absolute path name of the instrument to move and <"
434 "dst> is the directory where the instrument will be moved to.\n\nPossib"
435 "le Answers:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:<error-messag"
436 "e>\" - in case the given instrument does not exists, or if an instrume"
437 "nt with name equal to the name of the specified instrument already exi"
438 "sts in the destination directory.\n\nExample:\n\nC: \"MOVE DB_INSTRUME"
439 "NT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'\""
440 "\n\nS: \"OK\"\n\n"
441 },
442 { "SET CHANNEL AUDIO_OUTPUT_CHANNEL",
443 "The front-end can alter the audio output channel on a specific sampler"
444 " channel by sending the following command:\n\nSET CHANNEL AUDIO_OUTPUT"
445 "_CHANNEL <sampler-chan> <audio-out> <audio-in>\n\nWhere <sampler-chan>"
446 " is the sampler channel number as returned by the \"ADD CHANNEL\" or "
447 "\"LIST CHANNELS\" command, <audio-out> is the numerical ID of the sampl"
448 "er channel's audio output channel which should be rerouted and <audio-"
449 "in> is the numerical ID of the audio channel of the selected audio out"
450 "put device where <audio-out> should be routed to.\n\nPossible Answers:"
451 "\n\n\"OK\" - on success\n\n\"WRN:<warning-code>:<warning-message>\" -"
452 "if audio output channel was set, but there are noteworthy issue(s) rel"
453 "ated, providing an appropriate warning code and warning message\n\n\"E"
454 "RR:<error-code>:<error-message>\" - in case it failed, providing an ap"
455 "propriate error code and error message\n\nExamples:\n\n\n\n"
456 },
457 { "SET DB_INSTRUMENT FILE_PATH",
458 "The front-end can substitute all occurrences of an instrument file in"
459 "the instruments database with a new one by sending the following comma"
460 "nd:\n\nSET DB_INSTRUMENT FILE_PATH <old_path> <new_path>\n\nWhere <old"
461 "_path> is the absolute path name of the instrument file to substitute"
462 "with <new_path>.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"ERR:"
463 "<error-code>:<error-message>\" - in case it failed, providing an appro"
464 "priate error code and error message.\n\nExample:\n\nC: \"SET DB_INSTRU"
465 "MENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 2"
466 "90.gig'\"\n\nS: \"OK\"\n\n"
467 },
468 { "CREATE FX_SEND",
469 "The front-end can create an additional effect send on a specific sampl"
470 "er channel by sending the following command:\n\nCREATE FX_SEND <sample"
471 "r-channel> <midi-ctrl> [<name>]\n\nWhere <sampler-channel> is the resp"
472 "ective sampler channel number as returned by the \"ADD CHANNEL\" or \""
473 "LIST CHANNELS\" command, that is the sampler channel on which the effe"
474 "ct send should be created on, <midi-ctrl> is a number between 0..127 d"
475 "efining the MIDI controller which can alter the effect send level and"
476 "<name> is an optional argument defining a name for the effect send ent"
477 "ity. The name does not have to be unique, but MUST be encapsulated int"
478 "o apostrophes and supports escape sequences as described in chapter \""
479 " Character Set and Escape Sequences \".\n\nNote: there are two possibl"
480 "e approaches to apply audio effects with FX sends: you can either use"
481 "a) internal effects or b) external effects. By default, that is as ini"
482 "tial routing, effect sends are automatically routed directly to the sa"
483 "mpler channel's audio output device and the effect send's audio channe"
484 "ls are by default automatically routed to the last audio channels of t"
485 "hat audio output device (for the purpose of applying effects externall"
486 "y that is, e.g. by using another application), that way you can i.e. f"
487 "irst increase the amount of audio channels on the audio output device"
488 "for having dedicated effect send output channels and when \"CREATE FX_"
489 "SEND\" is called, those channels will automatically be picked. You can"
490 " alter the destination channels however with \"SET FX_SEND AUDIO_OUTPU"
491 "T_CHANNEL\" . If your intention is rather to use internal effects inst"
492 "ead of external effects, then you first need to load those internal ef"
493 "fects and then assign the FX sends to the desired internal effect by s"
494 "ending \"SET FX_SEND EFFECT\" .\n\nNote: Create effect sends on a samp"
495 "ler channel only when needed, because having effect sends on a sampler"
496 " channel will decrease runtime performance, because for implementing c"
497 "hannel effect sends, separate (sampler channel local) audio buffers ar"
498 "e needed to render and mix the voices and route the audio signal after"
499 "wards to the master outputs and effect send outputs (along with their"
500 "respective effect send levels). A sampler channel without effect sends"
501 " however can mix its voices directly into the audio output devices's a"
502 "udio buffers and is thus faster.\n\nPossible Answers:\n\n\"OK[<fx-send"
503 "-id>]\" - in case a new effect send could be added to the sampler chan"
504 "nel, where <fx-send-id> reflects the unique ID of the newly created ef"
505 "fect send entity\n\n\"ERR:<error-code>:<error-message>\" - when a new"
506 "effect send could not be added, i.e. due to invalid parameters\n\nExam"
507 "ples:\n\nC: \"CREATE FX_SEND 0 91 'Reverb Send'\"\n\nS: \"OK[0]\"\n\nC"
508 ": \"CREATE FX_SEND 0 93\"\n\nS: \"OK[1]\"\n\n"
509 },
510 { "GET DB_INSTRUMENTS_JOB INFO",
511 "The front-end can ask for the current status of a particular database"
512 "instruments job by sending the following command:\n\nGET DB_INSTRUMENT"
513 "S_JOB INFO <job-id>\n\nWhere <job-id> should be replaced by the numeri"
514 "cal ID of the job the front-end is interested in.\n\nPossible Answers:"
515 "\n\nLinuxSampler will answer by sending a <CRLF> separated list. Each"
516 "answer line begins with the settings category name followed by a colon"
517 " and then a space character <SP> and finally the info character string"
518 " to that setting category. At the moment the following categories are"
519 "defined:\n\nFILES_TOTAL - The total number of files scheduled for scan"
520 "ning\n\nFILES_SCANNED - The current number of scanned files\n\nSCANNIN"
521 "G - The absolute path name of the file which is currently being scanne"
522 "d\n\nSTATUS - An integer value between 0 and 100 indicating the scanni"
523 "ng progress percentage of the file which is currently being scanned\n"
524 "\nThe mentioned fields above don't have to be in particular order.\n\nE"
525 "xample:\n\nC: \"GET DB_INSTRUMENTS_JOB INFO 2\"\n\nS: \"FILES_TOTAL: 1"
526 "2\"\n\n\"FILES_SCANNED: 7\"\n\n\"SCANNING: /home/me/gigs/Bosendorfer 2"
527 "90.gig\"\n\n\"STATUS: 42\"\n\n\".\"\n\n"
528 },
529 { "REMOVE FX_SEND EFFECT",
530 "The front-end can (re-)assign a destination effect to an effect send b"
531 "y sending the following command:\n\nREMOVE FX_SEND EFFECT <sampler-cha"
532 "n> <fx-send-id>\n\nWhere <sampler-chan> is the sampler channel number"
533 "as returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" command, <fx-s"
534 "end-id> reflects the numerical ID of the effect send entity as returne"
535 "d by the \"CREATE FX_SEND\" or \"LIST FX_SENDS\" command.\n\nAfter the"
536 " destination effect has been removed from the effect send, the audio s"
537 "ignal of the effect send will be routed directly to the audio output d"
538 "evice, according to the audio channel routing setting of the effect se"
539 "nd.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:"
540 "<error-message>\" - in case it failed, providing an appropriate error"
541 "code and error message\n\nExample:\n\nC: \"REMOVE FX_SEND EFFECT 0 0\""
542 "\n\nS: \"OK\"\n\n"
543 },
544 { "GET MIDI_INPUT_DRIVER INFO",
545 "Use the following command to get detailed information about a specific"
546 " MIDI input driver:\n\nGET MIDI_INPUT_DRIVER INFO <midi-input-driver>"
547 "\n\nWhere <midi-input-driver> is the name of the MIDI input driver as r"
548 "eturned by the \"LIST AVAILABLE_MIDI_INPUT_DRIVERS\" command.\n\nPossi"
549 "ble Answers:\n\nLinuxSampler will answer by sending a <CRLF> separated"
550 " list. Each answer line begins with the information category name foll"
551 "owed by a colon and then a space character <SP> and finally the info c"
552 "haracter string to that info category. At the moment the following inf"
553 "ormation categories are defined:\n\nDESCRIPTION - arbitrary descriptio"
554 "n text about the MIDI input driver\n\nVERSION - arbitrary character st"
555 "ring regarding the driver's version\n\nPARAMETERS - comma separated li"
556 "st of all parameters available for the given MIDI input driver\n\nThe"
557 "mentioned fields above don't have to be in particular order.\n\nExampl"
558 "e:\n\nC: \"GET MIDI_INPUT_DRIVER INFO ALSA\"\n\nS: \"DESCRIPTION: Adva"
559 "nced Linux Sound Architecture\"\n\n\"VERSION: 1.0\"\n\n\"PARAMETERS: D"
560 "RIVER,ACTIVE\"\n\n\".\"\n\n"
561 },
562 { "REMOVE MIDI_INSTRUMENT_MAP",
563 "The front-end can delete a particular MIDI instrument map by sending t"
564 "he following command:\n\nREMOVE MIDI_INSTRUMENT_MAP <map>\n\nWhere <ma"
565 "p> reflects the unique ID of the map to delete as returned by the \"LI"
566 "ST MIDI_INSTRUMENT_MAPS\" command.\n\nThe front-end can delete all MID"
567 "I instrument maps by sending the following command:\n\nREMOVE MIDI_INS"
568 "TRUMENT_MAP ALL\n\nPossible Answers:\n\n\"OK\" - in case the map(s) co"
569 "uld be deleted\n\n\"ERR:<error-code>:<error-message>\" - when the give"
570 "n map does not exist\n\nExamples:\n\nC: \"REMOVE MIDI_INSTRUMENT_MAP 0"
571 "\"\n\nS: \"OK\"\n\nC: \"REMOVE MIDI_INSTRUMENT_MAP ALL\"\n\nS: \"OK\""
572 "\n\n"
573 },
574 { "GET CHANNEL STREAM_COUNT",
575 "The front-end can ask for the current number of active disk streams on"
576 " a sampler channel by sending the following command:\n\nGET CHANNEL ST"
577 "REAM_COUNT <sampler-channel>\n\nWhere <sampler-channel> is the sampler"
578 " channel number the front-end is interested in as returned by the \"AD"
579 "D CHANNEL\" or \"LIST CHANNELS\" command.\n\nPossible Answers:\n\nLinu"
580 "xSampler will answer by returning the number of active disk streams on"
581 " that channel in case the engine supports disk streaming, if the engin"
582 "e doesn't support disk streaming it will return \"NA\" for not availab"
583 "le.\n\nExample:\n\n\n\n"
584 },
585 { "ADD CHANNEL",
586 "A new sampler channel can be added to the end of the sampler channel l"
587 "ist by sending the following command:\n\nADD CHANNEL\n\nThis will incr"
588 "ement the sampler channel count by one and the new sampler channel wil"
589 "l be appended to the end of the sampler channel list. The front-end sh"
590 "ould send the respective, related commands right after to e.g. load an"
591 " engine, load an instrument and setting input, output method and event"
592 "ually other commands to initialize the new channel. The front-end shou"
593 "ld use the sampler channel returned by the answer of this command to p"
594 "erform the previously recommended commands, to avoid race conditions e"
595 ".g. with other front-ends that might also have sent an \"ADD CHANNEL\""
596 " command.\n\nPossible Answers:\n\n\"OK[<sampler-channel>]\" - in case"
597 "a new sampler channel could be added, where <sampler-channel> reflects"
598 " the channel number of the new created sampler channel which should be"
599 " used to set up the sampler channel by sending subsequent initializati"
600 "on commands\n\n\"WRN:<warning-code>:<warning-message>\" - in case a ne"
601 "w channel was added successfully, but there are noteworthy issue(s) re"
602 "lated, providing an appropriate warning code and warning message\n\n\""
603 "ERR:<error-code>:<error-message>\" - in case it failed, providing an a"
604 "ppropriate error code and error message\n\nExample:\n\n\n\n"
605 },
606 { "SUBSCRIBE CHANNEL_INFO",
607 "Client may want to be notified when changes were made to sampler chann"
608 "els on the back-end by issuing the following command:\n\nSUBSCRIBE CHA"
609 "NNEL_INFO\n\nServer will start sending the following notification mess"
610 "ages:\n\n\"NOTIFY:CHANNEL_INFO:<sampler-channel>\"\n\nwhere <sampler-c"
611 "hannel> will be replaced by the sampler channel the channel info chang"
612 "e occurred. The front-end will have to send the respective command to"
613 "actually get the channel info. Because these messages will be triggere"
614 "d by LSCP commands issued by other clients rather than real time event"
615 "s happening on the server, it is believed that an empty notification m"
616 "essage is sufficient here.\n\n"
617 },
618 { "UNSUBSCRIBE",
619 "The front-end can unregister itself if it doesn't want to receive even"
620 "t messages anymore by sending the following command:\n\nUNSUBSCRIBE <e"
621 "vent-id>\n\nWhere <event-id> will be replaced by the respective event"
622 "that client doesn't want to receive anymore.\n\nPossible Answers:\n\n"
623 "\"OK\" - on success\n\n\"WRN:<warning-code>:<warning-message>\" - if un"
624 "registration succeeded, but there are noteworthy issue(s) related, pro"
625 "viding an appropriate warning code and warning message\n\n\"ERR:<error"
626 "-code>:<error-message>\" - in case it failed, providing an appropriate"
627 " error code and error message\n\nExamples:\n\n\n\n"
628 },
629 { "GET TOTAL_VOICE_COUNT",
630 "The front-end can ask for the current number of active voices on the s"
631 "ampler by sending the following command:\n\nGET TOTAL_VOICE_COUNT\n\nP"
632 "ossible Answers:\n\nLinuxSampler will answer by returning the number o"
633 "f all active voices on the sampler.\n\n"
634 },
635 { "SUBSCRIBE STREAM_COUNT",
636 "Client may want to be notified when the number of streams on the back-"
637 "end changes by issuing the following command: SUBSCRIBE STREAM_COUNT\n"
638 "\nSUBSCRIBE STREAM_COUNT\n\nServer will start sending the following no"
639 "tification messages:\n\n\"NOTIFY:STREAM_COUNT:<sampler-channel> <strea"
640 "ms>\"\n\nwhere <sampler-channel> will be replaced by the sampler chann"
641 "el the stream count change occurred and <streams> by the new number of"
642 " active disk streams on that channel.\n\n"
643 },
644 { "SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT",
645 "Client may want to be notified when the number of instrument directori"
646 "es in a particular directory in the instruments database is changed by"
647 " issuing the following command:\n\nSUBSCRIBE DB_INSTRUMENT_DIRECTORY_C"
648 "OUNT\n\nServer will start sending the following notification messages:"
649 "\n\n\"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>\"\n\nwhere <dir-"
650 "path> will be replaced by the absolute path name of the directory in t"
651 "he instruments database, in which the number of directories is changed"
652 ".\n\nNote that when a non-empty directory is removed, this event is no"
653 "t sent for the subdirectories in that directory.\n\n"
654 },
655 { "SET FX_SEND MIDI_CONTROLLER",
656 "The front-end can alter the MIDI controller of an effect send entity b"
657 "y sending the following command:\n\nSET FX_SEND MIDI_CONTROLLER <sampl"
658 "er-chan> <fx-send-id> <midi-ctrl>\n\nWhere <sampler-chan> is the sampl"
659 "er channel number as returned by the \"ADD CHANNEL\" or \"LIST CHANNEL"
660 "S\" command, <fx-send-id> reflects the numerical ID of the effect send"
661 " entity as returned by the \"CREATE FX_SEND\" or \"LIST FX_SENDS\" com"
662 "mand and <midi-ctrl> reflects the MIDI controller which shall be able"
663 "to modify the effect send's send level.\n\nPossible Answers:\n\n\"OK\""
664 " - on success\n\n\"WRN:<warning-code>:<warning-message>\" - if MIDI co"
665 "ntroller was set, but there are noteworthy issue(s) related, providing"
666 " an appropriate warning code and warning message\n\n\"ERR:<error-code>"
667 ":<error-message>\" - in case it failed, providing an appropriate error"
668 " code and error message\n\nExample:\n\nC: \"SET FX_SEND MIDI_CONTROLLE"
669 "R 0 0 91\"\n\nS: \"OK\"\n\n"
670 },
671 { "MOVE DB_INSTRUMENT_DIRECTORY",
672 "The front-end can move a specific instrument directory by sending the"
673 "following command:\n\nMOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>\n\nWher"
674 "e <dir> is the absolute path name of the directory to move and <dst> i"
675 "s the location where the directory will be moved to.\n\nPossible Answe"
676 "rs:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:<error-message>\" - i"
677 "n case a given directory does not exists, or if a directory with name"
678 "equal to the name of the specified directory already exists in the des"
679 "tination directory. Error is also thrown when trying to move a directo"
680 "ry to a subdirectory of itself.\n\nExample:\n\nC: \"MOVE DB_INSTRUMENT"
681 "_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'\"\n\nS: \"OK\"\n\n"
682 },
683 { "SUBSCRIBE DB_INSTRUMENTS_JOB_INFO",
684 "Client may want to be notified when the status of particular database"
685 "instruments job is changed by issuing the following command:\n\nSUBSCR"
686 "IBE DB_INSTRUMENTS_JOB_INFO\n\nServer will start sending the following"
687 " notification messages:\n\n\"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>\""
688 "\n\nwhere <job-id> will be replaced by the numerical ID of the job, wh"
689 "ich status is changed. The front-end will have to send the respective"
690 "command to actually get the status info. Because these messages will b"
691 "e triggered by LSCP commands issued by other clients rather than real"
692 "time events happening on the server, it is believed that an empty noti"
693 "fication message is sufficient here.\n\n"
694 },
695 { "LIST SEND_EFFECT_CHAINS",
696 "The front-end can retrieve the current list of send effect chains of a"
697 "n audio output device by sending the following command:\n\nLIST SEND_E"
698 "FFECT_CHAINS <audio-device>\n\nWhere <audio-device> should be replaced"
699 " by the numerical ID of the audio output device as given by the \"CREA"
700 "TE AUDIO_OUTPUT_DEVICE\" or \"LIST AUDIO_OUTPUT_DEVICES\" command.\n\n"
701 "Possible Answers:\n\nThe sampler will answer by returning a comma sepa"
702 "rated list with numerical IDs of send effect chains of the supplied au"
703 "dio output device.\n\nExamples:\n\nC: \"LIST SEND_EFFECT_CHAINS 0\"\n"
704 "\nS: \"3,4,7\"\n\n"
705 },
706 { "SET FX_SEND LEVEL",
707 "The front-end can alter the current send level of an effect send entit"
708 "y by sending the following command:\n\nSET FX_SEND LEVEL <sampler-chan"
709 "> <fx-send-id> <volume>\n\nWhere <sampler-chan> is the sampler channel"
710 " number as returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" comman"
711 "d, <fx-send-id> reflects the numerical ID of the effect send entity as"
712 " returned by the \"CREATE FX_SEND\" or \"LIST FX_SENDS\" command and <"
713 "volume> is an optionally dotted positive number (a value smaller than"
714 "1.0 means attenuation, whereas a value greater than 1.0 means amplific"
715 "ation) reflecting the new send level.\n\nPossible Answers:\n\n\"OK\" -"
716 " on success\n\n\"WRN:<warning-code>:<warning-message>\" - if new send"
717 "level was set, but there are noteworthy issue(s) related, providing an"
718 " appropriate warning code and warning message\n\n\"ERR:<error-code>:<e"
719 "rror-message>\" - in case it failed, providing an appropriate error co"
720 "de and error message\n\nExample:\n\nC: \"SET FX_SEND LEVEL 0 0 0.15\""
721 "\n\nS: \"OK\"\n\n"
722 },
723 { "GET FX_SENDS",
724 "The front-end can ask for the amount of effect sends on a specific sam"
725 "pler channel by sending the following command:\n\nGET FX_SENDS <sample"
726 "r-channel>\n\nWhere <sampler-channel> is the respective sampler channe"
727 "l number as returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" comma"
728 "nd.\n\nPossible Answers:\n\nThe sampler will answer by returning the n"
729 "umber of effect sends on the given sampler channel.\n\nExample:\n\nC:"
730 "\"GET FX_SENDS 0\"\n\nS: \"2\"\n\n"
731 },
732 { "ADD SEND_EFFECT_CHAIN",
733 "The front-end can add a send effect chain by sending the following com"
734 "mand:\n\nADD SEND_EFFECT_CHAIN <audio-device>\n\nWhere <audio-device>"
735 "should be replaced by the numerical ID of the audio output device as g"
736 "iven by the \"CREATE AUDIO_OUTPUT_DEVICE\" or \"LIST AUDIO_OUTPUT_DEVI"
737 "CES\" command.\n\nPossible Answers:\n\n\"OK[<effect-chain>]\" - in cas"
738 "e the send effect chain was added successfully, where <effect-chain> i"
739 "s the numerical ID of the new send effect chain\n\n\"ERR:<error-code>:"
740 "<error-message>\" - if the send effect chain could not be added\n\nExa"
741 "mples:\n\nC: \"ADD SEND_EFFECT_CHAIN 0\"\n\nS: \"OK[2]\"\n\n"
742 },
743 { "UNMAP MIDI_INSTRUMENT",
744 "The front-end can delete an entry from a MIDI instrument map by sendin"
745 "g the following command:\n\nUNMAP MIDI_INSTRUMENT <map> <midi_bank> <m"
746 "idi_prog>\n\nWhere <map> is the numeric ID of the MIDI instrument map,"
747 " <midi_bank> is an integer value between 0..16383 reflecting the MIDI"
748 "bank value and <midi_prog> an integer value between 0..127 reflecting"
749 "the MIDI program value of the map's entrie's key index triple.\n\nPoss"
750 "ible Answers:\n\n\"OK\" - usually\n\n\"ERR:<error-code>:<error-message"
751 ">\" - when index out of bounds\n\nExample:\n\nC: \"UNMAP MIDI_INSTRUME"
752 "NT 0 2 127\"\n\nS: \"OK\"\n\n"
753 },
754 { "SET CHANNEL MIDI_INPUT_DEVICE",
755 "DEPRECATED: THIS COMMAND WILL DISAPPEAR!\n\nThe front-end can set the"
756 "MIDI input device on a specific sampler channel by sending the followi"
757 "ng command:\n\nSET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-d"
758 "evice-id>\n\nWhere <sampler-channel> is the sampler channel number as"
759 "returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" command and <midi"
760 "-device-id> is the numerical ID of the MIDI input device as returned b"
761 "y the \"CREATE MIDI_INPUT_DEVICE\" or \"LIST MIDI_INPUT_DEVICES\" comm"
762 "and.\n\nIf more than 1 MIDI inputs are currently connected to this sam"
763 "pler channel: Sending this command will disconnect ALL currently conne"
764 "cted MIDI input ports connected to this sampler channel before establi"
765 "shing the new MIDI input connection. So this command does NOT add the"
766 "connection, it replaces all existing ones instead. This behavior is du"
767 "e to preserving full behavior backward compatibility.\n\nPossible Answ"
768 "ers:\n\n\"OK\" - on success\n\n\"WRN:<warning-code>:<warning-message>"
769 "\" - if MIDI input device was set, but there are noteworthy issue(s) re"
770 "lated, providing an appropriate warning code and warning message\n\n\""
771 "ERR:<error-code>:<error-message>\" - in case it failed, providing an a"
772 "ppropriate error code and error message\n\nExamples:\n\n\n\nDeprecated"
773 ":\n\nShould not be used anymore as of LSCP v1.6 and younger. This comm"
774 "and is currently only preserved for backward compatibility.\n\nThis co"
775 "mmand is a relict from times where only one MIDI input per sampler cha"
776 "nnel was allowed. Use \"ADD CHANNEL MIDI_INPUT\" and \"REMOVE CHANNEL"
777 "MIDI_INPUT\" instead.\n\n"
778 },
779 { "GET FX_SEND INFO",
780 "The front-end can ask for the current settings of an effect send entit"
781 "y by sending the following command:\n\nGET FX_SEND INFO <sampler-chann"
782 "el> <fx-send-id>\n\nWhere <sampler-channel> is the sampler channel num"
783 "ber as returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" command an"
784 "d <fx-send-id> reflects the numerical ID of the effect send entity as"
785 "returned by the \"CREATE FX_SEND\" or \"LIST FX_SENDS\" command.\n\nPo"
786 "ssible Answers:\n\nThe sampler will answer by sending a <CRLF> separat"
787 "ed list. Each answer line begins with the settings category name follo"
788 "wed by a colon and then a space character <SP> and finally the info ch"
789 "aracter string to that setting category. At the moment the following c"
790 "ategories are defined:\n\nNAME - name of the effect send entity (note"
791 "that this character string may contain escape sequences )\n\nMIDI_CONT"
792 "ROLLER - a value between 0 and 127 reflecting the MIDI controller whic"
793 "h is able to modify the effect send's send level\n\nLEVEL - optionally"
794 " dotted number reflecting the effect send's current send level (where"
795 "a value < 1.0 means attenuation and a value > 1.0 means amplification)"
796 "\n\nAUDIO_OUTPUT_ROUTING - comma separated list which reflects to whic"
797 "h audio channel of the selected audio output device each effect send o"
798 "utput channel is routed to, e.g. \"0,3\" would mean the effect send's"
799 "output channel 0 is routed to channel 0 of the audio output device and"
800 " the effect send's output channel 1 is routed to the channel 3 of the"
801 "audio output device (see \"SET FX_SEND AUDIO_OUTPUT_CHANNEL\" for deta"
802 "ils), if an internal send effect is assigned to the effect send, then"
803 "this setting defines the audio channel routing to that effect instance"
804 " respectively\n\nEFFECT - destination send effect chain ID and destina"
805 "tion effect chain position, separated by comma in the form \"<effect-c"
806 "hain>,<chain-pos>\" or \"NONE\" if there is no send effect assigned to"
807 " the effect send\n\nThe mentioned fields above don't have to be in par"
808 "ticular order.\n\nExample:\n\nC: \"GET FX_SEND INFO 0 0\"\n\nS: \"NAME"
809 ": Reverb Send\"\n\n\"MIDI_CONTROLLER: 91\"\n\n\"LEVEL: 0.3\"\n\n\"AUDI"
810 "O_OUTPUT_ROUTING: 2,3\"\n\n\"EFFECT: NONE\"\n\n\".\"\n\nC: \"GET FX_SE"
811 "ND INFO 0 1\"\n\nS: \"NAME: Delay Send (Internal)\"\n\n\"MIDI_CONTROLL"
812 "ER: 93\"\n\n\"LEVEL: 0.51\"\n\n\"AUDIO_OUTPUT_ROUTING: 1,2\"\n\n\"EFFE"
813 "CT: 2,0\"\n\n\".\"\n\n"
814 },
815 { "SUBSCRIBE VOICE_COUNT",
816 "Client may want to be notified when the number of voices on the back-e"
817 "nd changes by issuing the following command:\n\nSUBSCRIBE VOICE_COUNT"
818 "\n\nServer will start sending the following notification messages:\n\n"
819 "\"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>\"\n\nwhere <sampler-cha"
820 "nnel> will be replaced by the sampler channel the voice count change o"
821 "ccurred and <voices> by the new number of active voices on that channe"
822 "l.\n\n"
823 },
824 { "GET TOTAL_STREAM_COUNT",
825 "The front-end can ask for the current number of active disk streams on"
826 " the sampler by sending the following command:\n\nGET TOTAL_STREAM_COU"
827 "NT\n\nPossible Answers:\n\nLinuxSampler will answer by returning the n"
828 "umber of all active disk streams on the sampler.\n\n"
829 },
830 { "GET MIDI_INPUT_PORT INFO",
831 "Use the following command to get information about a MIDI port:\n\nGET"
832 " MIDI_INPUT_PORT INFO <device-id> <midi-port>\n\nWhere <device-id> is"
833 "the numerical ID of the MIDI input device as returned by the \"CREATE"
834 "MIDI_INPUT_DEVICE\" or \"LIST MIDI_INPUT_DEVICES\" command and <midi-p"
835 "ort> the MIDI input port number.\n\nPossible Answers:\n\nLinuxSampler"
836 "will answer by sending a <CRLF> separated list. Each answer line begin"
837 "s with the information category name followed by a colon and then a sp"
838 "ace character <SP> and finally the info character string to that info"
839 "category. At the moment the following information categories are defin"
840 "ed:\n\nNAME - arbitrary character string naming the port\n\nThe field"
841 "above is only the one which is returned by all MIDI ports regardless o"
842 "f the MIDI driver and port. Every MIDI port might have its own, additi"
843 "onal driver and port specific parameters.\n\nExample:\n\nC: \"GET MIDI"
844 "_INPUT_PORT INFO 0 0\"\n\nS: \"NAME: 'Masterkeyboard'\"\n\n\"ALSA_SEQ_"
845 "BINDINGS: '64:0'\"\n\n\".\"\n\n"
846 },
847 { "SET AUDIO_OUTPUT_CHANNEL_PARAMETER",
848 "Use the following command to alter a specific setting of an audio outp"
849 "ut channel:\n\nSET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>"
850 "=<value>\n\nWhere <dev-id> should be replaced by the numerical ID of t"
851 "he audio output device as returned by the \"CREATE AUDIO_OUTPUT_DEVICE"
852 "\" or \"LIST AUDIO_OUTPUT_DEVICES\" command, <chn> by the audio channe"
853 "l number, <key> by the name of the parameter to change and <value> by"
854 "the new value for this parameter.\n\nPossible Answers:\n\n\"OK\" - in"
855 "case setting was successfully changed\n\n\"WRN:<warning-code>:<warning"
856 "-message>\" - in case setting was changed successfully, but there are"
857 "noteworthy issue(s) related, providing an appropriate warning code and"
858 " warning message\n\n\"ERR:<error-code>:<error-message>\" - in case it"
859 "failed, providing an appropriate error code and error message\n\nExamp"
860 "le:\n\nC: \"SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:"
861 "0'\"\n\nS: \"OK\"\n\nC: \"SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME="
862 "'monitor left'\"\n\nS: \"OK\"\n\n"
863 },
864 { "SUBSCRIBE FX_SEND_COUNT",
865 "Client may want to be notified when the number of effect sends on a pa"
866 "rticular sampler channel is changed by issuing the following command:"
867 "\n\nSUBSCRIBE FX_SEND_COUNT\n\nServer will start sending the following"
868 "notification messages:\n\n\"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-send"
869 "s>\"\n\nwhere <channel-id> will be replaced by the numerical ID of the"
870 " sampler channel, on which the effect sends number is changed and <fx-"
871 "sends> will be replaced by the new number of effect sends on that chan"
872 "nel.\n\n"
873 },
874 { "DESTROY AUDIO_OUTPUT_DEVICE",
875 "Use the following command to destroy a created output device:\n\nDESTR"
876 "OY AUDIO_OUTPUT_DEVICE <device-id>\n\nWhere <device-id> should be repl"
877 "aced by the numerical ID of the audio output device as given by the \""
878 "CREATE AUDIO_OUTPUT_DEVICE\" or \"LIST AUDIO_OUTPUT_DEVICES\" command."
879 "\n\nPossible Answers:\n\n\"OK\" - in case the device was successfully"
880 "destroyed\n\n\"WRN:<warning-code>:<warning-message>\" - in case the de"
881 "vice was destroyed successfully, but there are noteworthy issue(s) rel"
882 "ated (e.g. an audio over ethernet driver was unloaded but the other ho"
883 "st might not be informed about this situation), providing an appropria"
884 "te warning code and warning message\n\n\"ERR:<error-code>:<error-messa"
885 "ge>\" - in case it failed, providing an appropriate error code and err"
886 "or message\n\nExample:\n\nC: \"DESTROY AUDIO_OUTPUT_DEVICE 0\"\n\nS: "
887 "\"OK\"\n\n"
888 },
889 { "GET CHANNEL INFO",
890 "The front-end can ask for the current settings of a sampler channel by"
891 " sending the following command:\n\nGET CHANNEL INFO <sampler-channel>"
892 "\n\nWhere <sampler-channel> is the sampler channel number the front-end"
893 " is interested in as returned by the \"ADD CHANNEL\" or \"LIST CHANNEL"
894 "S\" command.\n\nPossible Answers:\n\nLinuxSampler will answer by sendi"
895 "ng a <CRLF> separated list. Each answer line begins with the settings"
896 "category name followed by a colon and then a space character <SP> and"
897 "finally the info character string to that setting category. At the mom"
898 "ent the following categories are defined:\n\nENGINE_NAME - name of the"
899 " engine that is associated with the sampler channel, \"NONE\" if there"
900 "'s no engine associated yet for this sampler channel\n\nAUDIO_OUTPUT_D"
901 "EVICE - numerical ID of the audio output device which is currently con"
902 "nected to this sampler channel to output the audio signal, \"-1\" if t"
903 "here's no device connected to this sampler channel\n\nAUDIO_OUTPUT_CHA"
904 "NNELS - number of output channels the sampler channel offers (dependen"
905 "t to used sampler engine and loaded instrument)\n\nAUDIO_OUTPUT_ROUTIN"
906 "G - comma separated list which reflects to which audio channel of the"
907 "selected audio output device each sampler output channel is routed to,"
908 " e.g. \"0,3\" would mean the engine's output channel 0 is routed to ch"
909 "annel 0 of the audio output device and the engine's output channel 1 i"
910 "s routed to the channel 3 of the audio output device\n\nINSTRUMENT_FIL"
911 "E - the file name of the loaded instrument, \"NONE\" if there's no ins"
912 "trument yet loaded for this sampler channel (note: since LSCP 1.2 this"
913 " path may contain escape sequences )\n\nINSTRUMENT_NR - the instrument"
914 " index number of the loaded instrument, \"-1\" if there's no instrumen"
915 "t loaded for this sampler channel\n\nINSTRUMENT_NAME - the instrument"
916 "name of the loaded instrument (note: since LSCP 1.2 this character str"
917 "ing may contain escape sequences )\n\nINSTRUMENT_STATUS - Integer valu"
918 "es 0 to 100 indicating loading progress percentage for the instrument."
919 " Negative value indicates a loading exception (also returns \"-1\" in"
920 "case no instrument was yet to be loaded on the sampler channel). Value"
921 " of 100 indicates that the instrument is fully loaded.\n\nMIDI_INPUT_D"
922 "EVICE - DEPRECATED: THIS FIELD WILL DISAPPEAR!\n\nnumerical ID of the"
923 "MIDI input device which is currently connected to this sampler channel"
924 " to deliver MIDI input commands, \"-1\" if there's no device connected"
925 " to this sampler channel\n\nShould not be used anymore as of LSCP v1.6"
926 " and younger. This field is currently only preserved for backward comp"
927 "atibility.\n\nThis field a relict from times where only one MIDI input"
928 " per sampler channel was allowed. Use \"GET CHANNEL MIDI_INPUTS\" inst"
929 "ead.\n\nMIDI_INPUT_PORT - DEPRECATED: THIS FIELD WILL DISAPPEAR!\n\npo"
930 "rt number of the MIDI input device (in case a MIDI device was already"
931 "assigned to the sampler channel)\n\nShould not be used anymore as of L"
932 "SCP v1.6 and younger. This field is currently only preserved for backw"
933 "ard compatibility.\n\nThis field a relict from times where only one MI"
934 "DI input per sampler channel was allowed. Use \"GET CHANNEL MIDI_INPUT"
935 "S\" instead.\n\nMIDI_INPUT_CHANNEL - the MIDI input channel number thi"
936 "s sampler channel should listen to or \"ALL\" to listen on all MIDI ch"
937 "annels\n\nVOLUME - optionally dotted number for the channel volume fac"
938 "tor (where a value < 1.0 means attenuation and a value > 1.0 means amp"
939 "lification)\n\nMUTE - Determines whether the channel is muted, \"true"
940 "\" if the channel is muted, \"false\" if the channel is not muted, and"
941 "\"MUTED_BY_SOLO\" if the channel is muted because of the presence of a"
942 " solo channel and will be unmuted when there are no solo channels left"
943 "\n\nSOLO - Determines whether this is a solo channel, \"true\" if the"
944 "channel is a solo channel; \"false\" otherwise\n\nMIDI_INSTRUMENT_MAP"
945 "- Determines to which MIDI instrument map this sampler channel is assi"
946 "gned to. Read chapter \"SET CHANNEL MIDI_INSTRUMENT_MAP\" for a list o"
947 "f possible values.\n\nThe mentioned fields above don't have to be in p"
948 "articular order.\n\nExample:\n\nC: \"GET CHANNEL INFO 34\"\n\nS: \"ENG"
949 "INE_NAME: gig\"\n\n\"VOLUME: 1.0\"\n\n\"AUDIO_OUTPUT_DEVICE: 0\"\n\n\""
950 "AUDIO_OUTPUT_CHANNELS: 2\"\n\n\"AUDIO_OUTPUT_ROUTING: 0,1\"\n\n\"INSTR"
951 "UMENT_FILE: /home/joe/FazioliPiano.gig\"\n\n\"INSTRUMENT_NR: 0\"\n\n\""
952 "INSTRUMENT_NAME: Fazioli Piano\"\n\n\"INSTRUMENT_STATUS: 100\"\n\n\"MI"
953 "DI_INPUT_DEVICE: 0\"\n\n\"MIDI_INPUT_PORT: 0\"\n\n\"MIDI_INPUT_CHANNEL"
954 ": 5\"\n\n\"VOLUME: 1.0\"\n\n\"MUTE: false\"\n\n\"SOLO: false\"\n\n\"MI"
955 "DI_INSTRUMENT_MAP: NONE\"\n\n\".\"\n\n"
956 },
957 { "SUBSCRIBE EFFECT_INSTANCE_COUNT",
958 "Client may want to be notified when the number of effect instances is"
959 "changed by issuing the following command:\n\nSUBSCRIBE EFFECT_INSTANCE"
960 "_COUNT\n\nServer will start sending the following notification message"
961 "s:\n\n\"EFFECT_INSTANCE_COUNT:<instances>\"\n\nwhere <instances> will"
962 "be replaced by the new number of effect instances.\n\n"
963 },
964 { "GET CHANNEL VOICE_COUNT",
965 "The front-end can ask for the current number of active voices on a sam"
966 "pler channel by sending the following command:\n\nGET CHANNEL VOICE_CO"
967 "UNT <sampler-channel>\n\nWhere <sampler-channel> is the sampler channe"
968 "l number the front-end is interested in as returned by the \"ADD CHANN"
969 "EL\" or \"LIST CHANNELS\" command.\n\nPossible Answers:\n\nLinuxSample"
970 "r will answer by returning the number of active voices on that channel"
971 ".\n\nExample:\n\n\n\n"
972 },
973 { "SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT",
974 "Client may want to be notified when the number of MIDI instrument maps"
975 " on the back-end changes by issuing the following command:\n\nSUBSCRIB"
976 "E MIDI_INSTRUMENT_MAP_COUNT\n\nServer will start sending the following"
977 " notification messages:\n\n\"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>\""
978 "\n\nwhere <maps> will be replaced by the new number of MIDI instrument"
979 " maps.\n\n"
980 },
981 { "ADD MIDI_INSTRUMENT_MAP",
982 "The front-end can add a new MIDI instrument map by sending the followi"
983 "ng command:\n\nADD MIDI_INSTRUMENT_MAP [<name>]\n\nWhere <name> is an"
984 "optional argument allowing to assign a custom name to the new map. MID"
985 "I instrument Map names do not have to be unique, but MUST be encapsula"
986 "ted into apostrophes and support escape sequences as described in chap"
987 "ter \" Character Set and Escape Sequences \".\n\nPossible Answers:\n\n"
988 "\"OK[<map>]\" - in case a new MIDI instrument map could be added, wher"
989 "e <map> reflects the unique ID of the newly created MIDI instrument ma"
990 "p\n\n\"ERR:<error-code>:<error-message>\" - when a new map could not b"
991 "e created, which might never occur in practice\n\nExamples:\n\nC: \"AD"
992 "D MIDI_INSTRUMENT_MAP 'Standard Map'\"\n\nS: \"OK[0]\"\n\nC: \"ADD MID"
993 "I_INSTRUMENT_MAP 'Standard Drumkit'\"\n\nS: \"OK[1]\"\n\nC: \"ADD MIDI"
994 "_INSTRUMENT_MAP\"\n\nS: \"OK[5]\"\n\n"
995 },
996 { "LIST CHANNEL MIDI_INPUTS",
997 "The front-end can query a list of all currently connected MIDI inputs"
998 "of a certain sampler channel by sending the following command:\n\nLIST"
999 " CHANNEL MIDI_INPUTS <sampler-channel>\n\nWhere <sampler-channel> is t"
1000 "he sampler channel number as returned by the \"ADD CHANNEL\" or \"LIST"
1001 " CHANNELS\" command.\n\nPossible Answers:\n\nThe sampler will answer b"
1002 "y sending a comma separated list of MIDI input device ID - MIDI input"
1003 "port number pairs, where each pair is encapsulated into curly braces."
1004 "The list is returned in one single line. The MIDI input device ID corr"
1005 "esponds to the number returned by \"LIST MIDI_INPUT_DEVICES\" and the"
1006 "port number is the index of the respective MIDI port of that MIDI inpu"
1007 "t device.\n\nExample:\n\nC: \"LIST CHANNEL MIDI_INPUTS 0\"\n\nS: \"{0,"
1008 "0},{1,3},{2,0}\"\n\nSince:\n\nIntroduced with LSCP v1.6\n\n"
1009 },
1010 { "SET VOICES",
1011 "The client can alter the current global sampler-wide limit for maximum"
1012 " voices by sending the following command:\n\nSET VOICES <max-voices>\n"
1013 "\nWhere <max-voices> should be replaced by the integer value, reflecti"
1014 "ng the new global amount limit of maximum voices. This value has to be"
1015 " larger than 0.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"WRN:<"
1016 "warning-code>:<warning-message>\" - if the voice limit was set, but th"
1017 "ere are noteworthy issue(s) related, providing an appropriate warning"
1018 "code and warning message\n\n\"ERR:<error-code>:<error-message>\" - in"
1019 "case it failed, providing an appropriate error code and error message"
1020 "\n\nNote: the given value will be passed to all sampler engine instance"
1021 "s. The total amount of maximum voices on the running system might thus"
1022 " be as big as the given value multiplied by the current amount of engi"
1023 "ne instances.\n\nCaution: when adjusting the voice limit, you SHOULD a"
1024 "lso adjust the disk stream limit respectively and vice versa.\n\n"
1025 },
1026 { "GET MIDI_INSTRUMENT_MAP INFO",
1027 "The front-end can ask for the current settings of a MIDI instrument ma"
1028 "p by sending the following command:\n\nGET MIDI_INSTRUMENT_MAP INFO <m"
1029 "ap>\n\nWhere <map> is the numerical ID of the map the front-end is int"
1030 "erested in as returned by the \"LIST MIDI_INSTRUMENT_MAPS\" command.\n"
1031 "\nPossible Answers:\n\nLinuxSampler will answer by sending a <CRLF> se"
1032 "parated list. Each answer line begins with the settings category name"
1033 "followed by a colon and then a space character <SP> and finally the in"
1034 "fo character string to that setting category. At the moment the follow"
1035 "ing categories are defined:\n\nNAME - custom name of the given map, wh"
1036 "ich does not have to be unique (note that this character string may co"
1037 "ntain escape sequences )\n\nDEFAULT - either true or false, defines wh"
1038 "ether this map is the default map\n\nThe mentioned fields above don't"
1039 "have to be in particular order.\n\nExample:\n\nC: \"GET MIDI_INSTRUMEN"
1040 "T_MAP INFO 0\"\n\nS: \"NAME: Standard Map\"\n\n\"DEFAULT: true\"\n\n\""
1041 ".\"\n\n"
1042 },
1043 { "LIST FX_SENDS",
1044 "The front-end can ask for a list of effect sends on a specific sampler"
1045 " channel by sending the following command:\n\nLIST FX_SENDS <sampler-c"
1046 "hannel>\n\nWhere <sampler-channel> is the respective sampler channel n"
1047 "umber as returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" command."
1048 "\n\nPossible Answers:\n\nThe sampler will answer by returning a comma"
1049 "separated list with all effect sends' numerical IDs on the given sampl"
1050 "er channel.\n\nExamples:\n\nC: \"LIST FX_SENDS 0\"\n\nS: \"0,1\"\n\nC:"
1051 " \"LIST FX_SENDS 1\"\n\nS: \"\"\n\n"
1052 },
1053 { "SET FX_SEND AUDIO_OUTPUT_CHANNEL",
1054 "The front-end can alter the destination of an effect send's audio chan"
1055 "nel on a specific sampler channel by sending the following command:\n"
1056 "\nSET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-s"
1057 "rc> <audio-dst>\n\nWhere <sampler-chan> is the sampler channel number"
1058 "as returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" command, <fx-s"
1059 "end-id> reflects the numerical ID of the effect send entity as returne"
1060 "d by the \"CREATE FX_SEND\" or \"LIST FX_SENDS\" command, <audio-src>"
1061 "is the numerical ID of the effect send's audio channel which should be"
1062 " rerouted and <audio-dst> is the numerical ID of either a) the audio o"
1063 "utput channel of the sampler channel's audio output device (i.e. if ex"
1064 "ternal effect shall be applied) or b) of the audio input channel of an"
1065 " internal effect assigned to the FX send where <audio-src> should be r"
1066 "outed to.\n\nNote that effect sends can only route audio to the same a"
1067 "udio output device as assigned to the effect send's sampler channel. A"
1068 "lso note that an effect send entity does always have exactly as much a"
1069 "udio channels as its sampler channel. So if the sampler channel is ste"
1070 "reo, the effect send does have two audio channels as well. Also keep i"
1071 "n mind that the amount of audio channels on a sampler channel might be"
1072 " dependant not only to the deployed sampler engine on the sampler chan"
1073 "nel, but also dependant to the instrument currently loaded. However yo"
1074 "u can (effectively) turn an i.e. stereo effect send into a mono one by"
1075 " simply altering its audio routing appropriately.\n\nPossible Answers:"
1076 "\n\n\"OK\" - on success\n\n\"WRN:<warning-code>:<warning-message>\" -"
1077 "if audio output channel was set, but there are noteworthy issue(s) rel"
1078 "ated, providing an appropriate warning code and warning message\n\n\"E"
1079 "RR:<error-code>:<error-message>\" - in case it failed, providing an ap"
1080 "propriate error code and error message\n\nExample:\n\nC: \"SET FX_SEND"
1081 " AUDIO_OUTPUT_CHANNEL 0 0 0 2\"\n\nS: \"OK\"\n\n"
1082 },
1083 { "LIST AUDIO_OUTPUT_DEVICES",
1084 "Use the following command to list all created audio output devices:\n"
1085 "\nLIST AUDIO_OUTPUT_DEVICES\n\nPossible Answers:\n\nLinuxSampler will a"
1086 "nswer by sending a comma separated list with the numerical IDs of all"
1087 "audio output devices.\n\nExample:\n\nC: \"LIST AUDIO_OUTPUT_DEVICES\""
1088 "\n\nS: \"0,1,4,5\"\n\n"
1089 },
1090 { "LOAD INSTRUMENT",
1091 "An instrument file can be loaded and assigned to a sampler channel by"
1092 "one of the following commands:\n\nLOAD INSTRUMENT [NON_MODAL] '<filena"
1093 "me>' <instr-index> <sampler-channel>\n\nWhere <filename> is the name o"
1094 "f the instrument file on the LinuxSampler instance's host system, <ins"
1095 "tr-index> the index of the instrument in the instrument file and <samp"
1096 "ler-channel> is the number of the sampler channel the instrument shoul"
1097 "d be assigned to. Each sampler channel can only have one instrument.\n"
1098 "\nNotice: since LSCP 1.2 the <filename> argument supports escape chara"
1099 "cters for special characters (see chapter \" Character Set and Escape"
1100 "Sequences \" for details) and accordingly backslash characters in the"
1101 "filename MUST now be escaped as well!\n\nThe difference between regula"
1102 "r and NON_MODAL versions of the command is that the regular command re"
1103 "turns OK only after the instrument has been fully loaded and the chann"
1104 "el is ready to be used while NON_MODAL version returns immediately and"
1105 " a background process is launched to load the instrument on the channe"
1106 "l. The GET CHANNEL INFO command can be used to obtain loading progress"
1107 " from INSTRUMENT_STATUS field. LOAD command will perform sanity checks"
1108 " such as making sure that the file could be read and it is of a proper"
1109 " format and SHOULD return ERR and SHOULD not launch the background pro"
1110 "cess should any errors be detected at that point.\n\nPossible Answers:"
1111 "\n\n\"OK\" - in case the instrument was successfully loaded\n\n\"WRN:<"
1112 "warning-code>:<warning-message>\" - in case the instrument was loaded"
1113 "successfully, but there are noteworthy issue(s) related (e.g. Engine d"
1114 "oesn't support one or more patch parameters provided by the loaded ins"
1115 "trument file), providing an appropriate warning code and warning messa"
1116 "ge\n\n\"ERR:<error-code>:<error-message>\" - in case it failed, provid"
1117 "ing an appropriate error code and error message\n\nExample (Unix):\n\n"
1118 "C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0\n\nS: OK\n\nExample"
1119 "(Windows):\n\nC: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0\n\nS: OK"
1120 "\n\n"
1121 },
1122 { "SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT",
1123 "Client may want to be notified when the total number of audio output d"
1124 "evices on the back-end changes by issuing the following command:\n\nSU"
1125 "BSCRIBE AUDIO_OUTPUT_DEVICE_COUNT\n\nServer will start sending the fol"
1126 "lowing notification messages:\n\n\"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<d"
1127 "evices>\"\n\nwhere <devices> will be replaced by the new number of aud"
1128 "io output devices.\n\n"
1129 },
1130 { "GET MIDI_INPUT_DEVICES",
1131 "Use the following command to count all created MIDI input devices:\n\n"
1132 "GET MIDI_INPUT_DEVICES\n\nPossible Answers:\n\nLinuxSampler will answe"
1133 "r by sending the current number of all MIDI input devices.\n\nExample:"
1134 "\n\nC: \"GET MIDI_INPUT_DEVICES\"\n\nS: \"3\"\n\n"
1135 },
1136 { "GET STREAMS",
1137 "The client can ask for the current global sampler-wide limit for maxim"
1138 "um disk streams by sending the following command:\n\nGET STREAMS\n\nPo"
1139 "ssible Answers:\n\nLinuxSampler will answer by returning the number fo"
1140 "r the current limit of maximum disk streams.\n\nThe disk stream limit"
1141 "setting defines how many disk streams should maximum be processed by a"
1142 " sampler engine at the same time. The higher this value, the more memo"
1143 "ry (RAM) will be occupied, since every disk streams allocates a certai"
1144 "n buffer size for being able to perform its streaming operations.\n\n"
1145 },
1146 { "LIST MIDI_INPUT_DEVICES",
1147 "Use the following command to list all created MIDI input devices:\n\nL"
1148 "IST MIDI_INPUT_DEVICES\n\nPossible Answers:\n\nLinuxSampler will answe"
1149 "r by sending a comma separated list with the numerical Ids of all crea"
1150 "ted MIDI input devices.\n\nExamples:\n\nC: \"LIST MIDI_INPUT_DEVICES\""
1151 "\n\nS: \"0,1,2\"\n\nC: \"LIST MIDI_INPUT_DEVICES\"\n\nS: \"1,3\"\n\n"
1152 },
1153 { "GET EFFECT_INSTANCE_INPUT_CONTROL INFO",
1154 "Effects typically provide a certain set of effect parameters which can"
1155 " be altered by the user in realtime (e.g. depth of a reverb effect, du"
1156 "ration of a delay effect, dry / wet signal ratio). Those controllable"
1157 "effect parameters are called \"input controls\". The front-end can ask"
1158 " for the current information of an effect instance's input control by"
1159 "sending the following command:\n\nGET EFFECT_INSTANCE_INPUT_CONTROL IN"
1160 "FO <effect-instance> <input-control>\n\nWhere <effect-instance> is the"
1161 " numerical ID of an effect instance as returned by the \"CREATE EFFECT"
1162 "_INSTANCE\" or \"LIST EFFECT_INSTANCES\" command and <input-control> i"
1163 "s the index of the input control within the numerical bounds as return"
1164 "ed by the \"INPUT_CONTROLS\" field of the \"GET EFFECT_INSTANCE INFO\""
1165 " command.\n\nPossible Answers:\n\nLinuxSampler will answer by sending"
1166 "a <CRLF> separated list. Each answer line begins with the information"
1167 "category name, followed by a colon and then a space character <SP> and"
1168 " finally the info character string to that information category. There"
1169 " are information categories which are always returned, independent of"
1170 "the respective effect parameter and there are optional information cat"
1171 "egories which are only shown for certain effect parameters. At the mom"
1172 "ent the following categories are defined:\n\nDESCRIPTION - (always ret"
1173 "urned) human readable name of the effect parameter, intended to be dis"
1174 "played in user interfaces (note that the character string may contain"
1175 "escape sequences )\n\nVALUE - (always returned) current (optional dott"
1176 "ed) floating point value of this effect parameter\n\nRANGE_MIN - (opti"
1177 "onally returned) minimum allowed value for this effect parameter\n\nRA"
1178 "NGE_MAX - (optionally returned) maximum allowed value for this effect"
1179 "parameter\n\nPOSSIBILITIES - (optionally returned) comma separated lis"
1180 "t of (optional dotted) floating point numbers, reflecting the exact se"
1181 "t of possible values for this effect parameter\n\nDEFAULT - (optionall"
1182 "y returned) default value of this effect parameter\n\nThe mentioned fi"
1183 "elds above don't have to be in particular order.\n\nExample:\n\nC: \"G"
1184 "ET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0\"\n\nS: \"DESCRIPTION: Base"
1185 "delay (s)\"\n\n\"VALUE: 0.500\"\n\n\"RANGE_MIN: 0.000\"\n\n\".\"\n\n"
1186 },
1187 { "CREATE MIDI_INPUT_DEVICE",
1188 "Use the following command to create a new MIDI input device for the de"
1189 "sired MIDI input system:\n\nCREATE MIDI_INPUT_DEVICE <midi-input-drive"
1190 "r> [<param-list>]\n\nWhere <midi-input-driver> should be replaced by t"
1191 "he desired MIDI input system as returned by the \"LIST AVAILABLE_MIDI_"
1192 "INPUT_DRIVERS\" command and <param-list> by an optional list of driver"
1193 " specific parameters in form of \"key1=val1 key2=val2 ...\", where cha"
1194 "racter string values should be encapsulated into apostrophes ('). Note"
1195 " that there might be drivers which require parameter(s) to be given wi"
1196 "th this command. Use the previously described commands in this chapter"
1197 " to get that information.\n\nPossible Answers:\n\n\"OK[<device-id>]\""
1198 "- in case the device was successfully created, where <device-id> is th"
1199 "e numerical ID of the new device\n\n\"WRN[<device-id>]:<warning-code>:"
1200 "<warning-message>\" - in case the driver was loaded successfully, wher"
1201 "e <device-id> is the numerical ID of the new device, but there are not"
1202 "eworthy issue(s) related, providing an appropriate warning code and wa"
1203 "rning message\n\n\"ERR:<error-code>:<error-message>\" - in case it fai"
1204 "led, providing an appropriate error code and error message\n\nExample:"
1205 "\n\nC: \"CREATE MIDI_INPUT_DEVICE ALSA\"\n\nS: \"OK[0]\"\n\n"
1206 },
1207 { "GET CHANNELS",
1208 "The number of sampler channels can change on runtime. To get the curre"
1209 "nt amount of sampler channels, the front-end can send the following co"
1210 "mmand:\n\nGET CHANNELS\n\nPossible Answers:\n\nLinuxSampler will answe"
1211 "r by returning the current number of sampler channels.\n\nExample:\n\n"
1212 "C: \"GET CHANNELS\"\n\nS: \"12\"\n\n"
1213 },
1214 { "GET TOTAL_VOICE_COUNT_MAX",
1215 "The front-end can ask for the maximum number of active voices by sendi"
1216 "ng the following command:\n\nGET TOTAL_VOICE_COUNT_MAX\n\nPossible Ans"
1217 "wers:\n\nLinuxSampler will answer by returning the maximum number of a"
1218 "ctive voices.\n\n"
1219 },
1220 { "ADD CHANNEL MIDI_INPUT",
1221 "The front-end can add a MIDI input on a specific sampler channel by se"
1222 "nding the following command:\n\nADD CHANNEL MIDI_INPUT <sampler-channe"
1223 "l> <midi-device-id> [<midi-input-port>]\n\nWhere <sampler-channel> is"
1224 "the sampler channel number as returned by the \"ADD CHANNEL\" or \"LIS"
1225 "T CHANNELS\" command and <midi-device-id> is the numerical ID of the M"
1226 "IDI input device as returned by the \"CREATE MIDI_INPUT_DEVICE\" or \""
1227 "LIST MIDI_INPUT_DEVICES\" command, and <midi-input-port> is an optiona"
1228 "l MIDI input port number of that MIDI input device. If <midi-input-por"
1229 "t> is omitted, then the MIDI input device's first port (port number 0)"
1230 " is used.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"WRN:<warnin"
1231 "g-code>:<warning-message>\" - if MIDI input port was connected, but th"
1232 "ere are noteworthy issue(s) related, providing an appropriate warning"
1233 "code and warning message\n\n\"ERR:<error-code>:<error-message>\" - in"
1234 "case it failed, providing an appropriate error code and error message"
1235 "\n\nExamples:\n\nC: \"ADD CHANNEL MIDI_INPUT 0 0\"\n\nS: \"OK\"\n\nC: "
1236 "\"ADD CHANNEL MIDI_INPUT 1 0\"\n\nS: \"OK\"\n\nC: \"ADD CHANNEL MIDI_IN"
1237 "PUT 1 1 1\"\n\nS: \"OK\"\n\nC: \"ADD CHANNEL MIDI_INPUT 1 2 0\"\n\nS:"
1238 "\"OK\"\n\nSince:\n\nIntroduced with LSCP v1.6\n\n"
1239 },
1240 { "GET AUDIO_OUTPUT_DEVICE INFO",
1241 "Use the following command to get current settings of a specific, creat"
1242 "ed audio output device:\n\nGET AUDIO_OUTPUT_DEVICE INFO <device-id>\n"
1243 "\nWhere <device-id> should be replaced by numerical ID of the audio out"
1244 "put device as e.g. returned by the \"LIST AUDIO_OUTPUT_DEVICES\" comma"
1245 "nd.\n\nPossible Answers:\n\nLinuxSampler will answer by sending a <CRL"
1246 "F> separated list. Each answer line begins with the information catego"
1247 "ry name followed by a colon and then a space character <SP> and finall"
1248 "y the info character string to that info category. As some parameters"
1249 "might allow multiple values, character strings are encapsulated into a"
1250 "postrophes ('). At the moment the following information categories are"
1251 " defined (independently of device):\n\nDRIVER - identifier of the used"
1252 " audio output driver, as also returned by the \"LIST AVAILABLE_AUDIO_O"
1253 "UTPUT_DRIVERS\" command\n\nCHANNELS - amount of audio output channels"
1254 "this device currently offers\n\nSAMPLERATE - playback sample rate the"
1255 "device uses\n\nACTIVE - either true or false, if false then the audio"
1256 "device is inactive and doesn't output any sound, nor do the sampler ch"
1257 "annels connected to this audio device render any audio\n\nThe mentione"
1258 "d fields above don't have to be in particular order. The fields above"
1259 "are only those fields which are returned by all audio output devices."
1260 "Every audio output driver might have its own, additional driver specif"
1261 "ic parameters (see ) which are also returned by this command.\n\nExam"
1262 "ple:\n\nC: \"GET AUDIO_OUTPUT_DEVICE INFO 0\"\n\nS: \"DRIVER: ALSA\"\n"
1263 "\n\"CHANNELS: 2\"\n\n\"SAMPLERATE: 44100\"\n\n\"ACTIVE: true\"\n\n\"FR"
1264 "AGMENTS: 2\"\n\n\"FRAGMENTSIZE: 128\"\n\n\"CARD: '0,0'\"\n\n\".\"\n\n"
1265 },
1266 { "SUBSCRIBE MIDI_INPUT_DEVICE_INFO",
1267 "Client may want to be notified when changes were made to MIDI input de"
1268 "vices on the back-end by issuing the following command:\n\nSUBSCRIBE M"
1269 "IDI_INPUT_DEVICE_INFO\n\nServer will start sending the following notif"
1270 "ication messages:\n\n\"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>\"\n\n"
1271 "where <device-id> will be replaced by the numerical ID of the MIDI inp"
1272 "ut device, which settings has been changed. The front-end will have to"
1273 " send the respective command to actually get the MIDI input device inf"
1274 "o. Because these messages will be triggered by LSCP commands issued by"
1275 " other clients rather than real time events happening on the server, i"
1276 "t is believed that an empty notification message is sufficient here.\n"
1277 "\n"
1278 },
1279 { "SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO",
1280 "Client may want to be notified when changes were made to MIDI instrume"
1281 "nt maps on the back-end by issuing the following command:\n\nSUBSCRIBE"
1282 " MIDI_INSTRUMENT_MAP_INFO\n\nServer will start sending the following n"
1283 "otification messages:\n\n\"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>\""
1284 "\n\nwhere <map-id> will be replaced by the numerical ID of the MIDI ins"
1285 "trument map, for which information changes occurred. The front-end wil"
1286 "l have to send the respective command to actually get the MIDI instrum"
1287 "ent map info. Because these messages will be triggered by LSCP command"
1288 "s issued by other clients rather than real time events happening on th"
1289 "e server, it is believed that an empty notification message is suffici"
1290 "ent here.\n\n"
1291 },
1292 { "GET DB_INSTRUMENT_DIRECTORIES",
1293 "The front-end can retrieve the current amount of directories in a spec"
1294 "ific directory by sending the following command:\n\nGET DB_INSTRUMENT_"
1295 "DIRECTORIES [RECURSIVE] <dir>\n\nWhere <dir> should be replaced by the"
1296 " absolute path name of the directory. If RECURSIVE is specified, the n"
1297 "umber of all directories, including those located in subdirectories of"
1298 " the specified directory, will be returned.\n\nPossible Answers:\n\nTh"
1299 "e current number of instrument directories in the specified directory."
1300 "\n\n\"ERR:<error-code>:<error-message>\" - if the given directory does"
1301 " not exist.\n\nExample:\n\nC: \"GET DB_INSTRUMENT_DIRECTORIES '/'\"\n"
1302 "\nS: \"2\"\n\n"
1303 },
1304 { "GET AVAILABLE_EFFECTS",
1305 "The front-end can retrieve the amount of internal effects, available t"
1306 "o the sampler by sending the following command:\n\nGET AVAILABLE_EFFEC"
1307 "TS\n\nPossible Answers:\n\nThe sampler will answer by returning the cu"
1308 "rrent number of effects available to the sampler.\n\nExamples:\n\nC: "
1309 "\"GET AVAILABLE_EFFECTS\"\n\nS: \"129\"\n\n"
1310 },
1311 { "GET VOICES",
1312 "The client can ask for the current global sampler-wide limit for maxim"
1313 "um voices by sending the following command:\n\nGET VOICES\n\nPossible"
1314 "Answers:\n\nLinuxSampler will answer by returning the number for the c"
1315 "urrent limit of maximum voices.\n\nThe voice limit setting defines how"
1316 " many voices should maximum be processed by the sampler at the same ti"
1317 "me. If the user triggers new notes which would exceed that voice limit"
1318 ", the sampler engine will react by stealing old voices for those newly"
1319 " triggered notes. Note that the amount of voices triggered by a new no"
1320 "te can be larger than one and is dependent to the respective instrumen"
1321 "t and probably further criterias.\n\n"
1322 },
1323 { "GET FILE INSTRUMENT INFO",
1324 "The front-end can retrieve detailed information about a specific instr"
1325 "ument within a given instrument file by sending the following command:"
1326 "\n\nGET FILE INSTRUMENT INFO <filename> <instr-id>\n\nWhere <filename>"
1327 " is the name of the instrument file (encapsulated into apostrophes, su"
1328 "pporting escape sequences as described in chapter \" Character Set and"
1329 " Escape Sequences \") and <instr-id> is the numeric instrument ID as r"
1330 "eturned by the \"LIST FILE INSTRUMENTS\" command.\n\nThe sampler will"
1331 "try to ask all sampler engines, whether they support the given file an"
1332 "d ask the first engine with a positive answer for information about th"
1333 "e specific instrument in the given file.\n\nPossible Answers:\n\nLinux"
1334 "Sampler will answer by sending a <CRLF> separated list. Each answer li"
1335 "ne begins with the settings category name followed by a colon and then"
1336 " a space character <SP> and finally the info character string to that"
1337 "setting category. At the moment the following categories are defined:"
1338 "\n\nNAME - name of the instrument as stored in the instrument file\n\nF"
1339 "ORMAT_FAMILY - name of the sampler format of the given instrument\n\nF"
1340 "ORMAT_VERSION - version of the sampler format the instrumen is stored"
1341 "as\n\nPRODUCT - official product name of the instrument as stored in t"
1342 "he file\n\nARTISTS - artists / sample library vendor of the instrument"
1343 "\n\nKEY_BINDINGS - comma separated list of integer values representing"
1344 " the instrument's key mapping in the range between 0 .. 127, reflectin"
1345 "g the analog meaning of the MIDI specification.\n\nKEYSWITCH_BINDINGS"
1346 "- comma separated list of integer values representing the instrument's"
1347 " keyswitch mapping in the range between 0 .. 127, reflecting the analo"
1348 "g meaning of the MIDI specification.\n\nThe mentioned fields above don"
1349 "'t have to be in particular order.\n\nExample:\n\nC: \"GET FILE INSTRU"
1350 "MENT INFO 'D:/Sounds/Foo.gig' 0\"\n\nS: \"NAME: Lunatic Loops\"\n\n\"F"
1351 "ORMAT_FAMILY: GIG\"\n\n\"FORMAT_VERSION: 3\"\n\n\"PRODUCT: The Backbon"
1352 "e Bongo Beats\"\n\n\"ARTISTS: Jimmy the Fish\"\n\n\".\"\n\n"
1353 },
1354 { "LIST MIDI_INSTRUMENT_MAPS",
1355 "The number of MIDI instrument maps can change on runtime. To get the c"
1356 "urrent list of MIDI instrument maps, the front-end can send the follow"
1357 "ing command:\n\nLIST MIDI_INSTRUMENT_MAPS\n\nPossible Answers:\n\nThe"
1358 "sampler will answer by returning a comma separated list with all MIDI"
1359 "instrument maps' numerical IDs.\n\nExample:\n\nC: \"LIST MIDI_INSTRUME"
1360 "NT_MAPS\"\n\nS: \"0,1,5,12\"\n\n"
1361 },
1362 { "REMOVE SEND_EFFECT_CHAIN EFFECT",
1363 "The front-end can remove an effect instance from a certain position of"
1364 " a send effect chain by sending the following command:\n\nREMOVE SEND_"
1365 "EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos>\n\nWhere"
1366 " <audio-device> should be replaced by the numerical ID of the audio ou"
1367 "tput device as given by the \"CREATE AUDIO_OUTPUT_DEVICE\" or \"LIST A"
1368 "UDIO_OUTPUT_DEVICES\" command, <effect-chain> by the numerical ID as r"
1369 "eturned by the \"ADD SEND_EFFECT_CHAIN\" or \"LIST SEND_EFFECT_CHAINS"
1370 "\" command and <chain-pos> the exact position of the effect instance to"
1371 " be removed from the effect chain.\n\nPossible Answers:\n\n\"OK\" - in"
1372 " case the effect instance was removed successfully\n\n\"ERR:<error-cod"
1373 "e>:<error-message>\" - if the effect instance could not be removed\n\n"
1374 "Examples:\n\nC: \"REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4\"\n\nS: \"OK\""
1375 "\n\n"
1376 },
1377 { "ADD DB_INSTRUMENTS",
1378 "The front-end can add one or more instruments to the instruments datab"
1379 "ase by sending the following command:\n\nADD DB_INSTRUMENTS [NON_MODAL"
1380 "] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>]\n\nWhere"
1381 " <db_dir> is the absolute path name of a directory (encapsulated into"
1382 "apostrophes) in the instruments database in which only the new instrum"
1383 "ents (that are not already in the database) will be added, <file_path>"
1384 " is the absolute path name of a file or directory in the file system ("
1385 "encapsulated into apostrophes). In case an instrument file is supplied"
1386 ", only the instruments in the specified file will be added to the inst"
1387 "ruments database. If the optional <instr_index> (the index of the inst"
1388 "rument within the given file) is supplied too, then only the specified"
1389 " instrument will be added. In case a directory is supplied, the instru"
1390 "ments in that directory will be added. The OPTIONAL <mode> argument is"
1391 " only applied when a directory is provided as <file_path> and specifie"
1392 "s how the scanning will be done and has exactly the following possibil"
1393 "ities:\n\n\"RECURSIVE\" - All instruments will be processed, including"
1394 " those in the subdirectories, and the respective subdirectory tree str"
1395 "ucture will be recreated in the instruments database\n\n\"NON_RECURSIV"
1396 "E\" - Only the instruments in the specified directory will be added, t"
1397 "he instruments in the subdirectories will not be processed.\n\n\"FLAT"
1398 "\" - All instruments will be processed, including those in the subdirec"
1399 "tories, but the respective subdirectory structure will not be recreate"
1400 "d in the instruments database. All instruments will be added directly"
1401 "in the specified database directory.\n\nIf FILE_AS_DIR argument is sup"
1402 "plied, all instruments in an instrument file will be added to a separa"
1403 "te directory in the instruments database, which name will be the name"
1404 "of the instrument file with the file extension stripped off.\n\nThe di"
1405 "fference between regular and NON_MODAL versions of the command is that"
1406 " the regular command returns when the scanning is finished while NON_M"
1407 "ODAL version returns immediately and a background process is launched."
1408 " The GET DB_INSTRUMENTS_JOB INFO command can be used to monitor the sc"
1409 "anning progress.\n\nPossible Answers:\n\n\"OK\" - on success when NON_"
1410 "MODAL is not supplied\n\n\"OK[<job-id>]\" - on success when NON_MODAL"
1411 "is supplied, where <job-id> is a numerical ID used to obtain status in"
1412 "formation about the job progress. See GET DB_INSTRUMENTS_JOB INFO \n\n"
1413 "\"ERR:<error-code>:<error-message>\" - if an invalid path is specified"
1414 ".\n\nExamples:\n\nC: \"ADD DB_INSTRUMENTS '/Piano Collection' '/home/m"
1415 "e/gigs/PMI Bosendorfer 290.gig' 0\"\n\nS: \"OK\"\n\n"
1416 },
1417 { "SUBSCRIBE DEVICE_MIDI",
1418 "Client may want to be notified when MIDI data arrive on MIDI input dev"
1419 "ices by issuing the following command:\n\nSUBSCRIBE DEVICE_MIDI\n\nSer"
1420 "ver will start sending one of the the following notification messages:"
1421 "\n\n\"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocit"
1422 "y>\"\n\n\"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <ve"
1423 "locity>\"\n\nwhere <device-id> <port-id> will be replaced by the IDs o"
1424 "f the respective MIDI input device and the device's MIDI port where th"
1425 "e MIDI data arrived. <note> and <velocity> are integer values in the r"
1426 "ange between 0 .. 127, reflecting the analog meaning of the MIDI speci"
1427 "fication.\n\nCAUTION: no guarantee whatsoever will be made that MIDI e"
1428 "vents are actually all delivered by this mechanism! With other words:"
1429 "events could be lost at any time! This restriction was made to keep th"
1430 "e RT-safeness of the backend's MIDI and audio thread unaffected by thi"
1431 "s feature.\n\n"
1432 },
1433 { "SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO",
1434 "Client may want to be notified when changes were made to audio output"
1435 "devices on the back-end by issuing the following command:\n\nSUBSCRIBE"
1436 " AUDIO_OUTPUT_DEVICE_INFO\n\nServer will start sending the following n"
1437 "otification messages:\n\n\"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
1438 "\"\n\nwhere <device-id> will be replaced by the numerical ID of the au"
1439 "dio output device, which settings has been changed. The front-end will"
1440 " have to send the respective command to actually get the audio output"
1441 "device info. Because these messages will be triggered by LSCP commands"
1442 " issued by other clients rather than real time events happening on the"
1443 " server, it is believed that an empty notification message is sufficie"
1444 "nt here.\n\n"
1445 },
1446 { "SET CHANNEL MUTE",
1447 "The front-end can mute/unmute a specific sampler channel by sending th"
1448 "e following command:\n\nSET CHANNEL MUTE <sampler-channel> <mute>\n\nW"
1449 "here <sampler-channel> is the respective sampler channel number as ret"
1450 "urned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" command and <mute> s"
1451 "hould be replaced either by \"1\" to mute the channel or \"0\" to unmu"
1452 "te the channel.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"WRN:<"
1453 "warning-code>:<warning-message>\" - if the channel was muted/unmuted,"
1454 "but there are noteworthy issue(s) related, providing an appropriate wa"
1455 "rning code and warning message\n\n\"ERR:<error-code>:<error-message>\""
1456 " - in case it failed, providing an appropriate error code and error me"
1457 "ssage\n\nExamples:\n\n\n\n"
1458 },
1459 { "COPY DB_INSTRUMENT_DIRECTORY",
1460 "The front-end can copy a specific instrument directory by sending the"
1461 "following command:\n\nCOPY DB_INSTRUMENT_DIRECTORY <dir> <dst>\n\nWher"
1462 "e <dir> is the absolute path name of the directory to copy and <dst> i"
1463 "s the location where the directory will be copied to.\n\nPossible Answ"
1464 "ers:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:<error-message>\" -"
1465 "in case a given directory does not exists, or if a directory with name"
1466 " equal to the name of the specified directory already exists in the de"
1467 "stination directory. Error is also thrown when trying to copy a direct"
1468 "ory to a subdirectory of itself.\n\nExample:\n\nC: \"COPY DB_INSTRUMEN"
1469 "T_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'\"\n\nS: \""
1470 "OK\"\n\n"
1471 },
1472 { "GET DB_INSTRUMENT_DIRECTORY INFO",
1473 "The front-end can ask for the current settings of an instrument direct"
1474 "ory by sending the following command:\n\nGET DB_INSTRUMENT_DIRECTORY I"
1475 "NFO <dir>\n\nWhere <dir> should be replaced by the absolute path name"
1476 "of the directory the front-end is interested in.\n\nPossible Answers:"
1477 "\n\nLinuxSampler will answer by sending a <CRLF> separated list. Each a"
1478 "nswer line begins with the settings category name followed by a colon"
1479 "and then a space character <SP> and finally the info character string"
1480 "to that setting category. At the moment the following categories are d"
1481 "efined:\n\nDESCRIPTION - A brief description of the directory content."
1482 " Note that the character string may contain escape sequences .\n\nCREA"
1483 "TED - The creation date and time of the directory, represented in \"YY"
1484 "YY-MM-DD HH:MM:SS\" format\n\nMODIFIED - The date and time of the last"
1485 " modification of the directory, represented in \"YYYY-MM-DD HH:MM:SS\""
1486 " format\n\nThe mentioned fields above don't have to be in particular o"
1487 "rder.\n\nExample:\n\nC: \"GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Col"
1488 "lection'\"\n\nS: \"DESCRIPTION: Piano collection of instruments in Gig"
1489 "aSampler format.\"\n\n\"CREATED: 2007-02-05 10:23:12\"\n\n\"MODIFIED:"
1490 "2007-04-07 12:50:21\"\n\n\".\"\n\n"
1491 },
1492 { "GET MIDI_INPUT_DEVICE INFO",
1493 "Use the following command to get current settings of a specific, creat"
1494 "ed MIDI input device:\n\nGET MIDI_INPUT_DEVICE INFO <device-id>\n\nWhe"
1495 "re <device-id> is the numerical ID of the MIDI input device as returne"
1496 "d by the \"CREATE MIDI_INPUT_DEVICE\" or \"LIST MIDI_INPUT_DEVICES\" c"
1497 "ommand.\n\nPossible Answers:\n\nLinuxSampler will answer by sending a"
1498 "<CRLF> separated list. Each answer line begins with the information ca"
1499 "tegory name followed by a colon and then a space character <SP> and fi"
1500 "nally the info character string to that info category. As some paramet"
1501 "ers might allow multiple values, character strings are encapsulated in"
1502 "to apostrophes ('). At the moment the following information categories"
1503 " are defined (independent of driver):\n\nDRIVER - identifier of the us"
1504 "ed MIDI input driver, as e.g. returned by the \"LIST AVAILABLE_MIDI_IN"
1505 "PUT_DRIVERS\" command\n\nACTIVE - either true or false, if false then"
1506 "the MIDI device is inactive and doesn't listen to any incoming MIDI ev"
1507 "ents and thus doesn't forward them to connected sampler channels\n\nTh"
1508 "e mentioned fields above don't have to be in particular order. The fie"
1509 "lds above are only those fields which are returned by all MIDI input d"
1510 "evices. Every MIDI input driver might have its own, additional driver"
1511 "specific parameters (see \"GET MIDI_INPUT_DRIVER INFO\" command) which"
1512 " are also returned by this command.\n\nExample:\n\nC: \"GET MIDI_INPUT"
1513 "_DEVICE INFO 0\"\n\nS: \"DRIVER: ALSA\"\n\n\"ACTIVE: true\"\n\n\".\"\n"
1514 "\n"
1515 },
1516 { "LIST FILE INSTRUMENTS",
1517 "The front-end can retrieve a list of all instruments within a given in"
1518 "strument file by sending the following command:\n\nLIST FILE INSTRUMEN"
1519 "TS <filename>\n\nWhere <filename> is the name of the instrument file ("
1520 "encapsulated into apostrophes, supporting escape sequences as describe"
1521 "d in chapter \" Character Set and Escape Sequences \").\n\nThe sampler"
1522 " will try to ask all sampler engines, whether they support the given f"
1523 "ile and ask the first engine with a positive answer for a list of IDs"
1524 "for the instruments in the given file.\n\nPossible Answers:\n\nOn succ"
1525 "ess, the sampler will answer by returning a comma separated list of in"
1526 "strument IDs.\n\n\"ERR:<error-code>:<error-message>\" - if the file co"
1527 "uld not be handled\n\nExamples:\n\nC: \"LIST FILE INSTRUMENTS 'D:/Soun"
1528 "ds/Foo.gig'\"\n\nS: \"0,1,2,3,4,5,6,7,8,9\"\n\n"
1529 },
1530 { "SET STREAMS",
1531 "The client can alter the current global sampler-wide limit for maximum"
1532 " disk streams by sending the following command:\n\nSET STREAMS <max-st"
1533 "reams>\n\nWhere <max-streams> should be replaced by the integer value,"
1534 " reflecting the new global amount limit of maximum disk streams. This"
1535 "value has to be positive.\n\nPossible Answers:\n\n\"OK\" - on success"
1536 "\n\n\"WRN:<warning-code>:<warning-message>\" - if the disk stream limit"
1537 " was set, but there are noteworthy issue(s) related, providing an appr"
1538 "opriate warning code and warning message\n\n\"ERR:<error-code>:<error-"
1539 "message>\" - in case it failed, providing an appropriate error code an"
1540 "d error message\n\nNote: the given value will be passed to all sampler"
1541 " engine instances. The total amount of maximum disk streams on the run"
1542 "ning system might thus be as big as the given value multiplied by the"
1543 "current amount of engine instances.\n\nCaution: when adjusting the dis"
1544 "k stream limit, you SHOULD also adjust the voice limit respectively an"
1545 "d vice versa.\n\n"
1546 },
1547 { "SUBSCRIBE MIDI_INPUT_DEVICE_COUNT",
1548 "Client may want to be notified when the total number of MIDI input dev"
1549 "ices on the back-end changes by issuing the following command:\n\nSUBS"
1550 "CRIBE MIDI_INPUT_DEVICE_COUNT\n\nServer will start sending the followi"
1551 "ng notification messages:\n\n\"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices"
1552 ">\"\n\nwhere <devices> will be replaced by the new number of MIDI inpu"
1553 "t devices.\n\n"
1554 },
1555 { "SET DB_INSTRUMENT DESCRIPTION",
1556 "The front-end can alter the description of a specific instrument by se"
1557 "nding the following command:\n\nSET DB_INSTRUMENT DESCRIPTION <instr>"
1558 "<desc>\n\nWhere <instr> is the absolute path name of the instrument an"
1559 "d <desc> is the new description for the instrument (encapsulated into"
1560 "apostrophes, supporting escape sequences as described in chapter \" Ch"
1561 "aracter Set and Escape Sequences \").\n\nPossible Answers:\n\n\"OK\" -"
1562 " on success\n\n\"ERR:<error-code>:<error-message>\" - in case the give"
1563 "n instrument does not exists.\n\nExample:\n\nC: \"SET DB_INSTRUMENT DE"
1564 "SCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"
1565 "\"\n\nS: \"OK\"\n\n"
1566 },
1567 { "SET DB_INSTRUMENT_DIRECTORY NAME",
1568 "The front-end can alter the name of a specific instrument directory by"
1569 " sending the following command:\n\nSET DB_INSTRUMENT_DIRECTORY NAME <d"
1570 "ir> <name>\n\nWhere <dir> is the absolute path name of the directory a"
1571 "nd <name> is the new name for that directory.\n\nPossible Answers:\n\n"
1572 "\"OK\" - on success\n\n\"ERR:<error-code>:<error-message>\" - in case"
1573 "the given directory does not exists, or if a directory with name equal"
1574 " to the new name already exists.\n\nExample:\n\nC: \"SET DB_INSTRUMENT"
1575 "_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'\"\n\nS: \"OK\""
1576 "\n\n"
1577 },
1578 { "SET AUDIO_OUTPUT_DEVICE_PARAMETER",
1579 "Use the following command to alter a specific setting of a created aud"
1580 "io output device:\n\nSET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <ke"
1581 "y>=<value>\n\nWhere <device-id> should be replaced by the numerical ID"
1582 " of the audio output device as given by the \"CREATE AUDIO_OUTPUT_DEVI"
1583 "CE\" or \"LIST AUDIO_OUTPUT_DEVICES\" command, <key> by the name of th"
1584 "e parameter to change and <value> by the new value for this parameter."
1585 "\n\nPossible Answers:\n\n\"OK\" - in case setting was successfully cha"
1586 "nged\n\n\"WRN:<warning-code>:<warning-message>\" - in case setting was"
1587 " changed successfully, but there are noteworthy issue(s) related, prov"
1588 "iding an appropriate warning code and warning message\n\n\"ERR:<error-"
1589 "code>:<error-message>\" - in case it failed, providing an appropriate"
1590 "error code and error message\n\nExample:\n\nC: \"SET AUDIO_OUTPUT_DEVI"
1591 "CE_PARAMETER 0 FRAGMENTSIZE=128\"\n\nS: \"OK\"\n\n"
1592 },
1593 { "SET FX_SEND EFFECT",
1594 "The front-end can (re-)assign an internal destination effect to an eff"
1595 "ect send by sending the following command:\n\nSET FX_SEND EFFECT <samp"
1596 "ler-chan> <fx-send-id> <effect-chain> <chain-pos>\n\nWhere <sampler-ch"
1597 "an> is the sampler channel number as returned by the \"ADD CHANNEL\" o"
1598 "r \"LIST CHANNELS\" command, <fx-send-id> reflects the numerical ID of"
1599 " the effect send entity as returned by the \"CREATE FX_SEND\" or \"LIS"
1600 "T FX_SENDS\" command, <effect-chain> by the numerical ID of the destin"
1601 "ation effect chain as returned by the \"ADD SEND_EFFECT_CHAIN\" or \"L"
1602 "IST SEND_EFFECT_CHAINS\" command and <chain-pos> reflects the exact ef"
1603 "fect chain position in the effect chain which hosts the actual destina"
1604 "tion effect.\n\nNote: This command MUST NOT be used if you want to app"
1605 "ly audio effects externally! By default FX sends are routed directly t"
1606 "o the audio output device for that purpose. You can also revert this c"
1607 "ommand later on by sending \"REMOVE FX_SEND EFFECT\" , which will caus"
1608 "e the FX send to be routed directly to the sampler channel's audio out"
1609 "put device instead (i.e. for using external effects instead of interna"
1610 "l effects).\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"ERR:<erro"
1611 "r-code>:<error-message>\" - in case it failed, providing an appropriat"
1612 "e error code and error message\n\nExample:\n\nC: \"SET FX_SEND EFFECT"
1613 "0 0 2 5\"\n\nS: \"OK\"\n\n"
1614 },
1615 { "FIND LOST DB_INSTRUMENT_FILES",
1616 "The front-end can retrieve the list of all instrument files in the ins"
1617 "truments database that don't exist in the filesystem by sending the fo"
1618 "llowing command:\n\nFIND LOST DB_INSTRUMENT_FILES\n\nPossible Answers:"
1619 "\n\nA comma separated list with the absolute path names (encapsulated"
1620 "into apostrophes) of all lost instrument files.\n\n\"ERR:<error-code>:"
1621 "<error-message>\" - in case it failed, providing an appropriate error"
1622 "code and error message.\n\nExample:\n\nC: \"FIND LOST DB_INSTRUMENT_FI"
1623 "LES\"\n\nS: \"'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gig"
1624 "s/Free Piano.gig'\"\n\n"
1625 },
1626 { "LIST AVAILABLE_MIDI_INPUT_DRIVERS",
1627 "Use the following command to list all MIDI input drivers currently ava"
1628 "ilable for the LinuxSampler instance:\n\nLIST AVAILABLE_MIDI_INPUT_DRI"
1629 "VERS\n\nPossible Answers:\n\nLinuxSampler will answer by sending comma"
1630 " separated character strings, each symbolizing a MIDI input driver.\n"
1631 "\nExample:\n\nC: \"LIST AVAILABLE_MIDI_INPUT_DRIVERS\"\n\nS: \"ALSA,JAC"
1632 "K\"\n\n"
1633 },
1634 { "DESTROY EFFECT_INSTANCE",
1635 "The front-end can destroy an unusued effect instance and thus freeing"
1636 "it from memory by sending the following command:\n\nDESTROY EFFECT_INS"
1637 "TANCE <effect-instance>\n\nWhere <effect-instance> is the numerical ID"
1638 " of the effect instance as returned by the \"CREATE EFFECT_INSTANCE\""
1639 "or \"LIST EFFECT_INSTANCES\" command.\n\nThe effect instance can only"
1640 "be destroyed if it's not used in any part of the sampler's audio signa"
1641 "l path anymore. If the effect instance is still in use somewhere, tryi"
1642 "ng to destroy the effect instance will result in an error message.\n\n"
1643 "Possible Answers:\n\n\"OK\" - in case the effect instance was successf"
1644 "ully destroyed\n\n\"ERR:<error-code>:<error-message>\" - in case it fa"
1645 "iled, providing an appropriate error code and error message\n\nExample"
1646 "s:\n\nC: \"DESTROY EFFECT_INSTANCE 5\"\n\nS: \"OK\"\n\n"
1647 },
1648 { "GET SEND_EFFECT_CHAIN INFO",
1649 "The front-end can ask for information of a send effect chain by sendin"
1650 "g the following command:\n\nGET SEND_EFFECT_CHAIN INFO <audio-device>"
1651 "<effect-chain>\n\nWhere <audio-device> should be replaced by the numer"
1652 "ical ID of the audio output device as given by the \"CREATE AUDIO_OUTP"
1653 "UT_DEVICE\" or \"LIST AUDIO_OUTPUT_DEVICES\" command and <effect-chain"
1654 "> by the numerical ID as returned by the \"ADD SEND_EFFECT_CHAIN\" or"
1655 "\"LIST SEND_EFFECT_CHAINS\" command.\n\nPossible Answers:\n\nLinuxSamp"
1656 "ler will answer by sending a <CRLF> separated list. Each answer line b"
1657 "egins with the information category name, followed by a colon and then"
1658 " a space character <SP> and finally the info character string to that"
1659 "information category. At the moment the following categories are defin"
1660 "ed:\n\nEFFECT_COUNT - amount of effects in this send effect chain\n\nE"
1661 "FFECT_SEQUENCE - comma separated list of the numerical IDs of the effe"
1662 "ct instances in this send effect chain, in the order as they are procs"
1663 "sed in the effect chain\n\nThe mentioned fields above don't have to be"
1664 " in particular order.\n\nExample:\n\nC: \"GET SEND_EFFECT_CHAIN INFO 0"
1665 " 2\"\n\nS: \"EFFECT_COUNT: 3\"\n\n\"EFFECT_SEQUENCE: 31,4,7\"\n\n\".\""
1666 "\n\n"
1667 },
1668 { "GET EFFECT_INSTANCES",
1669 "The front-end can retrieve the current amount of effect instances by s"
1670 "ending the following command:\n\nGET EFFECT_INSTANCES\n\nPossible Answ"
1671 "ers:\n\nThe sampler will answer by returning the current number of eff"
1672 "ect instances created and not yet destroyed in the current sampler ses"
1673 "sion.\n\nExamples:\n\nC: \"GET EFFECT_INSTANCES\"\n\nS: \"14\"\n\n"
1674 },
1675 { "QUIT",
1676 "The client can close its network connection to LinuxSampler by sending"
1677 " the following command:\n\nQUIT\n\nThis is probably more interesting f"
1678 "or manual telnet connections to LinuxSampler than really useful for a"
1679 "front-end implementation.\n\n"
1680 },
1681 { "GET DB_INSTRUMENTS",
1682 "The front-end can retrieve the current amount of instruments in a spec"
1683 "ific directory by sending the following command:\n\nGET DB_INSTRUMENTS"
1684 " [RECURSIVE] <dir>\n\nWhere <dir> should be replaced by the absolute p"
1685 "ath name of the directory. If RECURSIVE is specified, the number of al"
1686 "l instruments, including those located in subdirectories of the specif"
1687 "ied directory, will be returned.\n\nPossible Answers:\n\nThe current n"
1688 "umber of instruments in the specified directory.\n\n\"ERR:<error-code>"
1689 ":<error-message>\" - if the given directory does not exist.\n\nExample"
1690 ":\n\nC: \"GET DB_INSTRUMENTS '/Piano Collection'\"\n\nS: \"2\"\n\n"
1691 },
1692 { "SUBSCRIBE CHANNEL_MIDI",
1693 "Client may want to be notified when MIDI data arrive on sampler channe"
1694 "ls on back-end side, by issuing the following command:\n\nSUBSCRIBE CH"
1695 "ANNEL_MIDI\n\nServer will start sending one of the the following notif"
1696 "ication messages:\n\n\"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note>"
1697 " <velocity>\"\n\n\"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <v"
1698 "elocity>\"\n\nwhere <channel-id> will be replaced by the ID of the sam"
1699 "pler channel where the MIDI data arrived. <note> and <velocity> are in"
1700 "teger values in the range between 0 .. 127, reflecting the analog mean"
1701 "ing of the MIDI specification.\n\nCAUTION: no guarantee whatsoever wil"
1702 "l be made that MIDI events are actually all delivered by this mechanis"
1703 "m! With other words: events could be lost at any time! This restrictio"
1704 "n was made to keep the RT-safeness of the backend's MIDI and audio thr"
1705 "ead unaffected by this feature.\n\n"
1706 },
1707 { "DESTROY MIDI_INPUT_DEVICE",
1708 "Use the following command to destroy a created MIDI input device:\n\nD"
1709 "ESTROY MIDI_INPUT_DEVICE <device-id>\n\nWhere <device-id> should be re"
1710 "placed by the device's numerical ID as returned by the \"CREATE MIDI_I"
1711 "NPUT_DEVICE\" or \"LIST MIDI_INPUT_DEVICES\" command.\n\nPossible Answ"
1712 "ers:\n\n\"OK\" - in case the device was successfully destroyed\n\n\"WR"
1713 "N:<warning-code>:<warning-message>\" - in case the device was destroye"
1714 "d, but there are noteworthy issue(s) related, providing an appropriate"
1715 " warning code and warning message\n\n\"ERR:<error-code>:<error-message"
1716 ">\" - in case it failed, providing an appropriate error code and error"
1717 " message\n\nExample:\n\nC: \"DESTROY MIDI_INPUT_DEVICE 0\"\n\nS: \"OK"
1718 "\"\n\n"
1719 },
1720 { "SUBSCRIBE EFFECT_INSTANCE_INFO",
1721 "Client may want to be notified when changes were made to effect instan"
1722 "ces on the back-end by issuing the following command:\n\nSUBSCRIBE EFF"
1723 "ECT_INSTANCE_INFO\n\nServer will start sending the following notificat"
1724 "ion messages:\n\n\"EFFECT_INSTANCE_INFO:<instance-id>\"\n\nwhere <inst"
1725 "ance-id> will be replaced by the numerical ID of the effect instance."
1726 "\n\n"
1727 },
1728 { "SUBSCRIBE FX_SEND_INFO",
1729 "Client may want to be notified when changes were made to effect sends"
1730 "on a a particular sampler channel by issuing the following command:\n"
1731 "\nSUBSCRIBE FX_SEND_INFO\n\nServer will start sending the following not"
1732 "ification messages:\n\n\"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
1733 "\"\n\nwhere <channel-id> will be replaced by the numerical ID of the s"
1734 "ampler channel, on which an effect send entity is changed and <fx-send"
1735 "-id> will be replaced by the numerical ID of the changed effect send."
1736 "\n\n"
1737 },
1738 { "SET CHANNEL MIDI_INPUT_CHANNEL",
1739 "The front-end can alter the MIDI channel a sampler channel should list"
1740 "en to by sending the following command:\n\nSET CHANNEL MIDI_INPUT_CHAN"
1741 "NEL <sampler-channel> <midi-input-chan>\n\nWhere <midi-input-chan> is"
1742 "the number of the new MIDI input channel (zero indexed!) where <sample"
1743 "r-channel> should listen to, or \"ALL\" to listen on all 16 MIDI chann"
1744 "els.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"WRN:<warning-cod"
1745 "e>:<warning-message>\" - if MIDI input channel was set, but there are"
1746 "noteworthy issue(s) related, providing an appropriate warning code and"
1747 " warning message\n\n\"ERR:<error-code>:<error-message>\" - in case it"
1748 "failed, providing an appropriate error code and error message\n\nExamp"
1749 "les:\n\nC: \"SET CHANNEL MIDI_INPUT_CHANNEL 0 0\"\n\nS: \"OK\"\n\nC: "
1750 "\"SET CHANNEL MIDI_INPUT_CHANNEL 1 ALL\"\n\nS: \"OK\"\n\n"
1751 },
1752 { "APPEND SEND_EFFECT_CHAIN EFFECT",
1753 "The front-end can add an unused effect instance to the end of a send e"
1754 "ffect chain by sending the following command:\n\nAPPEND SEND_EFFECT_CH"
1755 "AIN EFFECT <audio-device> <effect-chain> <effect-instance>\n\nWhere <a"
1756 "udio-device> should be replaced by the numerical ID of the audio outpu"
1757 "t device as given by the \"CREATE AUDIO_OUTPUT_DEVICE\" or \"LIST AUDI"
1758 "O_OUTPUT_DEVICES\" command and <effect-chain> by the numerical ID as r"
1759 "eturned by the \"ADD SEND_EFFECT_CHAIN\" or \"LIST SEND_EFFECT_CHAINS"
1760 "\" command and <effect-instance> as returned by the \"CREATE EFFECT_INS"
1761 "TANCE\" or \"LIST EFFECT_INSTANCES\" command.\n\nOnly unused effect in"
1762 "stances can be added to the effect chain. Trying to add an effect inst"
1763 "ance which is already in use somewhere in the audio signal path of the"
1764 " sampler will result in an error.\n\nPossible Answers:\n\n\"OK\" - in"
1765 "case the effect instance was added successfully to the chain\n\n\"ERR:"
1766 "<error-code>:<error-message>\" - if the effect instance could not be a"
1767 "dded\n\nExamples:\n\nC: \"APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38\"\n\n"
1768 "S: \"OK\"\n\n"
1769 },
1770 { "GET AUDIO_OUTPUT_DRIVER INFO",
1771 "Use the following command to get detailed information about a specific"
1772 " audio output driver:\n\nGET AUDIO_OUTPUT_DRIVER INFO <audio-output-dr"
1773 "iver>\n\nWhere <audio-output-driver> is the name of the audio output d"
1774 "river, returned by the \"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS\" command"
1775 ".\n\nPossible Answers:\n\nLinuxSampler will answer by sending a <CRLF>"
1776 " separated list. Each answer line begins with the information category"
1777 " name followed by a colon and then a space character <SP> and finally"
1778 "the info character string to that info category. At the moment the fol"
1779 "lowing information categories are defined:\n\nDESCRIPTION - character"
1780 "string describing the audio output driver\n\nVERSION - character strin"
1781 "g reflecting the driver's version\n\nPARAMETERS - comma separated list"
1782 " of all parameters available for the given audio output driver, at lea"
1783 "st parameters 'channels', 'samplerate' and 'active' are offered by all"
1784 " audio output drivers\n\nThe mentioned fields above don't have to be i"
1785 "n particular order.\n\nExample:\n\nC: \"GET AUDIO_OUTPUT_DRIVER INFO A"
1786 "LSA\"\n\nS: \"DESCRIPTION: Advanced Linux Sound Architecture\"\n\n\"VE"
1787 "RSION: 1.0\"\n\n\"PARAMETERS: DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGME"
1788 "NTS, FRAGMENTSIZE,CARD\"\n\n\".\"\n\n"
1789 },
1790 { "SUBSCRIBE MIDI_INSTRUMENT_INFO",
1791 "Client may want to be notified when changes were made to MIDI instrume"
1792 "nts on the back-end by issuing the following command:\n\nSUBSCRIBE MID"
1793 "I_INSTRUMENT_INFO\n\nServer will start sending the following notificat"
1794 "ion messages:\n\n\"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <progra"
1795 "m>\"\n\nwhere <map-id> will be replaced by the numerical ID of the MID"
1796 "I instrument map, in which a MIDI instrument is changed. <bank> and <p"
1797 "rogram> specifies the location of the changed MIDI instrument in the m"
1798 "ap. The front-end will have to send the respective command to actually"
1799 " get the MIDI instrument info. Because these messages will be triggere"
1800 "d by LSCP commands issued by other clients rather than real time event"
1801 "s happening on the server, it is believed that an empty notification m"
1802 "essage is sufficient here.\n\n"
1803 },
1804 { "GET MIDI_INSTRUMENT INFO",
1805 "The front-end can retrieve the current settings of a certain instrumen"
1806 "t map entry by sending the following command:\n\nGET MIDI_INSTRUMENT I"
1807 "NFO <map> <midi_bank> <midi_prog>\n\nWhere <map> is the numeric ID of"
1808 "the MIDI instrument map, <midi_bank> is an integer value between 0..16"
1809 "383 reflecting the MIDI bank value, <midi_bank> and <midi_prog> an int"
1810 "eger value between 0..127 reflecting the MIDI program value of the map"
1811 "'s entrie's key index triple.\n\nPossible Answers:\n\nLinuxSampler wil"
1812 "l answer by sending a <CRLF> separated list. Each answer line begins w"
1813 "ith the information category name followed by a colon and then a space"
1814 " character <SP> and finally the info character string to that info cat"
1815 "egory. At the moment the following categories are defined:\n\n\"NAME\""
1816 " - Name for this MIDI instrument map entry (if defined). This name sha"
1817 "ll be used by frontends for displaying a name for this mapped instrume"
1818 "nt. It can be set and changed with the \"MAP MIDI_INSTRUMENT\" command"
1819 " and does not have to be unique. (note that this character string may"
1820 "contain escape sequences )\n\n\"ENGINE_NAME\" - Name of the engine to"
1821 "be deployed for this instrument.\n\n\"INSTRUMENT_FILE\" - File name of"
1822 " the instrument (note that this path may contain escape sequences ).\n"
1823 "\n\"INSTRUMENT_NR\" - Index of the instrument within the file.\n\n\"IN"
1824 "STRUMENT_NAME\" - Name of the loaded instrument as reflected by its fi"
1825 "le. In contrast to the \"NAME\" field, the \"INSTRUMENT_NAME\" field c"
1826 "annot be changed (note that this character string may contain escape s"
1827 "equences ).\n\n\"LOAD_MODE\" - Life time of instrument (see \"MAP MIDI"
1828 "_INSTRUMENT\" for details about this setting).\n\n\"VOLUME\" - master"
1829 "volume of the instrument as optionally dotted number (where a value <"
1830 "1.0 means attenuation and a value > 1.0 means amplification)\n\nThe me"
1831 "ntioned fields above don't have to be in particular order.\n\nExample:"
1832 "\n\nC: \"GET MIDI_INSTRUMENT INFO 1 45 120\"\n\nS: \"NAME: Drums for F"
1833 "oo Song\"\n\n\"ENGINE_NAME: GigEngine\"\n\n\"INSTRUMENT_FILE: /usr/sha"
1834 "re/joesdrumkit.gig\"\n\n\"INSTRUMENT_NR: 0\"\n\n\"INSTRUMENT_NAME: Joe"
1835 "'s Drumkit\"\n\n\"LOAD_MODE: PERSISTENT\"\n\n\"VOLUME: 1.0\"\n\n\".\""
1836 "\n\n"
1837 },
1838 { "SUBSCRIBE BUFFER_FILL",
1839 "Client may want to be notified when the buffer fill state of a disk st"
1840 "ream on the back-end changes by issuing the following command:\n\nSUBS"
1841 "CRIBE BUFFER_FILL\n\nServer will start sending the following notificat"
1842 "ion messages:\n\n\"NOTIFY:BUFFER_FILL:<sampler-channel> <fill-data>\""
1843 "\n\nwhere <sampler-channel> will be replaced by the sampler channel the"
1844 " buffer fill state change occurred on and <fill-data> will be replaced"
1845 " by the buffer fill data for this channel as described in as if the "
1846 "\"GET CHANNEL BUFFER_FILL PERCENTAGE\" command was issued on this chann"
1847 "el.\n\n"
1848 },
1849 { "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO",
1850 "Use the following command to get detailed information about specific a"
1851 "udio channel parameter:\n\nGET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <de"
1852 "v-id> <chan> <param>\n\nWhere <dev-id> is the numerical ID of the audi"
1853 "o output device as returned by the \"CREATE AUDIO_OUTPUT_DEVICE\" or "
1854 "\"LIST AUDIO_OUTPUT_DEVICES\" command, <chan> the audio channel number"
1855 "and <param> a specific channel parameter name for which information sh"
1856 "ould be obtained (as returned by the \"GET AUDIO_OUTPUT_CHANNEL INFO\""
1857 " command).\n\nPossible Answers:\n\nLinuxSampler will answer by sending"
1858 " a <CRLF> separated list. Each answer line begins with the information"
1859 " category name followed by a colon and then a space character <SP> and"
1860 " finally the info character string to that info category. There are in"
1861 "formation which is always returned, independently of the given channel"
1862 " parameter and there is optional information which is only shown depen"
1863 "dently to the given audio channel. At the moment the following informa"
1864 "tion categories are defined:\n\nTYPE - either \"BOOL\" for boolean val"
1865 "ue(s) or \"INT\" for integer value(s) or \"FLOAT\" for dotted number(s"
1866 ") or \"STRING\" for character string(s) (always returned)\n\nDESCRIPTI"
1867 "ON - arbitrary text describing the purpose of the parameter (always re"
1868 "turned)\n\nFIX - either true or false, if true then this parameter is"
1869 "read only, thus cannot be altered (always returned)\n\nMULTIPLICITY -"
1870 "either true or false, defines if this parameter allows only one value"
1871 "or a list of values, where true means multiple values and false only a"
1872 " single value allowed (always returned)\n\nRANGE_MIN - defines lower l"
1873 "imit of the allowed value range for this parameter, can be an integer"
1874 "value as well as a dotted number, usually used in conjunction with 'RA"
1875 "NGE_MAX', but may also appear without (optionally returned, dependent"
1876 "to driver and channel parameter)\n\nRANGE_MAX - defines upper limit of"
1877 " the allowed value range for this parameter, can be an integer value a"
1878 "s well as a dotted number, usually used in conjunction with 'RANGE_MIN"
1879 "', but may also appear without (optionally returned, dependent to driv"
1880 "er and channel parameter)\n\nPOSSIBILITIES - comma separated list of p"
1881 "ossible values for this parameter, character strings are encapsulated"
1882 "into apostrophes (optionally returned, dependent to driver and channel"
1883 " parameter)\n\nThe mentioned fields above don't have to be in particul"
1884 "ar order.\n\nExample:\n\nC: \"GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"
1885 "1 0 JACK_BINDINGS\"\n\nS: \"DESCRIPTION: bindings to other JACK client"
1886 "s\"\n\n\"TYPE: STRING\"\n\n\"FIX: false\"\n\n\"MULTIPLICITY: true\"\n"
1887 "\n\"POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'\"\n\n\".\"\n\n"
1888 },
1889 { "CREATE EFFECT_INSTANCE",
1890 "The front-end can spawn an instance of the desired effect by sending t"
1891 "he following command:\n\nCREATE EFFECT_INSTANCE <effect-system> <modul"
1892 "e> <effect-name>\n\nWhere <effect-system> is the \"SYSTEM\" field, <mo"
1893 "dule> the \"MODULE\" field and <effect-name> the \"NAME\" field as ret"
1894 "urned by the \"GET EFFECT INFO\" command. The filename of argument <mo"
1895 "dule> and the character string of argument <effect-name> may contain e"
1896 "scape sequences .\n\nThe sampler will try to load the requested effect"
1897 " and to create an instance of it. To allow loading the same effect on"
1898 "a different machine, probably even running a completely different oper"
1899 "ating system (e.g. Linux vs. Windows), the sampler tries to match <mod"
1900 "ule> \"softly\". That means it first tries to find an effect that exac"
1901 "tly matches the given <module> argument. If there is no exact match, t"
1902 "he sampler will try to lower the restrictions on matching the <module>"
1903 " argument more and more, e.g. by ignoring upper / lower case differenc"
1904 "es and by ignoring the path of the DLL filename and file extension. If"
1905 " there is still no match at the end, the sampler will try to ignore th"
1906 "e <module> argument completely and as a last resort search for an effe"
1907 "ct that only matches the given <effect-system> and <effect-name> argum"
1908 "ents.\n\nPossible Answers:\n\n\"OK[<effect-instance>]\" - in case the"
1909 "effect instance was successfully created, where <effect-instance> is t"
1910 "he numerical ID of the new effect instance\n\n\"WRN:<warning-code>:<wa"
1911 "rning-message>\" - in case the effect instance was spawned successfull"
1912 "y, but there are noteworthy issue(s) related, providing an appropriate"
1913 " warning code and warning message\n\n\"ERR:<error-code>:<error-message"
1914 ">\" - if the effect could not be instantiated\n\nExamples:\n\nC: \"CRE"
1915 "ATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDel"
1916 "ay'\"\n\nS: \"OK[0]\"\n\n"
1917 },
1918 { "SUBSCRIBE SEND_EFFECT_CHAIN_INFO",
1919 "Client may want to be notified when changes were made to send effect c"
1920 "hains on the back-end by issuing the following command:\n\nSUBSCRIBE S"
1921 "END_EFFECT_CHAIN_INFO\n\nServer will start sending the following notif"
1922 "ication messages:\n\n\"SEND_EFFECT_CHAIN_INFO:<device-id> <chain-id> <"
1923 "instances>\" - Notifies that the number of effect instances in a parti"
1924 "cular send effect chain is changed, where <device-id> will be replaced"
1925 " by the numerical ID of the audio output device the send effect chain"
1926 "belongs to, <chain-id> will be replaced by the numerical ID of the sen"
1927 "d effect chain in which the number of effect instances has changed and"
1928 " <instances> will be replaced by the new number of effect instances in"
1929 " the specified send effect chain.\n\n"
1930 },
1931 { "SUBSCRIBE CHANNEL_COUNT",
1932 "Client may want to be notified when the total number of channels on th"
1933 "e back-end changes by issuing the following command:\n\nSUBSCRIBE CHAN"
1934 "NEL_COUNT\n\nServer will start sending the following notification mess"
1935 "ages:\n\n\"NOTIFY:CHANNEL_COUNT:<channels>\"\n\nwhere <channels> will"
1936 "be replaced by the new number of sampler channels.\n\n"
1937 },
1938 { "FIND DB_INSTRUMENTS",
1939 "The front-end can search for instruments in specific directory by send"
1940 "ing the following command:\n\nFIND DB_INSTRUMENTS [NON_RECURSIVE] <dir"
1941 "> <criteria-list>\n\nWhere <dir> should be replaced by the absolute pa"
1942 "th name of the directory to search in. If NON_RECURSIVE is specified,"
1943 "the directories located in subdirectories of the specified directory w"
1944 "ill not be searched. <criteria-list> is a list of search criterias in"
1945 "form of \"key1=val1 key2=val2 ...\". The following criterias are allow"
1946 "ed:\n\nNAME='<search-string>' Restricts the search to instruments, whi"
1947 "ch names satisfy the supplied search string (encapsulated into apostro"
1948 "phes, supporting escape sequences as described in chapter \" Character"
1949 " Set and Escape Sequences \").\n\nSIZE=[<min>]..[<max>] Restricts the"
1950 "search to instruments, which size is in the specified range. If <min>"
1951 "is omitted, the search results are restricted to instruments with size"
1952 " less then or equal to <max>. If <max> is omitted, the search is restr"
1953 "icted to instruments with size greater then or equal to <min>.\n\nCREA"
1954 "TED='[<date-after>]..[<date-before>]' Restricts the search to instrume"
1955 "nts, which creation date satisfies the specified period, where <date-a"
1956 "fter> and <date-before> are in \"YYYY-MM-DD HH:MM:SS\" format. If <dat"
1957 "e-after> is omitted the search is restricted to instruments created be"
1958 "fore <date-before>. If <date-before> is omitted, the search is restric"
1959 "ted to instruments created after <date-after>.\n\nMODIFIED='[<date-aft"
1960 "er>]..[<date-before>]' Restricts the search to instruments, which date"
1961 " of last modification satisfies the specified period, where <date-afte"
1962 "r> and <date-before> are in \"YYYY-MM-DD HH:MM:SS\" format. If <date-a"
1963 "fter> is omitted the search is restricted to instruments, which are la"
1964 "st modified before <date-before>. If <date-before> is omitted, the sea"
1965 "rch is restricted to instruments, which are last modified after <date-"
1966 "after>.\n\nDESCRIPTION='<search-string>' Restricts the search to instr"
1967 "uments with description that satisfies the supplied search string (enc"
1968 "apsulated into apostrophes, supporting escape sequences as described i"
1969 "n chapter \" Character Set and Escape Sequences \").\n\nPRODUCT='<sear"
1970 "ch-string>' Restricts the search to instruments with product info that"
1971 " satisfies the supplied search string (encapsulated into apostrophes,"
1972 "supporting escape sequences as described in chapter \" Character Set a"
1973 "nd Escape Sequences \").\n\nARTISTS='<search-string>' Restricts the se"
1974 "arch to instruments with artists info that satisfies the supplied sear"
1975 "ch string (encapsulated into apostrophes, supporting escape sequences"
1976 "as described in chapter \" Character Set and Escape Sequences \").\n\n"
1977 "KEYWORDS='<search-string>' Restricts the search to instruments with ke"
1978 "yword list that satisfies the supplied search string (encapsulated int"
1979 "o apostrophes, supporting escape sequences as described in chapter \""
1980 "Character Set and Escape Sequences \").\n\nIS_DRUM=true | false Either"
1981 " true or false. Restricts the search to drum kits or chromatic instrum"
1982 "ents.\n\nFORMAT_FAMILIES='<format-list>' Restricts the search to instr"
1983 "uments of the supplied format families, where <format-list> is a comma"
1984 " separated list of format families.\n\nWhere <search-string> is either"
1985 " a regular expression, or a word list separated with spaces for OR sea"
1986 "rch and with '+' for AND search.\n\nPossible Answers:\n\nA comma separ"
1987 "ated list with the absolute path names (encapsulated into apostrophes)"
1988 " of all instruments in the specified directory that satisfy the suppli"
1989 "ed search criterias.\n\n\"ERR:<error-code>:<error-message>\" - if the"
1990 "given directory does not exist.\n\nExample:\n\nC: \"FIND DB_INSTRUMENT"
1991 "S '/Piano Collection' NAME='bosendorfer+290'\"\n\nS: \"'/Piano Collect"
1992 "ion/Bosendorfer 290'\"\n\nC: \"FIND DB_INSTRUMENTS '/Piano Collection'"
1993 " CREATED='2007-04-01 09:30:13..'\"\n\nS: \"'/Piano Collection/Bosendor"
1994 "fer 290','/Piano Collection/Steinway D'\"\n\n"
1995 },
1996 { "LIST DB_INSTRUMENTS",
1997 "The front-end can retrieve the current list of instruments in specific"
1998 " directory by sending the following command:\n\nLIST DB_INSTRUMENTS [R"
1999 "ECURSIVE] <dir>\n\nWhere <dir> should be replaced by the absolute path"
2000 " name of the directory. If RECURSIVE is specified, the absolute path n"
2001 "ames of all instruments, including those located in subdirectories of"
2002 "the specified directory, will be returned.\n\nPossible Answers:\n\nA c"
2003 "omma separated list of all instruments (encapsulated into apostrophes)"
2004 " in the specified directory.\n\n\"ERR:<error-code>:<error-message>\" -"
2005 " if the given directory does not exist.\n\nExample:\n\nC: \"LIST DB_IN"
2006 "STRUMENTS '/Piano Collection'\"\n\nS: \"'Bosendorfer 290','Steinway D'"
2007 "\"\n\nC: \"LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'\"\n\nS: "
2008 "\"'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/"
2009 "Piano Collection/Lite/Free Piano'\"\n\n"
2010 },
2011 { "GET MIDI_INPUT_DRIVER_PARAMETER INFO",
2012 "Use the following command to get detailed information about a specific"
2013 " parameter of a specific MIDI input driver:\n\nGET MIDI_INPUT_DRIVER_P"
2014 "ARAMETER INFO <midit> <param> [<deplist>]\n\nWhere <midit> is the name"
2015 " of the MIDI input driver as returned by the \"LIST AVAILABLE_MIDI_INP"
2016 "UT_DRIVERS\" command, <param> a specific parameter name for which info"
2017 "rmation should be obtained (as returned by the \"GET MIDI_INPUT_DRIVER"
2018 " INFO\" command) and <deplist> is an optional list of parameters on wh"
2019 "ich the sought parameter <param> depends on, <deplist> is a key-value"
2020 "pair list in form of \"key1=val1 key2=val2 ...\", where character stri"
2021 "ng values are encapsulated into apostrophes ('). Arguments given with"
2022 "<deplist> which are not dependency parameters of <param> will be ignor"
2023 "ed, means the front-end application can simply put all parameters in <"
2024 "deplist> with the values selected by the user.\n\nPossible Answers:\n"
2025 "\nLinuxSampler will answer by sending a <CRLF> separated list. Each ans"
2026 "wer line begins with the information category name followed by a colon"
2027 " and then a space character <SP> and finally the info character string"
2028 " to that info category. There is information which is always returned,"
2029 " independent of the given driver parameter and there is optional infor"
2030 "mation which is only shown dependent to given driver parameter. At the"
2031 " moment the following information categories are defined:\n\nTYPE - ei"
2032 "ther \"BOOL\" for boolean value(s) or \"INT\" for integer value(s) or"
2033 "\"FLOAT\" for dotted number(s) or \"STRING\" for character string(s) ("
2034 "always returned, no matter which driver parameter)\n\nDESCRIPTION - ar"
2035 "bitrary text describing the purpose of the parameter (always returned,"
2036 " no matter which driver parameter)\n\nMANDATORY - either true or false"
2037 ", defines if this parameter must be given when the device is to be cre"
2038 "ated with the 'CREATE MIDI_INPUT_DEVICE' command (always returned, no"
2039 "matter which driver parameter)\n\nFIX - either true or false, if false"
2040 " then this parameter can be changed at any time, once the device is cr"
2041 "eated by the 'CREATE MIDI_INPUT_DEVICE' command (always returned, no m"
2042 "atter which driver parameter)\n\nMULTIPLICITY - either true or false,"
2043 "defines if this parameter allows only one value or a list of values, w"
2044 "here true means multiple values and false only a single value allowed"
2045 "(always returned, no matter which driver parameter)\n\nDEPENDS - comma"
2046 " separated list of parameters this parameter depends on, means the val"
2047 "ues for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX' and 'POSSIBILITIES'"
2048 " might depend on these listed parameters, for example assuming that an"
2049 " audio driver (like the ALSA driver) offers parameters 'card' and 'sam"
2050 "plerate' then parameter 'samplerate' would depend on 'card' because th"
2051 "e possible values for 'samplerate' depends on the sound card which can"
2052 " be chosen by the 'card' parameter (optionally returned, dependent to"
2053 "driver parameter)\n\nDEFAULT - reflects the default value for this par"
2054 "ameter which is used when the device is created and not explicitly giv"
2055 "en with the 'CREATE MIDI_INPUT_DEVICE' command, in case of MULTIPLCITY"
2056 "=true, this is a comma separated list, that's why character strings ar"
2057 "e encapsulated into apostrophes (') (optionally returned, dependent to"
2058 " driver parameter)\n\nRANGE_MIN - defines lower limit of the allowed v"
2059 "alue range for this parameter, can be an integer value as well as a do"
2060 "tted number, this parameter is often used in conjunction with RANGE_MA"
2061 "X, but may also appear without (optionally returned, dependent to driv"
2062 "er parameter)\n\nRANGE_MAX - defines upper limit of the allowed value"
2063 "range for this parameter, can be an integer value as well as a dotted"
2064 "number, this parameter is often used in conjunction with RANGE_MIN, bu"
2065 "t may also appear without (optionally returned, dependent to driver pa"
2066 "rameter)\n\nPOSSIBILITIES - comma separated list of possible values fo"
2067 "r this parameter, character strings are encapsulated into apostrophes"
2068 "(optionally returned, dependent to driver parameter)\n\nThe mentioned"
2069 "fields above don't have to be in particular order.\n\nExample:\n\nC: "
2070 "\"GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE\"\n\nS: \"DESCRIPTIO"
2071 "N: Whether device is enabled\"\n\n\"TYPE: BOOL\"\n\n\"MANDATORY: false"
2072 "\"\n\n\"FIX: false\"\n\n\"MULTIPLICITY: false\"\n\n\"DEFAULT: true\"\n"
2073 "\n\".\"\n\n"
2074 },
2075 { "INSERT SEND_EFFECT_CHAIN EFFECT",
2076 "The front-end can add an unused effect instance to a certain position"
2077 "of a send effect chain by sending the following command:\n\nINSERT SEN"
2078 "D_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effec"
2079 "t-instance>\n\nWhere <audio-device> should be replaced by the numerica"
2080 "l ID of the audio output device as given by the \"CREATE AUDIO_OUTPUT_"
2081 "DEVICE\" or \"LIST AUDIO_OUTPUT_DEVICES\" command, <effect-chain> by t"
2082 "he numerical ID as returned by the \"ADD SEND_EFFECT_CHAIN\" or \"LIST"
2083 " SEND_EFFECT_CHAINS\" command, <effect-instance> as returned by the \""
2084 "CREATE EFFECT_INSTANCE\" or \"LIST EFFECT_INSTANCES\" command and <cha"
2085 "in-pos> the exact position of the effect chain where the supplied effe"
2086 "ct shall be inserted to.\n\nOnly unused effect instances can be added"
2087 "to the effect chain. Trying to add an effect instance which is already"
2088 " in use somewhere in the audio signal path of the sampler will result"
2089 "in an error.\n\nPossible Answers:\n\n\"OK\" - in case the effect insta"
2090 "nce was added successfully to the chain\n\n\"ERR:<error-code>:<error-m"
2091 "essage>\" - if the effect instance could not be added\n\nExamples:\n\n"
2092 "C: \"INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38\"\n\nS: \"OK\"\n\n"
2093 },
2094 { "SET CHANNEL MIDI_INPUT_TYPE",
2095 "DEPRECATED: THIS COMMAND WILL DISAPPEAR!\n\nThe front-end can alter th"
2096 "e MIDI input type on a specific sampler channel by sending the followi"
2097 "ng command:\n\nSET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-inp"
2098 "ut-type>\n\nWhere <midi-input-type> is currently only \"ALSA\" and <sa"
2099 "mpler-channel> is the respective sampler channel number.\n\nIf more th"
2100 "an 1 MIDI inputs are currently connected to this sampler channel: Send"
2101 "ing this command will disconnect ALL currently connected MIDI input po"
2102 "rts connected to this sampler channel before establishing the new MIDI"
2103 " input connection. So this command does NOT add the connection, it rep"
2104 "laces all existing ones instead. This behavior is due to preserving fu"
2105 "ll behavior backward compatibility.\n\nPossible Answers:\n\n\"OK\" - o"
2106 "n success\n\n\"WRN:<warning-code>:<warning-message>\" - if MIDI input"
2107 "type was set, but there are noteworthy issue(s) related, providing an"
2108 "appropriate warning code and warning message\n\n\"ERR:<error-code>:<er"
2109 "ror-message>\" - in case it failed, providing an appropriate error cod"
2110 "e and error message\n\nExamples:\n\n\n\nDeprecated:\n\nShould not be u"
2111 "sed anymore. This command is currently only preserved for backward com"
2112 "patibility.\n\nThis command is a relict from times where only 1 MIDI i"
2113 "nput per sampler channels was allowed and where no sophisticated drive"
2114 "r management existed yet. Use \"ADD CHANNEL MIDI_INPUT\" and \"REMOVE"
2115 "CHANNEL MIDI_INPUT\" instead.\n\n"
2116 },
2117 { "SET CHANNEL MIDI_INPUT_PORT",
2118 "DEPRECATED: THIS COMMAND WILL DISAPPEAR!\n\nThe front-end can alter th"
2119 "e MIDI input port on a specific sampler channel by sending the followi"
2120 "ng command:\n\nSET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-inp"
2121 "ut-port>\n\nWhere <midi-input-port> is a MIDI input port number of the"
2122 " MIDI input device connected to the sampler channel given by <sampler-"
2123 "channel>.\n\nIf more than 1 MIDI inputs are currently connected to thi"
2124 "s sampler channel: Sending this command will switch the connection of"
2125 "the first (and only the first) MIDI input port currently being connect"
2126 "ed to this sampler channel, to another port of the same MIDI input dev"
2127 "ice. Or in other words: the first MIDI input port currently connected"
2128 "to this sampler channel will be disconnected, and the requested other"
2129 "port of its MIDI input device will be connected to this sampler channe"
2130 "l instead. This behavior is due to preserving full behavior backward c"
2131 "ompatibility.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"WRN:<wa"
2132 "rning-code>:<warning-message>\" - if MIDI input port was set, but ther"
2133 "e are noteworthy issue(s) related, providing an appropriate warning co"
2134 "de and warning message\n\n\"ERR:<error-code>:<error-message>\" - in ca"
2135 "se it failed, providing an appropriate error code and error message\n"
2136 "\nExamples:\n\n\n\nDeprecated:\n\nShould not be used anymore. This comm"
2137 "and is currently only preserved for backward compatibility.\n\nThis co"
2138 "mmand is a relict from times where only one MIDI input per sampler cha"
2139 "nnel was allowed. Use \"ADD CHANNEL MIDI_INPUT\" and \"REMOVE CHANNEL"
2140 "MIDI_INPUT\" instead.\n\n"
2141 },
2142 { "SET MIDI_INPUT_DEVICE_PARAMETER",
2143 "Use the following command to alter a specific setting of a created MID"
2144 "I input device:\n\nSET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<"
2145 "value>\n\nWhere <device-id> should be replaced by the numerical ID of"
2146 "the MIDI input device as returned by the \"CREATE MIDI_INPUT_DEVICE\""
2147 "or \"LIST MIDI_INPUT_DEVICES\" command, <key> by the name of the param"
2148 "eter to change and <value> by the new value for this parameter.\n\nPos"
2149 "sible Answers:\n\n\"OK\" - in case setting was successfully changed\n"
2150 "\n\"WRN:<warning-code>:<warning-message>\" - in case setting was change"
2151 "d successfully, but there are noteworthy issue(s) related, providing a"
2152 "n appropriate warning code and warning message\n\n\"ERR:<error-code>:<"
2153 "error-message>\" - in case it failed, providing an appropriate error c"
2154 "ode and error message\n\nExample:\n\nC: \"SET MIDI_INPUT_DEVICE_PARAME"
2155 "TER 0 ACTIVE=false\"\n\nS: \"OK\"\n\n"
2156 },
2157 { "RESET CHANNEL",
2158 "The front-end can reset a particular sampler channel by sending the fo"
2159 "llowing command:\n\nRESET CHANNEL <sampler-channel>\n\nWhere <sampler-"
2160 "channel> defines the sampler channel to be reset. This will cause the"
2161 "engine on that sampler channel, its voices and eventually disk streams"
2162 " and all control and status variables to be reset.\n\nPossible Answers"
2163 ":\n\n\"OK\" - on success\n\n\"WRN:<warning-code>:<warning-message>\" -"
2164 " if channel was reset, but there are noteworthy issue(s) related, prov"
2165 "iding an appropriate warning code and warning message\n\n\"ERR:<error-"
2166 "code>:<error-message>\" - in case it failed, providing an appropriate"
2167 "error code and error message\n\nExamples:\n\n\n\n"
2168 },
2169 { "GET DB_INSTRUMENT INFO",
2170 "The front-end can ask for the current settings of an instrument by sen"
2171 "ding the following command:\n\nGET DB_INSTRUMENT INFO <instr_path>\n\n"
2172 "Where <instr_path> should be replaced by the absolute path name of the"
2173 " instrument the front-end is interested in.\n\nPossible Answers:\n\nLi"
2174 "nuxSampler will answer by sending a <CRLF> separated list. Each answer"
2175 " line begins with the settings category name followed by a colon and t"
2176 "hen a space character <SP> and finally the info character string to th"
2177 "at setting category. At the moment the following categories are define"
2178 "d:\n\nINSTRUMENT_FILE - File name of the instrument. Note that the cha"
2179 "racter string may contain escape sequences .\n\nINSTRUMENT_NR - Index"
2180 "of the instrument within the file.\n\nFORMAT_FAMILY - The format famil"
2181 "y of the instrument.\n\nFORMAT_VERSION - The format version of the ins"
2182 "trument.\n\nSIZE - The size of the instrument in bytes.\n\nCREATED - T"
2183 "he date and time when the instrument is added in the instruments datab"
2184 "ase, represented in \"YYYY-MM-DD HH:MM:SS\" format\n\nMODIFIED - The d"
2185 "ate and time of the last modification of the instrument's database set"
2186 "tings, represented in \"YYYY-MM-DD HH:MM:SS\" format\n\nDESCRIPTION -"
2187 "A brief description of the instrument. Note that the character string"
2188 "may contain escape sequences .\n\nIS_DRUM - either true or false, dete"
2189 "rmines whether the instrument is a drumkit or a chromatic instrument\n"
2190 "\nPRODUCT - The product title of the instrument. Note that the charact"
2191 "er string may contain escape sequences .\n\nARTISTS - Lists the artist"
2192 " names. Note that the character string may contain escape sequences ."
2193 "\n\nKEYWORDS - Provides a list of keywords that refer to the instrument"
2194 ". Keywords are separated with semicolon and blank. Note that the chara"
2195 "cter string may contain escape sequences .\n\nThe mentioned fields abo"
2196 "ve don't have to be in particular order.\n\nExample:\n\nC: \"GET DB_IN"
2197 "STRUMENT INFO '/Piano Collection/Bosendorfer 290'\"\n\nS: \"INSTRUMENT"
2198 "_FILE: /home/me/gigs/Bosendorfer 290.gig\"\n\n\"INSTRUMENT_NR: 0\"\n\n"
2199 "\"FORMAT_FAMILY: GIG\"\n\n\"FORMAT_VERSION: 2\"\n\n\"SIZE: 2050871870"
2200 "\"\n\n\"CREATED: 2007-02-05 10:23:12\"\n\n\"MODIFIED: 2007-04-07 12:50:"
2201 "21\"\n\n\"DESCRIPTION: \"\n\n\"IS_DRUM: false\"\n\n\"PRODUCT: GRANDIOS"
2202 "O Bosendorfer 290\"\n\n\"ARTISTS: Post Musical Instruments\"\n\n\"KEYW"
2203 "ORDS: Bosendorfer\"\n\n\".\"\n\n"
2204 },
2205 { "SET DB_INSTRUMENT NAME",
2206 "The front-end can alter the name of a specific instrument by sending t"
2207 "he following command:\n\nSET DB_INSTRUMENT NAME <instr> <name>\n\nWher"
2208 "e <instr> is the absolute path name of the instrument and <name> is th"
2209 "e new name for that instrument.\n\nPossible Answers:\n\n\"OK\" - on su"
2210 "ccess\n\n\"ERR:<error-code>:<error-message>\" - in case the given inst"
2211 "rument does not exists, or if an instrument with name equal to the new"
2212 " name already exists.\n\nExample:\n\nC: \"SET DB_INSTRUMENT NAME '/Pia"
2213 "no Collection/Bosendorfer' 'Bosendorfer 290'\"\n\nS: \"OK\"\n\n"
2214 },
2215 { "COPY DB_INSTRUMENT",
2216 "The front-end can copy a specific instrument to another directory by s"
2217 "ending the following command:\n\nCOPY DB_INSTRUMENT <instr> <dst>\n\nW"
2218 "here <instr> is the absolute path name of the instrument to copy and <"
2219 "dst> is the directory where the instrument will be copied to.\n\nPossi"
2220 "ble Answers:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:<error-messa"
2221 "ge>\" - in case the given instrument does not exists, or if an instrum"
2222 "ent with name equal to the name of the specified instrument already ex"
2223 "ists in the destination directory.\n\nExample:\n\nC: \"COPY DB_INSTRUM"
2224 "ENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'\"\n\nS: \""
2225 "OK\"\n\n"
2226 },
2227 { "SET ECHO",
2228 "To enable or disable back sending of commands to the client the follow"
2229 "ing command can be used:\n\nSET ECHO <value>\n\nWhere <value> should b"
2230 "e replaced either by \"1\" to enable echo mode or \"0\" to disable ech"
2231 "o mode. When echo mode is enabled, all commands send to LinuxSampler w"
2232 "ill be immediately send back and after this echo the actual response t"
2233 "o the command will be returned. Echo mode will only be altered for the"
2234 " client connection that issued the \"SET ECHO\" command, not globally"
2235 "for all client connections.\n\nPossible Answers:\n\n\"OK\" - usually\n"
2236 "\n\"ERR:<error-code>:<error-message>\" - on syntax error, e.g. non boo"
2237 "lean value\n\nExamples:\n\n\n\n"
2238 },
2239 { "DESTROY FX_SEND",
2240 "The front-end can remove an existing effect send on a specific sampler"
2241 " channel by sending the following command:\n\nDESTROY FX_SEND <sampler"
2242 "-channel> <fx-send-id>\n\nWhere <sampler-channel> is the respective sa"
2243 "mpler channel number as returned by the \"ADD CHANNEL\" or \"LIST CHAN"
2244 "NELS\" command, that is the sampler channel from which the effect send"
2245 " should be removed from and <fx-send-id> is the respective effect send"
2246 " number as returned by the \"CREATE FX_SEND\" or \"LIST FX_SENDS\" com"
2247 "mand.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"ERR:<error-code"
2248 ">:<error-message>\" - in case it failed, providing an appropriate erro"
2249 "r code and error message\n\nExample:\n\nC: \"DESTROY FX_SEND 0 0\"\n\n"
2250 "S: \"OK\"\n\n"
2251 },
2252 { "FORMAT INSTRUMENTS_DB",
2253 "The front-end can remove all instruments and directories and re-create"
2254 " the instruments database structure (e.g., in case of a database corru"
2255 "ption) by sending the following command:\n\nFORMAT INSTRUMENTS_DB\n\nP"
2256 "ossible Answers:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:<error-m"
2257 "essage>\" - If the formatting of the instruments database failed.\n\n"
2258 },
2259 { "GET FILE INSTRUMENTS",
2260 "The front-end can retrieve the amount of instruments within a given in"
2261 "strument file by sending the following command:\n\nGET FILE INSTRUMENT"
2262 "S <filename>\n\nWhere <filename> is the name of the instrument file (e"
2263 "ncapsulated into apostrophes, supporting escape sequences as described"
2264 " in chapter \" Character Set and Escape Sequences \").\n\nThe sampler"
2265 "will try to ask all sampler engines, whether they support the given fi"
2266 "le and ask the first engine with a positive answer for the amount of i"
2267 "nstruments.\n\nPossible Answers:\n\nOn success, the sampler will answe"
2268 "r by returning the amount of instruments.\n\n\"ERR:<error-code>:<error"
2269 "-message>\" - if the file could not be handled\n\nExamples:\n\nC: \"GE"
2270 "T FILE INSTRUMENTS 'D:/Sounds/Foo.gig'\"\n\nS: \"10\"\n\n"
2271 },
2272 { "SUBSCRIBE TOTAL_VOICE_COUNT",
2273 "Client may want to be notified when the total number of voices on the"
2274 "back-end changes by issuing the following command:\n\nSUBSCRIBE TOTAL_"
2275 "VOICE_COUNT\n\nServer will start sending the following notification me"
2276 "ssages:\n\n\"NOTIFY:TOTAL_VOICE_COUNT:<voices>\"\n\nwhere <voices> wil"
2277 "l be replaced by the new number of all currently active voices.\n\n"
2278 },
2279 { "SUBSCRIBE SEND_EFFECT_CHAIN_COUNT",
2280 "Client may want to be notified when the number of send effect chains i"
2281 "s changed by issuing the following command:\n\nSUBSCRIBE SEND_EFFECT_C"
2282 "HAIN_COUNT\n\nServer will start sending the following notification mes"
2283 "sages:\n\n\"NOTIFY:SEND_EFFECT_CHAIN_COUNT:<device-id> <chains>\"\n\nw"
2284 "here <device-id> will be replaced by the numerical ID of the audio out"
2285 "put device, in which the number of send effect chains is changed and <"
2286 "chains> will be replaced by the new number of send effect chains.\n\n"
2287 },
2288 { "CREATE AUDIO_OUTPUT_DEVICE",
2289 "Use the following command to create a new audio output device for the"
2290 "desired audio output system:\n\nCREATE AUDIO_OUTPUT_DEVICE <audio-outp"
2291 "ut-driver> [<param-list>]\n\nWhere <audio-output-driver> should be rep"
2292 "laced by the desired audio output system as returned by the \"LIST AVA"
2293 "ILABLE_AUDIO_OUTPUT_DRIVERS\" command and <param-list> by an optional"
2294 "list of driver specific parameters in form of \"key1=val1 key2=val2 .."
2295 ".\", where character string values should be encapsulated into apostro"
2296 "phes ('). Note that there might be drivers which require parameter(s)"
2297 "to be given with this command. Use the previously described commands i"
2298 "n this chapter to get this information.\n\nPossible Answers:\n\n\"OK[<"
2299 "device-id>]\" - in case the device was successfully created, where <de"
2300 "vice-id> is the numerical ID of the new device\n\n\"WRN[<device-id>]:<"
2301 "warning-code>:<warning-message>\" - in case the device was created suc"
2302 "cessfully, where <device-id> is the numerical ID of the new device, bu"
2303 "t there are noteworthy issue(s) related (e.g. sound card doesn't suppo"
2304 "rt given hardware parameters and the driver is using fall-back values)"
2305 ", providing an appropriate warning code and warning message\n\n\"ERR:<"
2306 "error-code>:<error-message>\" - in case it failed, providing an approp"
2307 "riate error code and error message\n\nExamples:\n\nC: \"CREATE AUDIO_O"
2308 "UTPUT_DEVICE ALSA\"\n\nS: \"OK[0]\"\n\nC: \"CREATE AUDIO_OUTPUT_DEVICE"
2309 " ALSA CARD='2,0' SAMPLERATE=96000\"\n\nS: \"OK[1]\"\n\n"
2310 },
2311 { "REMOVE CHANNEL",
2312 "A sampler channel can be removed by sending the following command:\n\n"
2313 "REMOVE CHANNEL <sampler-channel>\n\nWhere <sampler-channel> should be"
2314 "replaced by the number of the sampler channel as given by the \"ADD CH"
2315 "ANNEL\" or \"LIST CHANNELS\" command. The channel numbers of all subse"
2316 "quent sampler channels remain the same.\n\nPossible Answers:\n\n\"OK\""
2317 " - in case the given sampler channel could be removed\n\n\"WRN:<warnin"
2318 "g-code>:<warning-message>\" - in case the given channel was removed, b"
2319 "ut there are noteworthy issue(s) related, providing an appropriate war"
2320 "ning code and warning message\n\n\"ERR:<error-code>:<error-message>\""
2321 "- in case it failed, providing an appropriate error code and error mes"
2322 "sage\n\nExample:\n\n\n\n"
2323 },
2324 { "SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO",
2325 "Client may want to be notified when changes were made to directories i"
2326 "n the instruments database by issuing the following command:\n\nSUBSCR"
2327 "IBE DB_INSTRUMENT_DIRECTORY_INFO\n\nServer will start sending the foll"
2328 "owing notification messages:\n\n\"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:"
2329 "<dir-path>\"\n\nwhere <dir-path> will be replaced by the absolute path"
2330 " name of the directory, for which information changes occurred. The fr"
2331 "ont-end will have to send the respective command to actually get the u"
2332 "pdated directory info. Because these messages will be triggered by LSC"
2333 "P commands issued by other clients rather than real time events happen"
2334 "ing on the server, it is believed that an empty notification message i"
2335 "s sufficient here.\n\n\"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-"
2336 "dir-path> <new-name>\"\n\nwhere <old-dir-path> is the old absolute pat"
2337 "h name of the directory (encapsulated into apostrophes), which name is"
2338 " changes and <new-name> is the new name of the directory, encapsulated"
2339 " into apostrophes.\n\n"
2340 },
2341 { "GET EFFECT INFO",
2342 "The front-end can ask for general information about an effect by sendi"
2343 "ng the following command:\n\nGET EFFECT INFO <effect-index>\n\nWhere <"
2344 "effect-index> is the numerical ID of an effect as returned by the \"LI"
2345 "ST AVAILABLE_EFFECTS\" command.\n\nPossible Answers:\n\nLinuxSampler w"
2346 "ill answer by sending a <CRLF> separated list. Each answer line begins"
2347 " with the effect information category name, followed by a colon and th"
2348 "en a space character <SP> and finally the info character string to tha"
2349 "t effect information category. At the moment the following categories"
2350 "are defined:\n\nSYSTEM - name of the effect plugin system the effect i"
2351 "s based on (e.g. \"LADSPA\")\n\nMODULE - module of the effect plugin s"
2352 "ystem that contains this effect, the module is usually the dynamic-lin"
2353 "ked library (DLL) filename of the effect plugin, including full path ("
2354 "note that this filename may contain escape sequences )\n\nNAME - chara"
2355 "cter string defining the unique name of the effect within its module ("
2356 "note that the character string may contain escape sequences )\n\nDESCR"
2357 "IPTION - human readable name of the effect, intended to be displayed i"
2358 "n user interfaces (note that the character string may contain escape s"
2359 "equences )\n\nThe mentioned fields above don't have to be in particula"
2360 "r order.\n\nExample:\n\nC: \"GET EFFECT INFO 121\"\n\nS: \"SYSTEM: LAD"
2361 "SPA\"\n\n\"MODULE: /usr/lib/ladspa/lowpass_iir_1891.so\"\n\n\"NAME: lo"
2362 "wpass_iir\"\n\n\"DESCRIPTION: Glame Lowpass Filter\"\n\n\".\"\n\n"
2363 },
2364 { "SUBSCRIBE",
2365 "The front-end can register itself to the LinuxSampler application to b"
2366 "e informed about noteworthy events by sending this command:\n\nSUBSCRI"
2367 "BE <event-id>\n\nwhere <event-id> will be replaced by the respective e"
2368 "vent that client wants to subscribe to.\n\nPossible Answers:\n\n\"OK\""
2369 " - on success\n\n\"WRN:<warning-code>:<warning-message>\" - if registr"
2370 "ation succeeded, but there are noteworthy issue(s) related, providing"
2371 "an appropriate warning code and warning message\n\n\"ERR:<error-code>:"
2372 "<error-message>\" - in case it failed, providing an appropriate error"
2373 "code and error message\n\nExamples:\n\n\n\n"
2374 },
2375 { "MAP MIDI_INSTRUMENT",
2376 "The front-end can create a new or replace an existing entry in a sampl"
2377 "er's MIDI instrument map by sending the following command:\n\nMAP MIDI"
2378 "_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog> <engine_name> <f"
2379 "ilename> <instrument_index> <volume_value> [<instr_load_mode>] [<name>"
2380 "]\n\nWhere <map> is the numeric ID of the map to alter, <midi_bank> is"
2381 " an integer value between 0..16383 reflecting the MIDI bank select ind"
2382 "ex, <midi_prog> an integer value between 0..127 reflecting the MIDI pr"
2383 "ogram change index, <engine_name> a sampler engine name as returned by"
2384 " the \"LIST AVAILABLE_ENGINES\" command (not encapsulated into apostro"
2385 "phes), <filename> the name of the instrument's file to be deployed (en"
2386 "capsulated into apostrophes, supporting escape sequences as described"
2387 "in chapter \" Character Set and Escape Sequences \"), <instrument_inde"
2388 "x> the index (integer value) of the instrument within the given file,"
2389 "<volume_value> reflects the master volume of the instrument as optiona"
2390 "lly dotted number (where a value < 1.0 means attenuation and a value >"
2391 " 1.0 means amplification). This parameter easily allows to adjust the"
2392 "volume of all intruments within a custom instrument map without having"
2393 " to adjust their instrument files. The OPTIONAL <instr_load_mode> argu"
2394 "ment defines the life time of the instrument, that is when the instrum"
2395 "ent should be loaded, when freed and has exactly the following possibi"
2396 "lities:\n\n\"ON_DEMAND\" - The instrument will be loaded when needed,"
2397 "that is when demanded by at least one sampler channel. It will immedia"
2398 "tely be freed from memory when not needed by any sampler channel anymo"
2399 "re.\n\n\"ON_DEMAND_HOLD\" - The instrument will be loaded when needed,"
2400 " that is when demanded by at least one sampler channel. It will be kep"
2401 "t in memory even when not needed by any sampler channel anymore. Instr"
2402 "uments with this mode are only freed when the sampler is reset or all"
2403 "mapping entries with this mode (and respective instrument) are explici"
2404 "tly changed to \"ON_DEMAND\" and no sampler channel is using the instr"
2405 "ument anymore.\n\n\"PERSISTENT\" - The instrument will immediately be"
2406 "loaded into memory when this mapping command is sent and the instrumen"
2407 "t is kept all the time. Instruments with this mode are only freed when"
2408 " the sampler is reset or all mapping entries with this mode (and respe"
2409 "ctive instrument) are explicitly changed to \"ON_DEMAND\" and no sampl"
2410 "er channel is using the instrument anymore.\n\nnot supplied - In case"
2411 "there is no <instr_load_mode> argument given, it will be up to the Ins"
2412 "trumentManager to decide which mode to use. Usually it will use \"ON_D"
2413 "EMAND\" if an entry for the given instrument does not exist in the Ins"
2414 "trumentManager's list yet, otherwise if an entry already exists, it wi"
2415 "ll simply stick with the mode currently reflected by the already exist"
2416 "ing entry, that is it will not change the mode.\n\nThe <instr_load_mod"
2417 "e> argument thus allows to define an appropriate strategy (low memory"
2418 "consumption vs. fast instrument switching) for each instrument individ"
2419 "ually. Note, the following restrictions apply to this argument: \"ON_D"
2420 "EMAND_HOLD\" and \"PERSISTENT\" have to be supported by the respective"
2421 " sampler engine (which is technically the case when the engine provide"
2422 "s an InstrumentManager for its format). If this is not the case the ar"
2423 "gument will automatically fall back to the default value \"ON_DEMAND\""
2424 ". Also the load mode of one instrument may automatically change the la"
2425 "od mode of other instrument(s), i.e. because the instruments are part"
2426 "of the same file and the engine does not allow a way to manage load mo"
2427 "des for them individually. Due to this, in case the frontend shows the"
2428 " load modes of entries, the frontend should retrieve the actual mode b"
2429 "y i.e. sending \"GET MIDI_INSTRUMENT INFO\" command(s). Finally the OP"
2430 "TIONAL <name> argument allows to set a custom name (encapsulated into"
2431 "apostrophes, supporting escape sequences as described in chapter \" Ch"
2432 "aracter Set and Escape Sequences \") for the mapping entry, useful for"
2433 " frontends for displaying an appropriate name for mapped instruments ("
2434 "using \"GET MIDI_INSTRUMENT INFO\" ).\n\nBy default, \"MAP MIDI_INSTRU"
2435 "MENT\" commands block until the mapping is completely established in t"
2436 "he sampler. The OPTIONAL \"NON_MODAL\" argument however causes the res"
2437 "pective \"MAP MIDI_INSTRUMENT\" command to return immediately, that is"
2438 " to let the sampler establish the mapping in the background. So this a"
2439 "rgument might be especially useful for mappings with a \"PERSISTENT\""
2440 "type, because these have to load the respective instruments immediatel"
2441 "y and might thus block for a very long time. It is recommended however"
2442 " to use the OPTIONAL \"NON_MODAL\" argument only if really necessary,"
2443 "because it has the following drawbacks: as \"NON_MODAL\" instructions"
2444 "return immediately, they may not necessarily return an error i.e. when"
2445 " the given instrument file turns out to be corrupt, beside that subseq"
2446 "uent commands in a LSCP instruction sequence might fail, because manda"
2447 "tory mappings are not yet completed.\n\nPossible Answers:\n\n\"OK\" -"
2448 "usually\n\n\"ERR:<error-code>:<error-message>\" - when the given map o"
2449 "r engine does not exist or a value is out of range\n\nExamples:\n\nC:"
2450 "\"MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERS"
2451 "ISTENT\"\n\nS: \"OK\"\n\nC: \"MAP MIDI_INSTRUMENT 0 4 50 gig '/home/jo"
2452 "hn/foostrings.gig' 7 1.0\"\n\nS: \"OK\"\n\nC: \"MAP MIDI_INSTRUMENT 0"
2453 "0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'\"\n\nS: \"OK\"\n\n"
2454 "C: \"MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Sile"
2455 "nt Piano'\"\n\nS: \"OK\"\n\nC: \"MAP MIDI_INSTRUMENT NON_MODAL 1 8 120"
2456 " gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'\"\n\nS: "
2457 "\"OK\"\n\n"
2458 },
2459 { "LIST AVAILABLE_EFFECTS",
2460 "The set of available internal effects can change at runtime. The front"
2461 "-end can retrieve the list of internal effects, available to the sampl"
2462 "er by sending the following command:\n\nLIST AVAILABLE_EFFECTS\n\nPoss"
2463 "ible Answers:\n\nThe sampler will answer by returning a comma separate"
2464 "d list with numerical IDs of effects. Note: the numercial ID of an eff"
2465 "ect is generated by the sampler for the current moment. The numerical"
2466 "ID of the same effect can change at runtime, e.g. when the user reques"
2467 "ts a rescan of available effect plugins.\n\nExample:\n\nC: \"LIST AVAI"
2468 "LABLE_EFFECTS\"\n\nS: \"5,6,7,120,121,122,123,124\"\n\n"
2469 },
2470 { "SUBSCRIBE DB_INSTRUMENT_INFO",
2471 "Client may want to be notified when changes were made to instruments i"
2472 "n the instruments database by issuing the following command:\n\nSUBSCR"
2473 "IBE DB_INSTRUMENT_INFO\n\nServer will start sending the following noti"
2474 "fication messages:\n\n\"NOTIFY:DB_INSTRUMENT_INFO:<instr-path>\"\n\nwh"
2475 "ere <instr-path> will be replaced by the absolute path name of the ins"
2476 "trument, which settings are changed. The front-end will have to send t"
2477 "he respective command to actually get the updated directory info. Beca"
2478 "use these messages will be triggered by LSCP commands issued by other"
2479 "clients rather than real time events happening on the server, it is be"
2480 "lieved that an empty notification message is sufficient here.\n\n\"NOT"
2481 "IFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>\"\n\nwhere <ol"
2482 "d-instr-path> is the old absolute path name of the instrument (encapsu"
2483 "lated into apostrophes), which name is changes and <new-name> is the n"
2484 "ew name of the instrument, encapsulated into apostrophes.\n\n"
2485 },
2486 { "GET MIDI_INPUT_PORT_PARAMETER INFO",
2487 "Use the following command to get detailed information about specific M"
2488 "IDI port parameter:\n\nGET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <po"
2489 "rt> <param>\n\nWhere <dev-id> is the numerical ID of the MIDI input de"
2490 "vice as returned by the \"CREATE MIDI_INPUT_DEVICE\" or \"LIST MIDI_IN"
2491 "PUT_DEVICES\" command, <port> the MIDI port number and <param> a speci"
2492 "fic port parameter name for which information should be obtained (as r"
2493 "eturned by the \"GET MIDI_INPUT_PORT INFO\" command).\n\nPossible Answ"
2494 "ers:\n\nLinuxSampler will answer by sending a <CRLF> separated list. E"
2495 "ach answer line begins with the information category name followed by"
2496 "a colon and then a space character <SP> and finally the info character"
2497 " string to that info category. There is information which is always re"
2498 "turned, independently of the given channel parameter and there is opti"
2499 "onal information which are only shown dependently to the given MIDI po"
2500 "rt. At the moment the following information categories are defined:\n"
2501 "\nTYPE - either \"BOOL\" for boolean value(s) or \"INT\" for integer va"
2502 "lue(s) or \"FLOAT\" for dotted number(s) or \"STRING\" for character s"
2503 "tring(s) (always returned)\n\nDESCRIPTION - arbitrary text describing"
2504 "the purpose of the parameter (always returned)\n\nFIX - either true or"
2505 " false, if true then this parameter is read only, thus cannot be alter"
2506 "ed (always returned)\n\nMULTIPLICITY - either true or false, defines i"
2507 "f this parameter allows only one value or a list of values, where true"
2508 " means multiple values and false only a single value allowed (always r"
2509 "eturned)\n\nRANGE_MIN - defines lower limit of the allowed value range"
2510 " for this parameter, can be an integer value as well as a dotted numbe"
2511 "r, this parameter is usually used in conjunction with 'RANGE_MAX' but"
2512 "may also appear without (optionally returned, dependent to driver and"
2513 "port parameter)\n\nRANGE_MAX - defines upper limit of the allowed valu"
2514 "e range for this parameter, can be an integer value as well as a dotte"
2515 "d number, this parameter is usually used in conjunction with 'RANGE_MI"
2516 "N' but may also appear without (optionally returned, dependent to driv"
2517 "er and port parameter)\n\nPOSSIBILITIES - comma separated list of poss"
2518 "ible values for this parameter, character strings are encapsulated int"
2519 "o apostrophes (optionally returned, dependent to device and port param"
2520 "eter)\n\nThe mentioned fields above don't have to be in particular ord"
2521 "er.\n\nExample:\n\nC: \"GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SE"
2522 "Q_BINDINGS\"\n\nS: \"DESCRIPTION: bindings to other ALSA sequencer cli"
2523 "ents\"\n\n\"TYPE: STRING\"\n\n\"FIX: false\"\n\n\"MULTIPLICITY: true\""
2524 "\n\n\"POSSIBILITIES: '64:0','68:0','68:1'\"\n\n\".\"\n\n"
2525 },
2526 { "GET EFFECT_INSTANCE INFO",
2527 "The front-end can ask for the current information about a particular e"
2528 "ffect instance by sending the following command:\n\nGET EFFECT_INSTANC"
2529 "E INFO <effect-instance>\n\nWhere <effect-instance> is the numerical I"
2530 "D of an effect instance as returned by the \"CREATE EFFECT_INSTANCE\""
2531 "or \"LIST EFFECT_INSTANCES\" command.\n\nPossible Answers:\n\nLinuxSam"
2532 "pler will answer by sending a <CRLF> separated list. Each answer line"
2533 "begins with the information category name, followed by a colon and the"
2534 "n a space character <SP> and finally the info character string to that"
2535 " information category. At the moment the following categories are defi"
2536 "ned:\n\nSYSTEM - name of the effect plugin system the effect is based"
2537 "on (e.g. \"LADSPA\")\n\nMODULE - module of the effect plugin system th"
2538 "at contains this effect, the module is usually the dynamic-linked libr"
2539 "ary (DLL) filename of the effect plugin, including full path (note tha"
2540 "t this filename may contain escape sequences )\n\nNAME - character str"
2541 "ing defining the unique name of the effect within its module (note tha"
2542 "t the character string may contain escape sequences )\n\nDESCRIPTION -"
2543 " human readable name of the effect, intended to be displayed in user i"
2544 "nterfaces (note that the character string may contain escape sequences"
2545 " )\n\nINPUT_CONTROLS - amount of input controls the effect instance pr"
2546 "ovides, to allow controlling the effect parameters in realtime\n\nThe"
2547 "mentioned fields above don't have to be in particular order.\n\nExampl"
2548 "e:\n\nC: \"GET EFFECT_INSTANCE INFO 3\"\n\nS: \"SYSTEM: LADSPA\"\n\n\""
2549 "MODULE: /usr/lib/ladspa/mod_delay_1419.so\"\n\n\"NAME: modDelay\"\n\n"
2550 "\"DESCRIPTION: Modulatable delay\"\n\n\"INPUT_CONTROLS: 1\"\n\n\".\"\n"
2551 "\n"
2552 },
2553 { "LIST DB_INSTRUMENT_DIRECTORIES",
2554 "The front-end can retrieve the current list of directories in specific"
2555 " directory by sending the following command:\n\nLIST DB_INSTRUMENT_DIR"
2556 "ECTORIES [RECURSIVE] <dir>\n\nWhere <dir> should be replaced by the ab"
2557 "solute path name of the directory. If RECURSIVE is specified, the abso"
2558 "lute path names of all directories, including those located in subdire"
2559 "ctories of the specified directory, will be returned.\n\nPossible Answ"
2560 "ers:\n\nA comma separated list of all instrument directories (encapsul"
2561 "ated into apostrophes) in the specified directory.\n\n\"ERR:<error-cod"
2562 "e>:<error-message>\" - if the given directory does not exist.\n\nExamp"
2563 "le:\n\nC: \"LIST DB_INSTRUMENT_DIRECTORIES '/'\"\n\nS: \"'Piano Collec"
2564 "tion','Percussion Collection'\"\n\nC: \"LIST DB_INSTRUMENT_DIRECTORIES"
2565 " RECURSIVE '/'\"\n\nS: \"'/Piano Collection','/Piano Collection/Acoust"
2566 "ic','/Piano Collection/Acoustic/New','/Percussion Collection'\"\n\n"
2567 },
2568 { "LIST MIDI_INSTRUMENTS",
2569 "The front-end can query a list of all currently existing entries in a"
2570 "certain MIDI instrument map by sending the following command:\n\nLIST"
2571 "MIDI_INSTRUMENTS <map>\n\nWhere <map> is the numeric ID of the MIDI in"
2572 "strument map.\n\nThe front-end can query a list of all currently exist"
2573 "ing entries of all MIDI instrument maps by sending the following comma"
2574 "nd:\n\nLIST MIDI_INSTRUMENTS ALL\n\nPossible Answers:\n\nThe sampler w"
2575 "ill answer by sending a comma separated list of map ID - MIDI bank - M"
2576 "IDI program triples, where each triple is encapsulated into curly brac"
2577 "es. The list is returned in one single line. Each triple just reflects"
2578 " the key of the respective map entry, thus subsequent \"GET MIDI_INSTR"
2579 "UMENT INFO\" command(s) are necessary to retrieve detailed information"
2580 " about each entry.\n\nExample:\n\nC: \"LIST MIDI_INSTRUMENTS 0\"\n\nS:"
2581 " \"{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}\"\n\n"
2582 },
2583 { "SUBSCRIBE TOTAL_STREAM_COUNT",
2584 "Client may want to be notified when the total number of disk streams o"
2585 "n the back-end changes by issuing the following command:\n\nSUBSCRIBE"
2586 "TOTAL_STREAM_COUNT\n\nServer will start sending the following notifica"
2587 "tion messages:\n\n\"NOTIFY:TOTAL_STREAM_COUNT:<streams>\"\n\nwhere <st"
2588 "reams> will be replaced by the new number of all currently active disk"
2589 " streams.\n\n"
2590 },
2591 { "FIND DB_INSTRUMENT_DIRECTORIES",
2592 "The front-end can search for directories in specific directory by send"
2593 "ing the following command:\n\nFIND DB_INSTRUMENT_DIRECTORIES [NON_RECU"
2594 "RSIVE] <dir> <criteria-list>\n\nWhere <dir> should be replaced by the"
2595 "absolute path name of the directory to search in. If NON_RECURSIVE is"
2596 "specified, the directories located in subdirectories of the specified"
2597 "directory will not be searched. <criteria-list> is a list of search cr"
2598 "iterias in form of \"key1=val1 key2=val2 ...\". The following criteria"
2599 "s are allowed:\n\nNAME='<search-string>' Restricts the search to direc"
2600 "tories, which names satisfy the supplied search string (encapsulated i"
2601 "nto apostrophes, supporting escape sequences as described in chapter "
2602 "\" Character Set and Escape Sequences \").\n\nCREATED='[<date-after>].."
2603 "[<date-before>]' Restricts the search to directories, which creation d"
2604 "ate satisfies the specified period, where <date-after> and <date-befor"
2605 "e> are in \"YYYY-MM-DD HH:MM:SS\" format. If <date-after> is omitted t"
2606 "he search is restricted to directories created before <date-before>. I"
2607 "f <date-before> is omitted, the search is restricted to directories cr"
2608 "eated after <date-after>.\n\nMODIFIED='[<date-after>]..[<date-before>]"
2609 "' Restricts the search to directories, which date of last modification"
2610 " satisfies the specified period, where <date-after> and <date-before>"
2611 "are in \"YYYY-MM-DD HH:MM:SS\" format. If <date-after> is omitted the"
2612 "search is restricted to directories, which are last modified before <d"
2613 "ate-before>. If <date-before> is omitted, the search is restricted to"
2614 "directories, which are last modified after <date-after>.\n\nDESCRIPTIO"
2615 "N='<search-string>' Restricts the search to directories with descripti"
2616 "on that satisfies the supplied search string (encapsulated into apostr"
2617 "ophes, supporting escape sequences as described in chapter \" Characte"
2618 "r Set and Escape Sequences \").\n\nWhere <search-string> is either a r"
2619 "egular expression, or a word list separated with spaces for OR search"
2620 "and with '+' for AND search.\n\nPossible Answers:\n\nA comma separated"
2621 " list with the absolute path names (encapsulated into apostrophes) of"
2622 "all directories in the specified directory that satisfy the supplied s"
2623 "earch criterias.\n\n\"ERR:<error-code>:<error-message>\" - if the give"
2624 "n directory does not exist.\n\nExample:\n\nC: \"FIND DB_INSTRUMENT_DIR"
2625 "ECTORIES '/' NAME='Piano'\"\n\nS: \"'/Piano Collection'\"\n\nC: \"FIND"
2626 " DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'\"\n\nS:"
2627 " \"'/Piano Collection','/Percussions'\"\n\n"
2628 },
2629 { "GET CHANNEL BUFFER_FILL",
2630 "The front-end can ask for the current fill state of all disk streams o"
2631 "n a sampler channel by sending the following command:\n\nGET CHANNEL B"
2632 "UFFER_FILL BYTES <sampler-channel>\n\nto get the fill state in bytes o"
2633 "r\n\nGET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>\n\nto get th"
2634 "e fill state in percent, where <sampler-channel> is the sampler channe"
2635 "l number the front-end is interested in as returned by the \"ADD CHANN"
2636 "EL\" or \"LIST CHANNELS\" command.\n\nPossible Answers:\n\nLinuxSample"
2637 "r will either answer by returning a comma separated string with the fi"
2638 "ll state of all disk stream buffers on that channel or an empty line i"
2639 "f there are no active disk streams or \"NA\" for *not available* in ca"
2640 "se the engine which is deployed doesn't support disk streaming. Each e"
2641 "ntry in the answer list will begin with the stream's ID in brackets fo"
2642 "llowed by the numerical representation of the fill size (either in byt"
2643 "es or percentage). Note: due to efficiency reasons the fill states in"
2644 "the response are not in particular order, thus the front-end has to so"
2645 "rt them by itself if necessary.\n\nExamples:\n\nC: \"GET CHANNEL BUFFE"
2646 "R_FILL BYTES 4\"\n\nS: \"[115]420500,[116]510300,[75]110000,[120]23070"
2647 "0\"\n\nC: \"GET CHANNEL BUFFER_FILL PERCENTAGE 4\"\n\nS: \"[115]90%,[1"
2648 "16]98%,[75]40%,[120]62%\"\n\nC: \"GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2649 "\"\n\nS: \"\"\n\n"
2650 },
2651 { "SUBSCRIBE MISCELLANEOUS",
2652 "Client may want to be notified of miscellaneous and debugging events o"
2653 "ccurring at the server by issuing the following command:\n\nSUBSCRIBE"
2654 "MISCELLANEOUS\n\nServer will start sending the following notification"
2655 "messages:\n\n\"NOTIFY:MISCELLANEOUS:<string>\"\n\nwhere <string> will"
2656 "be replaced by whatever data server wants to send to the client. Clien"
2657 "t MAY display this data to the user AS IS to facilitate debugging.\n\n"
2658 },
2659 { "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION",
2660 "The front-end can alter the description of a specific instrument direc"
2661 "tory by sending the following command:\n\nSET DB_INSTRUMENT_DIRECTORY"
2662 "DESCRIPTION <dir> <desc>\n\nWhere <dir> is the absolute path name of t"
2663 "he directory and <desc> is the new description for the directory (enca"
2664 "psulated into apostrophes, supporting escape sequences as described in"
2665 " chapter \" Character Set and Escape Sequences \").\n\nPossible Answer"
2666 "s:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:<error-message>\" - in"
2667 " case the given directory does not exists.\n\nExample:\n\nC: \"SET DB_"
2668 "INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of"
2669 "piano instruments in various format.'\"\n\nS: \"OK\"\n\n"
2670 },
2671 { "GET MIDI_INSTRUMENTS",
2672 "The front-end can query the amount of currently existing entries in a"
2673 "MIDI instrument map by sending the following command:\n\nGET MIDI_INST"
2674 "RUMENTS <map>\n\nThe front-end can query the amount of currently exist"
2675 "ing entries in all MIDI instrument maps by sending the following comma"
2676 "nd:\n\nGET MIDI_INSTRUMENTS ALL\n\nPossible Answers:\n\nThe sampler wi"
2677 "ll answer by sending the current number of entries in the MIDI instrum"
2678 "ent map(s).\n\nExample:\n\nC: \"GET MIDI_INSTRUMENTS 0\"\n\nS: \"234\""
2679 "\n\nC: \"GET MIDI_INSTRUMENTS ALL\"\n\nS: \"954\"\n\n"
2680 },
2681 { "LIST CHANNELS",
2682 "The number of sampler channels can change on runtime. To get the curre"
2683 "nt list of sampler channels, the front-end can send the following comm"
2684 "and:\n\nLIST CHANNELS\n\nPossible Answers:\n\nLinuxSampler will answer"
2685 " by returning a comma separated list with all sampler channels numeric"
2686 "al IDs.\n\nExample:\n\nC: \"LIST CHANNELS\"\n\nS: \"0,1,2,3,4,5,6,9,10"
2687 ",11,15,20\"\n\n"
2688 },
2689 { "SET VOLUME",
2690 "The client can alter the current global sampler-wide volume attenuatio"
2691 "n by sending the following command:\n\nSET VOLUME <volume>\n\nWhere <v"
2692 "olume> should be replaced by the optional dotted floating point value,"
2693 " reflecting the new global volume parameter. This value might usually"
2694 "be in the range between 0.0 and 1.0, that is for attenuating the overa"
2695 "ll volume.\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"WRN:<warni"
2696 "ng-code>:<warning-message>\" - if the global volume was set, but there"
2697 " are noteworthy issue(s) related, providing an appropriate warning cod"
2698 "e and warning message\n\n\"ERR:<error-code>:<error-message>\" - in cas"
2699 "e it failed, providing an appropriate error code and error message\n\n"
2700 },
2701 { "GET AVAILABLE_MIDI_INPUT_DRIVERS",
2702 "Use the following command to get the number of MIDI input drivers curr"
2703 "ently available for the LinuxSampler instance:\n\nGET AVAILABLE_MIDI_I"
2704 "NPUT_DRIVERS\n\nPossible Answers:\n\nLinuxSampler will answer by sendi"
2705 "ng the number of available MIDI input drivers.\n\nExample:\n\nC: \"GET"
2706 " AVAILABLE_MIDI_INPUT_DRIVERS\"\n\nS: \"2\"\n\n"
2707 },
2708 { "GET SEND_EFFECT_CHAINS",
2709 "The front-end can retrieve the current amount of send effect chains of"
2710 " an audio output device by sending the following command:\n\nGET SEND_"
2711 "EFFECT_CHAINS <audio-device>\n\nWhere <audio-device> should be replace"
2712 "d by the numerical ID of the audio output device as given by the \"CRE"
2713 "ATE AUDIO_OUTPUT_DEVICE\" or \"LIST AUDIO_OUTPUT_DEVICES\" command.\n"
2714 "\nPossible Answers:\n\nThe sampler will answer by returning the current"
2715 " number of send effect chains of the supplied audio output device.\n\n"
2716 "Examples:\n\nC: \"GET SEND_EFFECT_CHAINS 0\"\n\nS: \"4\"\n\n"
2717 },
2718 { "SET FX_SEND NAME",
2719 "The front-end can alter the current name of an effect send entity by s"
2720 "ending the following command:\n\nSET FX_SEND NAME <sampler-chan> <fx-s"
2721 "end-id> <name>\n\nWhere <sampler-chan> is the sampler channel number a"
2722 "s returned by the \"ADD CHANNEL\" or \"LIST CHANNELS\" command, <fx-se"
2723 "nd-id> reflects the numerical ID of the effect send entity as returned"
2724 " by the \"CREATE FX_SEND\" or \"LIST FX_SENDS\" command and <name> is"
2725 "the new name of the effect send entity, which does not have to be uniq"
2726 "ue (name MUST be encapsulated into apostrophes and supports escape seq"
2727 "uences as described in chapter \" Character Set and Escape Sequences "
2728 "\").\n\nPossible Answers:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:"
2729 "<error-message>\" - in case it failed, providing an appropriate error"
2730 "code and error message\n\nExample:\n\nC: \"SET FX_SEND NAME 0 0 'Fx Se"
2731 "nd 1'\"\n\nS: \"OK\"\n\n"
2732 },
2733 { "SET CHANNEL VOLUME",
2734 "The front-end can alter the volume of a sampler channel by sending the"
2735 " following command:\n\nSET CHANNEL VOLUME <sampler-channel> <volume>\n"
2736 "\nWhere <volume> is an optionally dotted positive number (a value smal"
2737 "ler than 1.0 means attenuation, whereas a value greater than 1.0 means"
2738 " amplification) and <sampler-channel> defines the sampler channel wher"
2739 "e this volume factor should be set.\n\nPossible Answers:\n\n\"OK\" - o"
2740 "n success\n\n\"WRN:<warning-code>:<warning-message>\" - if channel vol"
2741 "ume was set, but there are noteworthy issue(s) related, providing an a"
2742 "ppropriate warning code and warning message\n\n\"ERR:<error-code>:<err"
2743 "or-message>\" - in case it failed, providing an appropriate error code"
2744 " and error message\n\nExamples:\n\n\n\n"
2745 },
2746 { "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS",
2747 "Use the following command to get the number of audio output drivers cu"
2748 "rrently available for the LinuxSampler instance:\n\nGET AVAILABLE_AUDI"
2749 "O_OUTPUT_DRIVERS\n\nPossible Answers:\n\nLinuxSampler will answer by s"
2750 "ending the number of audio output drivers.\n\nExample:\n\nC: \"GET AVA"
2751 "ILABLE_AUDIO_OUTPUT_DRIVERS\"\n\nS: \"2\"\n\n"
2752 },
2753 { "GET SERVER INFO",
2754 "The client can ask for general information about the LinuxSampler inst"
2755 "ance by sending the following command:\n\nGET SERVER INFO\n\nPossible"
2756 "Answers:\n\nLinuxSampler will answer by sending a <CRLF> separated lis"
2757 "t. Each answer line begins with the information category name followed"
2758 " by a colon and then a space character <SP> and finally the info chara"
2759 "cter string to that information category. At the moment the following"
2760 "categories are defined:\n\nDESCRIPTION - arbitrary textual description"
2761 " about the sampler (note that the character string may contain escape"
2762 "sequences )\n\nVERSION - version of the sampler\n\nPROTOCOL_VERSION -"
2763 "version of the LSCP specification the sampler complies with (see for"
2764 "details)\n\nINSTRUMENTS_DB_SUPPORT - either yes or no, specifies wheth"
2765 "er the sampler is build with instruments database support.\n\nThe ment"
2766 "ioned fields above don't have to be in particular order. Other fields"
2767 "might be added in future.\n\nExample:\n\nC: \"GET SERVER INFO\"\n\nS:"
2768 "\"DESCRIPTION: LinuxSampler - modular, streaming capable sampler\"\n\n"
2769 "\"VERSION: 1.0.0.svn23\"\n\n\"PROTOCOL_VERSION: 1.5\"\n\n\"INSTRUMENTS"
2770 "_DB_SUPPORT: no\"\n\n\".\"\n\n"
2771 },
2772 { "REMOVE DB_INSTRUMENT_DIRECTORY",
2773 "The front-end can delete a particular instrument directory from the in"
2774 "struments database by sending the following command:\n\nREMOVE DB_INST"
2775 "RUMENT_DIRECTORY [FORCE] <dir>\n\nWhere <dir> is the absolute path nam"
2776 "e of the directory to delete. The optional FORCE argument can be used"
2777 "to force the deletion of a non-empty directory and all its content.\n"
2778 "\nPossible Answers:\n\n\"OK\" - if the directory is deleted successfull"
2779 "y\n\n\"ERR:<error-code>:<error-message>\" - if the given directory doe"
2780 "s not exist, or if trying to delete a non-empty directory, without usi"
2781 "ng the FORCE argument.\n\nExamples:\n\nC: \"REMOVE DB_INSTRUMENT_DIREC"
2782 "TORY FORCE '/Piano Collection'\"\n\nS: \"OK\"\n\n"
2783 },
2784 { "SET MIDI_INSTRUMENT_MAP NAME",
2785 "The front-end can alter the custom name of a MIDI instrument map by se"
2786 "nding the following command:\n\nSET MIDI_INSTRUMENT_MAP NAME <map> <na"
2787 "me>\n\nWhere <map> is the numerical ID of the map and <name> the new c"
2788 "ustom name of the map, which does not have to be unique (name MUST be"
2789 "encapsulated into apostrophes and supports escape sequences as describ"
2790 "ed in chapter \" Character Set and Escape Sequences \").\n\nPossible A"
2791 "nswers:\n\n\"OK\" - on success\n\n\"ERR:<error-code>:<error-message>\""
2792 " - in case the given map does not exist\n\nExample:\n\nC: \"SET MIDI_I"
2793 "NSTRUMENT_MAP NAME 0 'Foo instruments'\"\n\nS: \"OK\"\n\n"
2794 },
2795 { "LIST AVAILABLE_ENGINES",
2796 "The front-end can ask for a list of all available engines by sending t"
2797 "he following command:\n\nLIST AVAILABLE_ENGINES\n\nPossible Answers:\n"
2798 "\nLinuxSampler will answer by sending a comma separated list of the en"
2799 "gines' names encapsulated into apostrophes ('). Engine names can consi"
2800 "st of lower and upper cases, digits and underlines (\"_\" character)."
2801 "\n\nExample:\n\nC: \"LIST AVAILABLE_ENGINES\"\n\nS: \"'gig','sfz','sf2'"
2802 "\"\n\n"
2803 },
2804 };
2805
lscp_reference_for_command(const char * cmd)2806 lscp_ref_entry_t* lscp_reference_for_command(const char* cmd) {
2807 const int n1 = (int)strlen(cmd);
2808 if (!n1) return NULL;
2809 int foundLength = 0;
2810 lscp_ref_entry_t* foundEntry = NULL;
2811 for (int i = 0; i < sizeof(lscp_reference) / sizeof(lscp_ref_entry_t); ++i) {
2812 const int n2 = (int)strlen(lscp_reference[i].name);
2813 const int n = n1 < n2 ? n1 : n2;
2814 if (!strncmp(cmd, lscp_reference[i].name, n)) {
2815 if (foundEntry) {
2816 if (n1 < foundLength && n1 < n2) return NULL;
2817 if (n2 == foundLength) return NULL;
2818 if (n2 < foundLength) continue;
2819 }
2820 foundEntry = &lscp_reference[i];
2821 foundLength = n2;
2822 }
2823 }
2824 return foundEntry;
2825 }
2826