/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1006 by schoenebeck, Fri Dec 29 20:27:15 2006 UTC revision 2498 by schoenebeck, Thu Jan 9 22:05:21 2014 UTC
# Line 2  Line 2 
2    
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                                          LinuxSampler.org
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                         January 9, 2014
7  Expires: July 2, 2007                                  December 29, 2006  Expires: July 13, 2014
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.2                                  LSCP 1.6
12    
13    Abstract
14    
15       The LinuxSampler Control Protocol (LSCP) is an application-level
16       protocol primarily intended for local and remote controlling the
17       LinuxSampler backend application, which is a sophisticated server-
18       like console application essentially playing back audio samples and
19       manipulating the samples in real time to certain extent.
20    
21  Status of this Memo  Status of this Memo
22    
# Line 18  Status of this Memo Line 26  Status of this Memo
26     aware will be disclosed, in accordance with Section 6 of BCP 79.     aware will be disclosed, in accordance with Section 6 of BCP 79.
27    
28     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
29     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF).  Note that other groups may also distribute
30     other groups may also distribute working documents as Internet-     working documents as Internet-Drafts.  The list of current Internet-
31     Drafts.     Drafts is at http://datatracker.ietf.org/drafts/current/.
32    
33     Internet-Drafts are draft documents valid for a maximum of six months     Internet-Drafts are draft documents valid for a maximum of six months
34     and may be updated, replaced, or obsoleted by other documents at any     and may be updated, replaced, or obsoleted by other documents at any
35     time.  It is inappropriate to use Internet-Drafts as reference     time.  It is inappropriate to use Internet-Drafts as reference
36     material or to cite them other than as "work in progress."     material or to cite them other than as "work in progress."
37    
38     The list of current Internet-Drafts can be accessed at     This Internet-Draft will expire on July 13, 2014.
    http://www.ietf.org/ietf/1id-abstracts.txt.  
39    
    The list of Internet-Draft Shadow Directories can be accessed at  
    http://www.ietf.org/shadow.html.  
40    
    This Internet-Draft will expire on July 2, 2007.  
41    
 Copyright Notice  
42    
    Copyright (C) The Internet Society (2006).  
43    
44    
45    
# Line 50  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55    Schoenebeck               Expires July 13, 2014                 [Page 1]
56    
57    Internet-Draft        LinuxSampler Control Protocol         January 2014
58    
59    
60    Table of Contents
61    
62       1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   7
63       2.  Versioning of this specification  . . . . . . . . . . . . . .   8
64       3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   9
65       4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .  10
66       5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  11
67         5.1.  Request/response communication method . . . . . . . . . .  11
68           5.1.1.   Result format  . . . . . . . . . . . . . . . . . . .  12
69         5.2.  Subscribe/notify communication method . . . . . . . . . .  14
70       6.  Description for control commands  . . . . . . . . . . . . . .  16
71         6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  16
72         6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  16
73           6.2.1.   Getting amount of available audio output drivers . .  17
74           6.2.2.   Getting all available audio output drivers . . . . .  17
75           6.2.3.   Getting information about a specific audio output
76                    driver . . . . . . . . . . . . . . . . . . . . . . .  17
77           6.2.4.   Getting information about specific audio output
78                    driver parameter . . . . . . . . . . . . . . . . . .  18
79           6.2.5.   Creating an audio output device  . . . . . . . . . .  22
80           6.2.6.   Destroying an audio output device  . . . . . . . . .  23
81           6.2.7.   Getting all created audio output device count  . . .  24
82           6.2.8.   Getting all created audio output device list . . . .  24
83           6.2.9.   Getting current settings of an audio output device .  24
84           6.2.10.  Changing settings of audio output devices  . . . . .  26
85           6.2.11.  Getting information about an audio channel . . . . .  27
86           6.2.12.  Getting information about specific audio channel
87                    parameter  . . . . . . . . . . . . . . . . . . . . .  28
88           6.2.13.  Changing settings of audio output channels . . . . .  30
89         6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  31
90           6.3.1.   Getting amount of available MIDI input drivers . . .  32
91           6.3.2.   Getting all available MIDI input drivers . . . . . .  32
92           6.3.3.   Getting information about a specific MIDI input
93                    driver . . . . . . . . . . . . . . . . . . . . . . .  33
94           6.3.4.   Getting information about specific MIDI input
95                    driver parameter . . . . . . . . . . . . . . . . . .  34
96           6.3.5.   Creating a MIDI input device . . . . . . . . . . . .  36
97           6.3.6.   Destroying a MIDI input device . . . . . . . . . . .  37
98           6.3.7.   Getting all created MIDI input device count  . . . .  38
99           6.3.8.   Getting all created MIDI input device list . . . . .  38
100           6.3.9.   Getting current settings of a MIDI input device  . .  39
101           6.3.10.  Changing settings of MIDI input devices  . . . . . .  40
102           6.3.11.  Getting information about a MIDI port  . . . . . . .  40
103           6.3.12.  Getting information about specific MIDI port
104                    parameter  . . . . . . . . . . . . . . . . . . . . .  41
105           6.3.13.  Changing settings of MIDI input ports  . . . . . . .  43
106         6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  44
107           6.4.1.   Loading an instrument  . . . . . . . . . . . . . . .  44
108    
109    
110    
111    Schoenebeck               Expires July 13, 2014                 [Page 2]
112    
113    Internet-Draft        LinuxSampler Control Protocol         January 2014
114    
115    
116           6.4.2.   Loading a sampler engine . . . . . . . . . . . . . .  45
117           6.4.3.   Getting all created sampler channel count  . . . . .  46
118           6.4.4.   Getting all created sampler channel list . . . . . .  47
119           6.4.5.   Adding a new sampler channel . . . . . . . . . . . .  47
120           6.4.6.   Removing a sampler channel . . . . . . . . . . . . .  48
121           6.4.7.   Getting amount of available engines  . . . . . . . .  49
122           6.4.8.   Getting all available engines  . . . . . . . . . . .  49
123           6.4.9.   Getting information about an engine  . . . . . . . .  49
124           6.4.10.  Getting sampler channel information  . . . . . . . .  51
125           6.4.11.  Current number of active voices  . . . . . . . . . .  54
126           6.4.12.  Current number of active disk streams  . . . . . . .  54
127           6.4.13.  Current fill state of disk stream buffers  . . . . .  55
128           6.4.14.  Setting audio output device  . . . . . . . . . . . .  56
129           6.4.15.  Setting audio output type  . . . . . . . . . . . . .  56
130           6.4.16.  Setting audio output channel . . . . . . . . . . . .  57
131           6.4.17.  Add MIDI input to sampler channel  . . . . . . . . .  58
132           6.4.18.  Remove MIDI input(s) from sampler channel  . . . . .  59
133           6.4.19.  Getting all MIDI inputs of a sampler channel . . . .  60
134           6.4.20.  Setting MIDI input device  . . . . . . . . . . . . .  61
135           6.4.21.  Setting MIDI input type  . . . . . . . . . . . . . .  62
136           6.4.22.  Setting MIDI input port  . . . . . . . . . . . . . .  63
137           6.4.23.  Setting MIDI input channel . . . . . . . . . . . . .  64
138           6.4.24.  Setting channel volume . . . . . . . . . . . . . . .  65
139           6.4.25.  Muting a sampler channel . . . . . . . . . . . . . .  66
140           6.4.26.  Soloing a sampler channel  . . . . . . . . . . . . .  66
141           6.4.27.  Assigning a MIDI instrument map to a sampler
142                    channel  . . . . . . . . . . . . . . . . . . . . . .  67
143           6.4.28.  Adding an effect send to a sampler channel . . . . .  68
144           6.4.29.  Removing an effect send from a sampler channel . . .  69
145           6.4.30.  Getting amount of effect sends on a sampler
146                    channel  . . . . . . . . . . . . . . . . . . . . . .  70
147           6.4.31.  Listing all effect sends on a sampler channel  . . .  71
148           6.4.32.  Getting effect send information  . . . . . . . . . .  71
149           6.4.33.  Changing effect send's name  . . . . . . . . . . . .  73
150           6.4.34.  Altering effect send's audio routing . . . . . . . .  74
151           6.4.35.  Assigning destination effect to an effect send . . .  75
152           6.4.36.  Removing destination effect from an effect send  . .  76
153           6.4.37.  Altering effect send's MIDI controller . . . . . . .  76
154           6.4.38.  Altering effect send's send level  . . . . . . . . .  77
155           6.4.39.  Sending MIDI messages to sampler channel . . . . . .  78
156           6.4.40.  Resetting a sampler channel  . . . . . . . . . . . .  79
157         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  80
158           6.5.1.   Register front-end for receiving event messages  . .  80
159           6.5.2.   Unregister front-end for not receiving event
160                    messages . . . . . . . . . . . . . . . . . . . . . .  81
161           6.5.3.   Enable or disable echo of commands . . . . . . . . .  81
162           6.5.4.   Close client connection  . . . . . . . . . . . . . .  82
163         6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  82
164    
165    
166    
167    Schoenebeck               Expires July 13, 2014                 [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol         January 2014
170    
171    
172           6.6.1.   Current number of active voices  . . . . . . . . . .  82
173           6.6.2.   Maximum amount of active voices  . . . . . . . . . .  82
174           6.6.3.   Current number of active disk streams  . . . . . . .  83
175           6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  83
176           6.6.5.   General sampler informations . . . . . . . . . . . .  83
177           6.6.6.   Getting global volume attenuation  . . . . . . . . .  84
178           6.6.7.   Setting global volume attenuation  . . . . . . . . .  85
179           6.6.8.   Getting global voice limit . . . . . . . . . . . . .  85
180           6.6.9.   Setting global voice limit . . . . . . . . . . . . .  86
181           6.6.10.  Getting global disk stream limit . . . . . . . . . .  87
182           6.6.11.  Setting global disk stream limit . . . . . . . . . .  87
183         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  88
184           6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  88
185           6.7.2.   Delete one particular or all MIDI instrument maps  .  89
186           6.7.3.   Get amount of existing MIDI instrument maps  . . . .  90
187           6.7.4.   Getting all created MIDI instrument maps . . . . . .  90
188           6.7.5.   Getting MIDI instrument map information  . . . . . .  91
189           6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  92
190           6.7.7.   Create or replace a MIDI instrument map entry  . . .  92
191           6.7.8.   Getting amount of MIDI instrument map entries  . . .  95
192           6.7.9.   Getting indeces of all entries of a MIDI
193                    instrument map . . . . . . . . . . . . . . . . . . .  96
194           6.7.10.  Remove an entry from the MIDI instrument map . . . .  96
195           6.7.11.  Get current settings of MIDI instrument map entry  .  97
196           6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  99
197         6.8.  Managing Instruments Database . . . . . . . . . . . . . .  99
198           6.8.1.   Creating a new instrument directory  . . . . . . . . 100
199           6.8.2.   Deleting an instrument directory . . . . . . . . . . 100
200           6.8.3.   Getting amount of instrument directories . . . . . . 101
201           6.8.4.   Listing all directories in specific directory  . . . 101
202           6.8.5.   Getting instrument directory information . . . . . . 102
203           6.8.6.   Renaming an instrument directory . . . . . . . . . . 103
204           6.8.7.   Moving an instrument directory . . . . . . . . . . . 104
205           6.8.8.   Copying instrument directories . . . . . . . . . . . 104
206           6.8.9.   Changing the description of directory  . . . . . . . 105
207           6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 106
208           6.8.11.  Adding instruments to the instruments database . . . 107
209           6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 109
210           6.8.13.  Getting amount of instruments  . . . . . . . . . . . 109
211           6.8.14.  Listing all instruments in specific directory  . . . 110
212           6.8.15.  Getting instrument information . . . . . . . . . . . 110
213           6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 113
214           6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 113
215           6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 114
216           6.8.19.  Changing the description of instrument . . . . . . . 115
217           6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 115
218           6.8.21.  Getting job status information . . . . . . . . . . . 118
219           6.8.22.  Formatting the instruments database  . . . . . . . . 119
220    
221    
222    
223    Schoenebeck               Expires July 13, 2014                 [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol         January 2014
226    
227    
228           6.8.23.  Checking for lost instrument files . . . . . . . . . 119
229           6.8.24.  Replacing an instrument file . . . . . . . . . . . . 120
230         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 120
231           6.9.1.   Opening an appropriate instrument editor
232                    application  . . . . . . . . . . . . . . . . . . . . 121
233         6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 122
234           6.10.1.  Retrieving amount of instruments of a file . . . . . 122
235           6.10.2.  Retrieving all instruments of a file . . . . . . . . 122
236           6.10.3.  Retrieving informations about one instrument in a
237                    file . . . . . . . . . . . . . . . . . . . . . . . . 123
238         6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 125
239           6.11.1.  Retrieve amount of available effects . . . . . . . . 125
240           6.11.2.  Get list of available effects  . . . . . . . . . . . 126
241           6.11.3.  Retrieving general information about an effect . . . 126
242           6.11.4.  Creating an instance of an effect by its portable
243                    ID . . . . . . . . . . . . . . . . . . . . . . . . . 127
244           6.11.5.  Creating an instance of an effect by its
245                    numerical ID . . . . . . . . . . . . . . . . . . . . 128
246           6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 129
247           6.11.7.  Retrieve amount of effect instances  . . . . . . . . 130
248           6.11.8.  Get list of effect instances . . . . . . . . . . . . 131
249           6.11.9.  Retrieving current information about an effect
250                    instance . . . . . . . . . . . . . . . . . . . . . . 131
251           6.11.10. Retrieving information about an effect parameter . . 132
252           6.11.11. Altering an effect parameter . . . . . . . . . . . . 134
253           6.11.12. Retrieve amount of send effect chains  . . . . . . . 135
254           6.11.13. Retrieve list of send effect chains  . . . . . . . . 135
255           6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 136
256           6.11.15. Remove send effect chain . . . . . . . . . . . . . . 136
257           6.11.16. Retrieving information about a send effect chain . . 137
258           6.11.17. Append effect instance to a send effect chain  . . . 138
259           6.11.18. Insert effect instance to a send effect chain  . . . 139
260           6.11.19. Remove effect instance from send effect chain  . . . 139
261       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 141
262         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 158
263       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
264         8.1.  Number of audio output devices changed  . . . . . . . . . 162
265         8.2.  Audio output device's settings changed  . . . . . . . . . 162
266         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 162
267         8.4.  MIDI input device's settings changed  . . . . . . . . . . 163
268         8.5.  Number of sampler channels changed  . . . . . . . . . . . 163
269         8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 163
270         8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 164
271         8.8.  Number of active voices changed . . . . . . . . . . . . . 164
272         8.9.  Number of active disk streams changed . . . . . . . . . . 165
273         8.10. Disk stream buffer fill state changed . . . . . . . . . . 165
274         8.11. Channel information changed . . . . . . . . . . . . . . . 165
275         8.12. Number of effect sends changed  . . . . . . . . . . . . . 166
276    
277    
278    
279    Schoenebeck               Expires July 13, 2014                 [Page 5]
280    
281    Internet-Draft        LinuxSampler Control Protocol         January 2014
282    
283    
284         8.13. Effect send information changed . . . . . . . . . . . . . 166
285         8.14. Total number of active voices changed . . . . . . . . . . 167
286         8.15. Total number of active disk streams changed . . . . . . . 167
287         8.16. Number of MIDI instrument maps changed  . . . . . . . . . 167
288         8.17. MIDI instrument map information changed . . . . . . . . . 167
289         8.18. Number of MIDI instruments changed  . . . . . . . . . . . 168
290         8.19. MIDI instrument information changed . . . . . . . . . . . 168
291         8.20. Global settings changed . . . . . . . . . . . . . . . . . 169
292         8.21. Number of database instrument directories changed . . . . 169
293         8.22. Database instrument directory information changed . . . . 169
294         8.23. Number of database instruments changed  . . . . . . . . . 170
295         8.24. Database instrument information changed . . . . . . . . . 170
296         8.25. Database job status information changed . . . . . . . . . 171
297         8.26. Number of effect instances changed  . . . . . . . . . . . 171
298         8.27. Effect instance information changed . . . . . . . . . . . 172
299         8.28. Number of send effect chains changed  . . . . . . . . . . 172
300         8.29. Send effect chain information changed . . . . . . . . . . 172
301         8.30. Miscellaneous and debugging events  . . . . . . . . . . . 173
302       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 174
303       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 175
304       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 176
305       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 177
306       Intellectual Property and Copyright Statements  . . . . . . . . . 178
307    
308    
 Schoenebeck               Expires July 2, 2007                  [Page 1]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
309    
310    
 Abstract  
311    
    The LinuxSampler Control Protocol (LSCP) is an application-level  
    protocol primarily intended for local and remote controlling the  
    LinuxSampler backend application, which is a sophisticated server-  
    like console application essentially playing back audio samples and  
    manipulating the samples in real time to certain extent.  
312    
313    
 Table of Contents  
314    
    1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5  
    2.  Versioning of this specification  . . . . . . . . . . . . . .   6  
    3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7  
    4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8  
    5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9  
      5.1.  Request/response communication method . . . . . . . . . .   9  
        5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10  
      5.2.  Subscribe/notify communication method . . . . . . . . . .  12  
    6.  Description for control commands  . . . . . . . . . . . . . .  14  
      6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14  
      6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14  
        6.2.1.  Getting amount of available audio output drivers  . .  15  
        6.2.2.  Getting all available audio output drivers  . . . . .  15  
        6.2.3.  Getting information about a specific audio output  
                driver  . . . . . . . . . . . . . . . . . . . . . . .  15  
        6.2.4.  Getting information about specific audio output  
                driver parameter  . . . . . . . . . . . . . . . . . .  16  
        6.2.5.  Creating an audio output device . . . . . . . . . . .  20  
        6.2.6.  Destroying an audio output device . . . . . . . . . .  21  
        6.2.7.  Getting all created audio output device count . . . .  22  
        6.2.8.  Getting all created audio output device list  . . . .  22  
        6.2.9.  Getting current settings of an audio output device  .  22  
        6.2.10. Changing settings of audio output devices . . . . . .  24  
        6.2.11. Getting information about an audio channel  . . . . .  25  
        6.2.12. Getting information about specific audio channel  
                parameter . . . . . . . . . . . . . . . . . . . . . .  26  
        6.2.13. Changing settings of audio output channels  . . . . .  28  
      6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29  
        6.3.1.  Getting amount of available MIDI input drivers  . . .  30  
        6.3.2.  Getting all available MIDI input drivers  . . . . . .  30  
        6.3.3.  Getting information about a specific MIDI input  
                driver  . . . . . . . . . . . . . . . . . . . . . . .  31  
        6.3.4.  Getting information about specific MIDI input  
                driver parameter  . . . . . . . . . . . . . . . . . .  32  
        6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34  
        6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35  
        6.3.7.  Getting all created MIDI input device count . . . . .  36  
   
   
   
 Schoenebeck               Expires July 2, 2007                  [Page 2]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
        6.3.8.  Getting all created MIDI input device list  . . . . .  36  
        6.3.9.  Getting current settings of a MIDI input device . . .  37  
        6.3.10. Changing settings of MIDI input devices . . . . . . .  38  
        6.3.11. Getting information about a MIDI port . . . . . . . .  38  
        6.3.12. Getting information about specific MIDI port  
                parameter . . . . . . . . . . . . . . . . . . . . . .  39  
        6.3.13. Changing settings of MIDI input ports . . . . . . . .  41  
      6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42  
        6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42  
        6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43  
        6.4.3.  Getting all created sampler channel count . . . . . .  44  
        6.4.4.  Getting all created sampler channel list  . . . . . .  44  
        6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44  
        6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45  
        6.4.7.  Getting amount of available engines . . . . . . . . .  46  
        6.4.8.  Getting all available engines . . . . . . . . . . . .  46  
        6.4.9.  Getting information about an engine . . . . . . . . .  47  
        6.4.10. Getting sampler channel information . . . . . . . . .  48  
        6.4.11. Current number of active voices . . . . . . . . . . .  51  
        6.4.12. Current number of active disk streams . . . . . . . .  51  
        6.4.13. Current fill state of disk stream buffers . . . . . .  52  
        6.4.14. Setting audio output device . . . . . . . . . . . . .  53  
        6.4.15. Setting audio output type . . . . . . . . . . . . . .  53  
        6.4.16. Setting audio output channel  . . . . . . . . . . . .  54  
        6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  55  
        6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  56  
        6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56  
        6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57  
        6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58  
        6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58  
        6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59  
        6.4.24. Assigning a MIDI instrument map to a sampler  
                channel . . . . . . . . . . . . . . . . . . . . . . .  60  
        6.4.25. Adding an effect send to a sampler channel  . . . . .  61  
        6.4.26. Removing an effect send from a sampler channel  . . .  62  
        6.4.27. Getting amount of effect sends on a sampler channel .  63  
        6.4.28. Listing all effect sends on a sampler channel . . . .  63  
        6.4.29. Getting effect send information . . . . . . . . . . .  64  
        6.4.30. Altering effect send's audio routing  . . . . . . . .  65  
        6.4.31. Resetting a sampler channel . . . . . . . . . . . . .  66  
      6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  66  
        6.5.1.  Register front-end for receiving event messages . . .  66  
        6.5.2.  Unregister front-end for not receiving event  
                messages  . . . . . . . . . . . . . . . . . . . . . .  67  
        6.5.3.  Enable or disable echo of commands  . . . . . . . . .  68  
        6.5.4.  Close client connection . . . . . . . . . . . . . . .  68  
      6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  69  
        6.6.1.  Current number of active voices . . . . . . . . . . .  69  
   
   
   
 Schoenebeck               Expires July 2, 2007                  [Page 3]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
        6.6.2.  Maximum amount of active voices . . . . . . . . . . .  69  
        6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  69  
        6.6.4.  General sampler informations  . . . . . . . . . . . .  70  
        6.6.5.  Getting global volume attenuation . . . . . . . . . .  70  
        6.6.6.  Setting global volume attenuation . . . . . . . . . .  71  
      6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  71  
        6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  72  
        6.7.2.  Delete one particular or all MIDI instrument maps . .  73  
        6.7.3.  Get amount of existing MIDI instrument maps . . . . .  73  
        6.7.4.  Getting all created MIDI instrument maps  . . . . . .  74  
        6.7.5.  Getting MIDI instrument map information . . . . . . .  74  
        6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  75  
        6.7.7.  Create or replace a MIDI instrument map entry . . . .  75  
        6.7.8.  Getting ammount of MIDI instrument map entries  . . .  78  
        6.7.9.  Getting indeces of all entries of a MIDI  
                instrument map  . . . . . . . . . . . . . . . . . . .  79  
        6.7.10. Remove an entry from the MIDI instrument map  . . . .  79  
        6.7.11. Get current settings of MIDI instrument map entry . .  80  
        6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  82  
    7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  83  
    8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  94  
      8.1.  Number of audio output devices changed  . . . . . . . . .  94  
      8.2.  Audio output device's settings changed  . . . . . . . . .  94  
      8.3.  Number of MIDI input devices changed  . . . . . . . . . .  94  
      8.4.  MIDI input device's settings changed  . . . . . . . . . .  95  
      8.5.  Number of sampler channels changed  . . . . . . . . . . .  95  
      8.6.  Number of active voices changed . . . . . . . . . . . . .  95  
      8.7.  Number of active disk streams changed . . . . . . . . . .  96  
      8.8.  Disk stream buffer fill state changed . . . . . . . . . .  96  
      8.9.  Channel information changed . . . . . . . . . . . . . . .  96  
      8.10. Total number of active voices changed . . . . . . . . . .  97  
      8.11. Number of MIDI instrument maps changed  . . . . . . . . .  97  
      8.12. MIDI instrument map information changed . . . . . . . . .  97  
      8.13. Number of MIDI instruments changed  . . . . . . . . . . .  98  
      8.14. MIDI instrument information changed . . . . . . . . . . .  98  
      8.15. Miscellaneous and debugging events  . . . . . . . . . . .  99  
    9.  Security Considerations . . . . . . . . . . . . . . . . . . . 100  
    10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 101  
    11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 102  
    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 103  
    Intellectual Property and Copyright Statements  . . . . . . . . . 104  
315    
316    
317    
# Line 220  Internet-Draft        LinuxSampler Contr Line 322  Internet-Draft        LinuxSampler Contr
322    
323    
324    
325  Schoenebeck               Expires July 2, 2007                  [Page 4]  
326    
327    
328    
329    
330    
331    
332    
333    
334    
335    Schoenebeck               Expires July 13, 2014                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
338    
339    
340  1.  Requirements notation  1.  Requirements notation
# Line 238  Internet-Draft        LinuxSampler Contr Line 350  Internet-Draft        LinuxSampler Contr
350     end) and server (LinuxSampler) respectively.  Lines in examples must     end) and server (LinuxSampler) respectively.  Lines in examples must
351     be interpreted as every line being CRLF terminated (carriage return     be interpreted as every line being CRLF terminated (carriage return
352     character followed by line feed character as defined in the ASCII     character followed by line feed character as defined in the ASCII
353     standard), thus the following example:     standard [RFC20]), thus the following example:
354    
355        C: "some line"        C: "some line"
356    
# Line 276  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires July 2, 2007                  [Page 5]  Schoenebeck               Expires July 13, 2014                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
394    
395    
396  2.  Versioning of this specification  2.  Versioning of this specification
# Line 307  Internet-Draft        LinuxSampler Contr Line 419  Internet-Draft        LinuxSampler Contr
419         sampler's LSCP minor version.         sampler's LSCP minor version.
420    
421     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
422     frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get     frontend can use the "GET SERVER INFO" (Section 6.6.5) command to get
423     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
424    
425    
# Line 332  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires July 2, 2007                  [Page 6]  Schoenebeck               Expires July 13, 2014                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
450    
451    
452  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires July 2, 2007                  [Page 7]  Schoenebeck               Expires July 13, 2014                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
506    
507    
508  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires July 2, 2007                  [Page 8]  Schoenebeck               Expires July 13, 2014                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
562    
563    
564  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires July 2, 2007                  [Page 9]  Schoenebeck               Expires July 13, 2014                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
618    
619    
620  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires July 2, 2007                 [Page 10]  Schoenebeck               Expires July 13, 2014                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
674    
675    
676     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires July 2, 2007                 [Page 11]  Schoenebeck               Expires July 13, 2014                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
730    
731    
732     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck               Expires July 2, 2007                 [Page 12]  Schoenebeck               Expires July 13, 2014                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
786    
787    
788         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 724  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck               Expires July 2, 2007                 [Page 13]  Schoenebeck               Expires July 13, 2014                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
842    
843    
844  6.  Description for control commands  6.  Description for control commands
# Line 780  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires July 2, 2007                 [Page 14]  Schoenebeck               Expires July 13, 2014                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
898    
899    
900  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 836  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires July 2, 2007                 [Page 15]  Schoenebeck               Expires July 13, 2014                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
954    
955    
956        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 892  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires July 2, 2007                 [Page 16]  Schoenebeck               Expires July 13, 2014                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1010    
1011    
1012     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 948  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires July 2, 2007                 [Page 17]  Schoenebeck               Expires July 13, 2014                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1066    
1067    
1068        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires July 2, 2007                 [Page 18]  Schoenebeck               Expires July 13, 2014                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1122    
1123    
1124           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires July 2, 2007                 [Page 19]  Schoenebeck               Expires July 13, 2014                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1178    
1179    
1180           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires July 2, 2007                 [Page 20]  Schoenebeck               Expires July 13, 2014                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1234    
1235    
1236           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires July 2, 2007                 [Page 21]  Schoenebeck               Expires July 13, 2014                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1290    
1291    
1292        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck               Expires July 2, 2007                 [Page 22]  Schoenebeck               Expires July 13, 2014                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1346    
1347    
1348     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck               Expires July 2, 2007                 [Page 23]  Schoenebeck               Expires July 13, 2014                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1402    
1403    
1404           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck               Expires July 2, 2007                 [Page 24]  Schoenebeck               Expires July 13, 2014                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1458    
1459    
1460  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck               Expires July 2, 2007                 [Page 25]  Schoenebeck               Expires July 13, 2014                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1514    
1515    
1516     Examples:     Examples:
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires July 2, 2007                 [Page 26]  Schoenebeck               Expires July 13, 2014                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1570    
1571    
1572     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires July 2, 2007                 [Page 27]  Schoenebeck               Expires July 13, 2014                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1626    
1627    
1628           RANGE_MAX -           RANGE_MAX -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck               Expires July 2, 2007                 [Page 28]  Schoenebeck               Expires July 13, 2014                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1682    
1683    
1684        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck               Expires July 2, 2007                 [Page 29]  Schoenebeck               Expires July 13, 2014                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1738    
1739    
1740     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck               Expires July 2, 2007                 [Page 30]  Schoenebeck               Expires July 13, 2014                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1794    
1795    
1796  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck               Expires July 2, 2007                 [Page 31]  Schoenebeck               Expires July 13, 2014                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1850    
1851    
1852  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck               Expires July 2, 2007                 [Page 32]  Schoenebeck               Expires July 13, 2014                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1906    
1907    
1908        FIX -        FIX -
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck               Expires July 2, 2007                 [Page 33]  Schoenebeck               Expires July 13, 2014                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
1962    
1963    
1964           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1900  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck               Expires July 2, 2007                 [Page 34]  Schoenebeck               Expires July 13, 2014                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2018    
2019    
2020        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 1956  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck               Expires July 2, 2007                 [Page 35]  Schoenebeck               Expires July 13, 2014                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2074    
2075    
2076           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck               Expires July 2, 2007                 [Page 36]  Schoenebeck               Expires July 13, 2014                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2130    
2131    
2132  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck               Expires July 2, 2007                 [Page 37]  Schoenebeck               Expires July 13, 2014                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2186    
2187    
2188           "ACTIVE: true"           "ACTIVE: true"
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck               Expires July 2, 2007                 [Page 38]  Schoenebeck               Expires July 13, 2014                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2242    
2243    
2244     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck               Expires July 2, 2007                 [Page 39]  Schoenebeck               Expires July 13, 2014                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2298    
2299    
2300        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck               Expires July 2, 2007                 [Page 40]  Schoenebeck               Expires July 13, 2014                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2354    
2355    
2356           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2272  Internet-Draft        LinuxSampler Contr Line 2384  Internet-Draft        LinuxSampler Contr
2384     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2385     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2386     MIDI port number, <key> by the name of the parameter to change and     MIDI port number, <key> by the name of the parameter to change and
2387     <value> by the new value for this parameter.     <value> by the new value for this parameter (encapsulated into
2388       apostrophes) or NONE (not encapsulated into apostrophes) for
2389       specifying no value for parameters allowing a list of values.
2390    
2391     Possible Answers:     Possible Answers:
2392    
# Line 2286  Internet-Draft        LinuxSampler Contr Line 2400  Internet-Draft        LinuxSampler Contr
2400           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2401           code and warning message           code and warning message
2402    
       "ERR:<error-code>:<error-message>" -  
2403    
2404    
2405    
2406    
2407    Schoenebeck               Expires July 13, 2014                [Page 43]
 Schoenebeck               Expires July 2, 2007                 [Page 41]  
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2410    
2411    
2412          "ERR:<error-code>:<error-message>" -
2413    
2414           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2415           error message           error message
2416    
2417     Example:     Example:
2418    
2419          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2420    
2421          S: "OK"
2422    
2423          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2424    
2425          S: "OK"
2426    
2427  6.4.  Configuring sampler channels  6.4.  Configuring sampler channels
2428    
# Line 2324  Internet-Draft        LinuxSampler Contr Line 2444  Internet-Draft        LinuxSampler Contr
2444     of the sampler channel the instrument should be assigned to.  Each     of the sampler channel the instrument should be assigned to.  Each
2445     sampler channel can only have one instrument.     sampler channel can only have one instrument.
2446    
2447       Notice: since LSCP 1.2 the <filename> argument supports escape
2448       characters for special characters (see chapter "Character Set and
2449       Escape Sequences (Section 7.1)" for details) and accordingly
2450       backslash characters in the filename MUST now be escaped as well!
2451    
2452     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
2453     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2454     been fully loaded and the channel is ready to be used while NON_MODAL     been fully loaded and the channel is ready to be used while NON_MODAL
# Line 2332  Internet-Draft        LinuxSampler Contr Line 2457  Internet-Draft        LinuxSampler Contr
2457     (Section 6.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2458     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2459     such as making sure that the file could be read and it is of a proper     such as making sure that the file could be read and it is of a proper
2460    
2461    
2462    
2463    Schoenebeck               Expires July 13, 2014                [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol         January 2014
2466    
2467    
2468     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
2469     process should any errors be detected at that point.     process should any errors be detected at that point.
2470    
# Line 2345  Internet-Draft        LinuxSampler Contr Line 2478  Internet-Draft        LinuxSampler Contr
2478    
2479           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2480           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 42]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2481           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
2482           file), providing an appropriate warning code and warning           file), providing an appropriate warning code and warning
2483           message           message
# Line 2362  Internet-Draft        LinuxSampler Contr Line 2487  Internet-Draft        LinuxSampler Contr
2487           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2488           error message           error message
2489    
2490     Example:     Example (Unix):
2491    
2492          C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
2493    
2494          S: OK
2495    
2496       Example (Windows):
2497    
2498          C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
2499    
2500          S: OK
2501    
2502  6.4.2.  Loading a sampler engine  6.4.2.  Loading a sampler engine
2503    
# Line 2380  Internet-Draft        LinuxSampler Contr Line 2513  Internet-Draft        LinuxSampler Contr
2513     be assigned to.  This command should be issued after adding a new     be assigned to.  This command should be issued after adding a new
2514     sampler channel and before any other control commands on the new     sampler channel and before any other control commands on the new
2515     sampler channel.  It can also be used to change the engine type of a     sampler channel.  It can also be used to change the engine type of a
2516    
2517    
2518    
2519    Schoenebeck               Expires July 13, 2014                [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol         January 2014
2522    
2523    
2524     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
2525     force if a new engine instance should be created and assigned to the     force if a new engine instance should be created and assigned to the
2526     given sampler channel or if an already existing instance of that     given sampler channel or if an already existing instance of that
# Line 2402  Internet-Draft        LinuxSampler Contr Line 2543  Internet-Draft        LinuxSampler Contr
2543           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2544           error message           error message
2545    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 43]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2546     Example:     Example:
2547    
2548    
# Line 2432  Internet-Draft        LinuxSampler Contr Line 2566  Internet-Draft        LinuxSampler Contr
2566    
2567        S: "12"        S: "12"
2568    
2569    
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck               Expires July 13, 2014                [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol         January 2014
2578    
2579    
2580  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2581    
2582     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
# Line 2456  Internet-Draft        LinuxSampler Contr Line 2601  Internet-Draft        LinuxSampler Contr
2601     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2602     list by sending the following command:     list by sending the following command:
2603    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 44]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2604        ADD CHANNEL        ADD CHANNEL
2605    
2606     This will increment the sampler channel count by one and the new     This will increment the sampler channel count by one and the new
# Line 2488  Internet-Draft        LinuxSampler Contr Line 2624  Internet-Draft        LinuxSampler Contr
2624    
2625        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck               Expires July 13, 2014                [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol         January 2014
2634    
2635    
2636           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2637           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2638           code and warning message           code and warning message
# Line 2514  Internet-Draft        LinuxSampler Contr Line 2659  Internet-Draft        LinuxSampler Contr
2659    
2660     Possible Answers:     Possible Answers:
2661    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2662        "OK" -        "OK" -
2663    
2664           in case the given sampler channel could be removed           in case the given sampler channel could be removed
# Line 2540  Internet-Draft        LinuxSampler Contr Line 2678  Internet-Draft        LinuxSampler Contr
2678    
2679    
2680    
2681    
2682    
2683    
2684    
2685    
2686    
2687    Schoenebeck               Expires July 13, 2014                [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol         January 2014
2690    
2691    
2692  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
2693    
2694     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
# Line 2567  Internet-Draft        LinuxSampler Contr Line 2716  Internet-Draft        LinuxSampler Contr
2716    
2717     Possible Answers:     Possible Answers:
2718    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
2719        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
2720        engines' names encapsulated into apostrophes (').  Engine names        engines' names encapsulated into apostrophes (').  Engine names
2721        can consist of lower and upper cases, digits and underlines ("_"        can consist of lower and upper cases, digits and underlines ("_"
# Line 2586  Internet-Draft        LinuxSampler Contr Line 2725  Internet-Draft        LinuxSampler Contr
2725    
2726        C: "LIST AVAILABLE_ENGINES"        C: "LIST AVAILABLE_ENGINES"
2727    
2728        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"        S: "'gig','sfz','sf2'"
2729    
2730  6.4.9.  Getting information about an engine  6.4.9.  Getting information about an engine
2731    
# Line 2598  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
2737     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2738     AVAILABLE_ENGINES" (Section 6.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2739    
2740    
2741    
2742    
2743    Schoenebeck               Expires July 13, 2014                [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol         January 2014
2746    
2747    
2748     Possible Answers:     Possible Answers:
2749    
2750        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 2610  Internet-Draft        LinuxSampler Contr Line 2757  Internet-Draft        LinuxSampler Contr
2757    
2758           DESCRIPTION -           DESCRIPTION -
2759    
2760              arbitrary description text about the engine              arbitrary description text about the engine (note that the
2761                character string may contain escape sequences (Section 7.1))
2762    
2763           VERSION -           VERSION -
2764    
# Line 2618  Internet-Draft        LinuxSampler Contr Line 2766  Internet-Draft        LinuxSampler Contr
2766    
2767     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2768    
2769     Example:     Examples:
2770    
2771        C: "GET ENGINE INFO JoesCustomEngine"        C: "GET ENGINE INFO gig"
2772    
2773        S: "DESCRIPTION: this is Joe's custom sampler engine"        S: "DESCRIPTION: GigaSampler Format Engine"
2774    
2775             "VERSION: 1.110"
2776    
2777             "."
2778    
2779          C: "GET ENGINE INFO sf2"
2780    
2781          S: "DESCRIPTION: SoundFont Format Engine"
2782    
2783  Schoenebeck               Expires July 2, 2007                 [Page 47]           "VERSION: 1.4"
2784    
2785  Internet-Draft        LinuxSampler Control Protocol        December 2006           "."
2786    
2787          C: "GET ENGINE INFO sfz"
2788    
2789           "VERSION: testing-1.0"        S: "DESCRIPTION: SFZ Format Engine"
2790    
2791             "VERSION: 1.11"
2792    
2793           "."           "."
2794    
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires July 13, 2014                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol         January 2014
2802    
2803    
2804  6.4.10.  Getting sampler channel information  6.4.10.  Getting sampler channel information
2805    
2806     The front-end can ask for the current settings of a sampler channel     The front-end can ask for the current settings of a sampler channel
# Line 2668  Internet-Draft        LinuxSampler Contr Line 2832  Internet-Draft        LinuxSampler Contr
2832    
2833              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2834              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2835              signal, "NONE" if there's no device connected to this              signal, "-1" if there's no device connected to this sampler
2836              sampler channel              channel
2837    
2838           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2839    
# Line 2681  Internet-Draft        LinuxSampler Contr Line 2845  Internet-Draft        LinuxSampler Contr
2845              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
2846              of the selected audio output device each sampler output              of the selected audio output device each sampler output
2847              channel is routed to, e.g. "0,3" would mean the engine's              channel is routed to, e.g. "0,3" would mean the engine's
2848                output channel 0 is routed to channel 0 of the audio output
2849                device and the engine's output channel 1 is routed to the
2850                channel 3 of the audio output device
2851    
2852    
2853    
 Schoenebeck               Expires July 2, 2007                 [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
2854    
2855    Schoenebeck               Expires July 13, 2014                [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol         January 2014
2858    
             output channel 0 is routed to channel 0 of the audio output  
             device and the engine's output channel 1 is routed to the  
             channel 3 of the audio output device  
2859    
2860           INSTRUMENT_FILE -           INSTRUMENT_FILE -
2861    
2862              the file name of the loaded instrument, "NONE" if there's no              the file name of the loaded instrument, "NONE" if there's no
2863              instrument yet loaded for this sampler channel              instrument yet loaded for this sampler channel (note: since
2864                LSCP 1.2 this path may contain escape sequences
2865                (Section 7.1))
2866    
2867           INSTRUMENT_NR -           INSTRUMENT_NR -
2868    
2869              the instrument index number of the loaded instrument              the instrument index number of the loaded instrument, "-1"
2870                if there's no instrument loaded for this sampler channel
2871    
2872           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2873    
2874              the instrument name of the loaded instrument              the instrument name of the loaded instrument (note: since
2875                LSCP 1.2 this character string may contain escape sequences
2876                (Section 7.1))
2877    
2878           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2879    
2880              integer values 0 to 100 indicating loading progress              Integer values 0 to 100 indicating loading progress
2881              percentage for the instrument.  Negative value indicates a              percentage for the instrument.  Negative value indicates a
2882              loading exception.  Value of 100 indicates that the              loading exception (also returns "-1" in case no instrument
2883              instrument is fully loaded.              was yet to be loaded on the sampler channel).  Value of 100
2884                indicates that the instrument is fully loaded.
2885    
2886           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2887    
2888              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
2889              connected to this sampler channel to deliver MIDI input              connected to this sampler channel to deliver MIDI input
2890              commands, "NONE" if there's no device connected to this              commands, "-1" if there's no device connected to this
2891              sampler channel              sampler channel
2892    
2893           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2894    
2895              port number of the MIDI input device              port number of the MIDI input device (in case a MIDI device
2896                was already assigned to the sampler channel)
2897    
2898           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2899    
# Line 2737  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911    Schoenebeck               Expires July 13, 2014                [Page 52]
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 49]  
2912    
2913  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2914    
2915    
2916           MUTE -           MUTE -
# Line 2762  Internet-Draft        LinuxSampler Contr Line 2930  Internet-Draft        LinuxSampler Contr
2930    
2931              Determines to which MIDI instrument map this sampler channel              Determines to which MIDI instrument map this sampler channel
2932              is assigned to.  Read chapter "SET CHANNEL              is assigned to.  Read chapter "SET CHANNEL
2933              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.27) for a list of possible
2934              values.              values.
2935    
2936     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 2771  Internet-Draft        LinuxSampler Contr Line 2939  Internet-Draft        LinuxSampler Contr
2939    
2940        C: "GET CHANNEL INFO 34"        C: "GET CHANNEL INFO 34"
2941    
2942        S: "ENGINE_NAME: GigEngine"        S: "ENGINE_NAME: gig"
2943    
2944           "VOLUME: 1.0"           "VOLUME: 1.0"
2945    
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck               Expires July 2, 2007                 [Page 50]  Schoenebeck               Expires July 13, 2014                [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
2970    
2971    
2972           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
# Line 2852  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck               Expires July 2, 2007                 [Page 51]  Schoenebeck               Expires July 13, 2014                [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
3026    
3027    
3028        return "NA" for not available.        return "NA" for not available.
# Line 2908  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck               Expires July 2, 2007                 [Page 52]  Schoenebeck               Expires July 13, 2014                [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
3082    
3083    
3084        S: ""        S: ""
# Line 2953  Internet-Draft        LinuxSampler Contr Line 3121  Internet-Draft        LinuxSampler Contr
3121    
3122  6.4.15.  Setting audio output type  6.4.15.  Setting audio output type
3123    
3124     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR!
3125    
3126     The front-end can alter the audio output type on a specific sampler     The front-end can alter the audio output type on a specific sampler
3127     channel by sending the following command:     channel by sending the following command:
# Line 2964  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck               Expires July 2, 2007                 [Page 53]  Schoenebeck               Expires July 13, 2014                [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
3138    
3139    
3140     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
# Line 2993  Internet-Draft        LinuxSampler Contr Line 3161  Internet-Draft        LinuxSampler Contr
3161    
3162    
3163    
3164       Deprecated:
3165    
3166          Should not be used anymore.  This command is currently only
3167          preserved for backward compatibility.
3168    
3169          This command is a relict from times where there was no
3170          sophisticated driver management yet.  Use "CREATE
3171          AUDIO_OUTPUT_DEVICE" (Section 6.2.5) and "SET CHANNEL
3172          AUDIO_OUTPUT_DEVICE" (Section 6.4.14) instead.
3173    
3174  6.4.16.  Setting audio output channel  6.4.16.  Setting audio output channel
3175    
3176     The front-end can alter the audio output channel on a specific     The front-end can alter the audio output channel on a specific
# Line 3008  Internet-Draft        LinuxSampler Contr Line 3186  Internet-Draft        LinuxSampler Contr
3186     numerical ID of the audio channel of the selected audio output device     numerical ID of the audio channel of the selected audio output device
3187     where <audio-out> should be routed to.     where <audio-out> should be routed to.
3188    
3189    
3190    
3191    Schoenebeck               Expires July 13, 2014                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol         January 2014
3194    
3195    
3196       Possible Answers:
3197    
3198          "OK" -
3199    
3200             on success
3201    
3202          "WRN:<warning-code>:<warning-message>" -
3203    
3204             if audio output channel was set, but there are noteworthy
3205             issue(s) related, providing an appropriate warning code and
3206             warning message
3207    
3208          "ERR:<error-code>:<error-message>" -
3209    
3210             in case it failed, providing an appropriate error code and
3211             error message
3212    
3213       Examples:
3214    
3215    
3216    
3217    6.4.17.  Add MIDI input to sampler channel
3218    
3219       The front-end can add a MIDI input on a specific sampler channel by
3220       sending the following command:
3221    
3222          ADD CHANNEL MIDI_INPUT <sampler-channel> <midi-device-id> [<midi-
3223          input-port>]
3224    
3225       Where <sampler-channel> is the sampler channel number as returned by
3226       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3227       command and <midi-device-id> is the numerical ID of the MIDI input
3228       device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3229       or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, and <midi-
3230       input-port> is an optional MIDI input port number of that MIDI input
3231       device.  If <midi-input-port> is omitted, then the MIDI input
3232       device's first port (port number 0) is used.
3233    
3234     Possible Answers:     Possible Answers:
3235    
3236        "OK" -        "OK" -
# Line 3016  Internet-Draft        LinuxSampler Contr Line 3239  Internet-Draft        LinuxSampler Contr
3239    
3240        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3241    
3242             if MIDI input port was connected, but there are noteworthy
3243             issue(s) related, providing an appropriate warning code and
3244    
3245    
3246    
3247    Schoenebeck               Expires July 13, 2014                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol         January 2014
3250    
3251    
3252             warning message
3253    
3254          "ERR:<error-code>:<error-message>" -
3255    
3256             in case it failed, providing an appropriate error code and
3257             error message
3258    
3259       Examples:
3260    
3261          C: "ADD CHANNEL MIDI_INPUT 0 0"
3262    
3263          S: "OK"
3264    
3265          C: "ADD CHANNEL MIDI_INPUT 1 0"
3266    
3267          S: "OK"
3268    
3269          C: "ADD CHANNEL MIDI_INPUT 1 1 1"
3270    
3271          S: "OK"
3272    
3273          C: "ADD CHANNEL MIDI_INPUT 1 2 0"
3274    
3275          S: "OK"
3276    
3277       Since:
3278    
3279  Schoenebeck               Expires July 2, 2007                 [Page 54]        Introduced with LSCP v1.6
3280    
3281    6.4.18.  Remove MIDI input(s) from sampler channel
3282    
3283       The front-end can remove one ore more MIDI input(s) on a specific
3284       sampler channel by sending the following command:
3285    
3286          REMOVE CHANNEL MIDI_INPUT <sampler-channel> [<midi-device-id>
3287          [<midi-input-port>]]
3288    
3289       Where <sampler-channel> is the sampler channel number as returned by
3290       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3291       command and <midi-device-id> and <midi-input-port> are optional
3292       numerical IDs defining the MIDI input device and one of its MIDI
3293       ports as returned by the "LIST CHANNEL MIDI_INPUTS" (Section 6.4.19)
3294       command.
3295    
3296       If <midi-input-port> is omitted, then all MIDI input ports of <midi-
3297       device-id> are disconnected from this sampler channel.
3298    
3299       If both, <midi-device-id> and <midi-input-port> are omitted, then all
3300    
3301    
3302    
3303    Schoenebeck               Expires July 13, 2014                [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
3306    
3307    
3308           if audio output channel was set, but there are noteworthy     MIDI input ports currently connected to this sampler channel are
3309       disconnected from this sampler channel.
3310    
3311       Possible Answers:
3312    
3313          "OK" -
3314    
3315             on success
3316    
3317          "WRN:<warning-code>:<warning-message>" -
3318    
3319             if MIDI input porst were disconnected, but there are noteworthy
3320           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3321           warning message           warning message
3322    
# Line 3036  Internet-Draft        LinuxSampler Contr Line 3327  Internet-Draft        LinuxSampler Contr
3327    
3328     Examples:     Examples:
3329    
3330          C: "REMOVE CHANNEL MIDI_INPUT 0"
3331    
3332          S: "OK"
3333    
3334          C: "REMOVE CHANNEL MIDI_INPUT 1"
3335    
3336          S: "OK"
3337    
3338          C: "REMOVE CHANNEL MIDI_INPUT 1 2 0"
3339    
3340          S: "OK"
3341    
3342       Since:
3343    
3344          Introduced with LSCP v1.6
3345    
3346    6.4.19.  Getting all MIDI inputs of a sampler channel
3347    
3348       The front-end can query a list of all currently connected MIDI inputs
3349       of a certain sampler channel by sending the following command:
3350    
3351          LIST CHANNEL MIDI_INPUTS <sampler-channel>
3352    
3353       Where <sampler-channel> is the sampler channel number as returned by
3354       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3355       command.
3356    
3357  6.4.17.  Setting MIDI input device  
3358    
3359    Schoenebeck               Expires July 13, 2014                [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol         January 2014
3362    
3363    
3364       Possible Answers:
3365    
3366          The sampler will answer by sending a comma separated list of MIDI
3367          input device ID - MIDI input port number pairs, where each pair is
3368          encapsulated into curly braces.  The list is returned in one
3369          single line.  The MIDI input device ID corresponds to the number
3370          returned by "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) and the port
3371          number is the index of the respective MIDI port of that MIDI input
3372          device.
3373    
3374       Example:
3375    
3376          C: "LIST CHANNEL MIDI_INPUTS 0"
3377    
3378          S: "{0,0},{1,3},{2,0}"
3379    
3380       Since:
3381    
3382          Introduced with LSCP v1.6
3383    
3384    6.4.20.  Setting MIDI input device
3385    
3386       DEPRECATED: THIS COMMAND WILL DISAPPEAR!
3387    
3388     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
3389     channel by sending the following command:     channel by sending the following command:
# Line 3051  Internet-Draft        LinuxSampler Contr Line 3396  Internet-Draft        LinuxSampler Contr
3396     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3397     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3398    
3399       If more than 1 MIDI inputs are currently connected to this sampler
3400       channel: Sending this command will disconnect ALL currently connected
3401       MIDI input ports connected to this sampler channel before
3402       establishing the new MIDI input connection.  So this command does NOT
3403       add the connection, it replaces all existing ones instead.  This
3404       behavior is due to preserving full behavior backward compatibility.
3405    
3406     Possible Answers:     Possible Answers:
3407    
3408        "OK" -        "OK" -
3409    
3410           on success           on success
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires July 13, 2014                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol         January 2014
3418    
3419    
3420        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3421    
3422           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
# Line 3072  Internet-Draft        LinuxSampler Contr Line 3432  Internet-Draft        LinuxSampler Contr
3432    
3433    
3434    
3435       Deprecated:
3436    
3437          Should not be used anymore as of LSCP v1.6 and younger.  This
3438          command is currently only preserved for backward compatibility.
3439    
3440          This command is a relict from times where only one MIDI input per
3441          sampler channel was allowed.  Use "ADD CHANNEL MIDI_INPUT"
3442          (Section 6.4.17) and "REMOVE CHANNEL MIDI_INPUT" (Section 6.4.18)
3443          instead.
3444    
3445    6.4.21.  Setting MIDI input type
3446    
3447  Schoenebeck               Expires July 2, 2007                 [Page 55]     DEPRECATED: THIS COMMAND WILL DISAPPEAR!
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
 6.4.18.  Setting MIDI input type  
   
    DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!  
3448    
3449     The front-end can alter the MIDI input type on a specific sampler     The front-end can alter the MIDI input type on a specific sampler
3450     channel by sending the following command:     channel by sending the following command:
# Line 3093  Internet-Draft        LinuxSampler Contr Line 3454  Internet-Draft        LinuxSampler Contr
3454     Where <midi-input-type> is currently only "ALSA" and <sampler-     Where <midi-input-type> is currently only "ALSA" and <sampler-
3455     channel> is the respective sampler channel number.     channel> is the respective sampler channel number.
3456    
3457       If more than 1 MIDI inputs are currently connected to this sampler
3458       channel: Sending this command will disconnect ALL currently connected
3459       MIDI input ports connected to this sampler channel before
3460       establishing the new MIDI input connection.  So this command does NOT
3461       add the connection, it replaces all existing ones instead.  This
3462       behavior is due to preserving full behavior backward compatibility.
3463    
3464     Possible Answers:     Possible Answers:
3465    
3466    
3467    
3468    
3469    
3470    
3471    Schoenebeck               Expires July 13, 2014                [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol         January 2014
3474    
3475    
3476        "OK" -        "OK" -
3477    
3478           on success           on success
# Line 3114  Internet-Draft        LinuxSampler Contr Line 3492  Internet-Draft        LinuxSampler Contr
3492    
3493    
3494    
3495  6.4.19.  Setting MIDI input port     Deprecated:
3496    
3497          Should not be used anymore.  This command is currently only
3498          preserved for backward compatibility.
3499    
3500          This command is a relict from times where only 1 MIDI input per
3501          sampler channels was allowed and where no sophisticated driver
3502          management existed yet.  Use "ADD CHANNEL MIDI_INPUT"
3503          (Section 6.4.17) and "REMOVE CHANNEL MIDI_INPUT" (Section 6.4.18)
3504          instead.
3505    
3506    6.4.22.  Setting MIDI input port
3507    
3508       DEPRECATED: THIS COMMAND WILL DISAPPEAR!
3509    
3510     The front-end can alter the MIDI input port on a specific sampler     The front-end can alter the MIDI input port on a specific sampler
3511     channel by sending the following command:     channel by sending the following command:
# Line 3124  Internet-Draft        LinuxSampler Contr Line 3515  Internet-Draft        LinuxSampler Contr
3515     Where <midi-input-port> is a MIDI input port number of the MIDI input     Where <midi-input-port> is a MIDI input port number of the MIDI input
3516     device connected to the sampler channel given by <sampler-channel>.     device connected to the sampler channel given by <sampler-channel>.
3517    
3518     Possible Answers:     If more than 1 MIDI inputs are currently connected to this sampler
3519       channel: Sending this command will switch the connection of the first
3520       (and only the first) MIDI input port currently being connected to
3521       this sampler channel, to another port of the same MIDI input device.
3522       Or in other words: the first MIDI input port currently connected to
3523       this sampler channel will be disconnected, and the requested other
3524    
       "OK" -  
3525    
3526    
3527    Schoenebeck               Expires July 13, 2014                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol         January 2014
3530    
3531    
3532       port of its MIDI input device will be connected to this sampler
3533       channel instead.  This behavior is due to preserving full behavior
3534       backward compatibility.
3535    
3536  Schoenebeck               Expires July 2, 2007                 [Page 56]     Possible Answers:
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
3537    
3538          "OK" -
3539    
3540           on success           on success
3541    
# Line 3154  Internet-Draft        LinuxSampler Contr Line 3554  Internet-Draft        LinuxSampler Contr
3554    
3555    
3556    
3557  6.4.20.  Setting MIDI input channel     Deprecated:
3558    
3559          Should not be used anymore.  This command is currently only
3560          preserved for backward compatibility.
3561    
3562          This command is a relict from times where only one MIDI input per
3563          sampler channel was allowed.  Use "ADD CHANNEL MIDI_INPUT"
3564          (Section 6.4.17) and "REMOVE CHANNEL MIDI_INPUT" (Section 6.4.18)
3565          instead.
3566    
3567    6.4.23.  Setting MIDI input channel
3568    
3569     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3570     listen to by sending the following command:     listen to by sending the following command:
# Line 3162  Internet-Draft        LinuxSampler Contr Line 3572  Internet-Draft        LinuxSampler Contr
3572        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3573    
3574     Where <midi-input-chan> is the number of the new MIDI input channel     Where <midi-input-chan> is the number of the new MIDI input channel
3575     where <sampler-channel> should listen to or "ALL" to listen on all 16     (zero indexed!) where <sampler-channel> should listen to, or "ALL" to
3576     MIDI channels.     listen on all 16 MIDI channels.
3577    
3578     Possible Answers:     Possible Answers:
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires July 13, 2014                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol         January 2014
3586    
3587    
3588        "OK" -        "OK" -
3589    
3590           on success           on success
# Line 3184  Internet-Draft        LinuxSampler Contr Line 3602  Internet-Draft        LinuxSampler Contr
3602    
3603     Examples:     Examples:
3604    
3605          C: "SET CHANNEL MIDI_INPUT_CHANNEL 0 0"
3606    
3607          S: "OK"
3608    
3609          C: "SET CHANNEL MIDI_INPUT_CHANNEL 1 ALL"
3610    
3611          S: "OK"
3612    
3613  Schoenebeck               Expires July 2, 2007                 [Page 57]  6.4.24.  Setting channel volume
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
   
   
 6.4.21.  Setting channel volume  
3614    
3615     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
3616     the following command:     the following command:
# Line 3219  Internet-Draft        LinuxSampler Contr Line 3634  Internet-Draft        LinuxSampler Contr
3634           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3635           message           message
3636    
3637    
3638    
3639    Schoenebeck               Expires July 13, 2014                [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol         January 2014
3642    
3643    
3644        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3645    
3646           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3228  Internet-Draft        LinuxSampler Contr Line 3650  Internet-Draft        LinuxSampler Contr
3650    
3651    
3652    
3653  6.4.22.  Muting a sampler channel  6.4.25.  Muting a sampler channel
3654    
3655     The front-end can mute/unmute a specific sampler channel by sending     The front-end can mute/unmute a specific sampler channel by sending
3656     the following command:     the following command:
# Line 3242  Internet-Draft        LinuxSampler Contr Line 3664  Internet-Draft        LinuxSampler Contr
3664    
3665     Possible Answers:     Possible Answers:
3666    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 58]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3667        "OK" -        "OK" -
3668    
3669           on success           on success
# Line 3268  Internet-Draft        LinuxSampler Contr Line 3683  Internet-Draft        LinuxSampler Contr
3683    
3684    
3685    
3686  6.4.23.  Soloing a sampler channel  6.4.26.  Soloing a sampler channel
3687    
3688     The front-end can solo/unsolo a specific sampler channel by sending     The front-end can solo/unsolo a specific sampler channel by sending
3689     the following command:     the following command:
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires July 13, 2014                [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol         January 2014
3698    
3699    
3700        SET CHANNEL SOLO <sampler-channel> <solo>        SET CHANNEL SOLO <sampler-channel> <solo>
3701    
3702     Where <sampler-channel> is the respective sampler channel number as     Where <sampler-channel> is the respective sampler channel number as
# Line 3297  Internet-Draft        LinuxSampler Contr Line 3721  Internet-Draft        LinuxSampler Contr
3721           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3722           error message           error message
3723    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3724     Examples:     Examples:
3725    
3726    
3727    
3728  6.4.24.  Assigning a MIDI instrument map to a sampler channel  6.4.27.  Assigning a MIDI instrument map to a sampler channel
3729    
3730     The front-end can assign a MIDI instrument map to a specific sampler     The front-end can assign a MIDI instrument map to a specific sampler
3731     channel by sending the following command:     channel by sending the following command:
# Line 3327  Internet-Draft        LinuxSampler Contr Line 3743  Internet-Draft        LinuxSampler Contr
3743           is not assigned any MIDI instrument map and thus will ignore           is not assigned any MIDI instrument map and thus will ignore
3744           all MIDI program change messages.           all MIDI program change messages.
3745    
3746    
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires July 13, 2014                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol         January 2014
3754    
3755    
3756        "DEFAULT" -        "DEFAULT" -
3757    
3758           The sampler channel will always use the default MIDI instrument           The sampler channel will always use the default MIDI instrument
# Line 3354  Internet-Draft        LinuxSampler Contr Line 3780  Internet-Draft        LinuxSampler Contr
3780           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3781           error message           error message
3782    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3783     Examples:     Examples:
3784    
3785    
3786    
3787  6.4.25.  Adding an effect send to a sampler channel  6.4.28.  Adding an effect send to a sampler channel
3788    
3789     The front-end can create an additional effect send on a specific     The front-end can create an additional effect send on a specific
3790     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 3378  Internet-Draft        LinuxSampler Contr Line 3797  Internet-Draft        LinuxSampler Contr
3797     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3798     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3799     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3800     effect send entity.  The name does not have to be unique.     effect send entity.  The name does not have to be unique, but MUST be
3801       encapsulated into apostrophes and supports escape sequences as
3802       described in chapter "Character Set and Escape Sequences
3803       (Section 7.1)".
3804    
3805    
3806    
3807    Schoenebeck               Expires July 13, 2014                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol         January 2014
3810    
3811    
3812     By default, that is as initial routing, the effect send's audio     By default, that is as initial routing, the effect send's audio
3813     channels are automatically routed to the last audio channels of the     channels are automatically routed to the last audio channels of the
# Line 3387  Internet-Draft        LinuxSampler Contr Line 3816  Internet-Draft        LinuxSampler Contr
3816     having dedicated effect send output channels and when "CREATE     having dedicated effect send output channels and when "CREATE
3817     FX_SEND" is called, those channels will automatically be picked.  You     FX_SEND" is called, those channels will automatically be picked.  You
3818     can alter the destination channels however with "SET FX_SEND     can alter the destination channels however with "SET FX_SEND
3819     AUDIO_OUTPUT_CHANNEL" (Section 6.4.30).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.34).
3820    
3821     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3822     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
# Line 3407  Internet-Draft        LinuxSampler Contr Line 3836  Internet-Draft        LinuxSampler Contr
3836           channel, where <fx-send-id> reflects the unique ID of the newly           channel, where <fx-send-id> reflects the unique ID of the newly
3837           created effect send entity           created effect send entity
3838    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3839        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3840    
3841           when a new effect send could not be added, i.e. due to invalid           when a new effect send could not be added, i.e. due to invalid
# Line 3432  Internet-Draft        LinuxSampler Contr Line 3851  Internet-Draft        LinuxSampler Contr
3851    
3852        S: "OK[1]"        S: "OK[1]"
3853    
3854  6.4.26.  Removing an effect send from a sampler channel  6.4.29.  Removing an effect send from a sampler channel
3855    
3856     The front-end can remove an existing effect send on a specific     The front-end can remove an existing effect send on a specific
3857     sampler channel by sending the following command:     sampler channel by sending the following command:
3858    
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires July 13, 2014                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol         January 2014
3866    
3867    
3868        DESTROY FX_SEND <sampler-channel> <fx-send-id>        DESTROY FX_SEND <sampler-channel> <fx-send-id>
3869    
3870     Where <sampler-channel> is the respective sampler channel number as     Where <sampler-channel> is the respective sampler channel number as
# Line 3444  Internet-Draft        LinuxSampler Contr Line 3872  Internet-Draft        LinuxSampler Contr
3872     (Section 6.4.4) command, that is the sampler channel from which the     (Section 6.4.4) command, that is the sampler channel from which the
3873     effect send should be removed from and <fx-send-id> is the respective     effect send should be removed from and <fx-send-id> is the respective
3874     effect send number as returned by the "CREATE FX_SEND"     effect send number as returned by the "CREATE FX_SEND"
3875     (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.     (Section 6.4.28) or "LIST FX_SENDS" (Section 6.4.31) command.
3876    
3877     Possible Answers:     Possible Answers:
3878    
# Line 3463  Internet-Draft        LinuxSampler Contr Line 3891  Internet-Draft        LinuxSampler Contr
3891    
3892        S: "OK"        S: "OK"
3893    
3894    6.4.30.  Getting amount of effect sends on a sampler channel
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
 6.4.27.  Getting amount of effect sends on a sampler channel  
3895    
3896     The front-end can ask for the amount of effect sends on a specific     The front-end can ask for the amount of effect sends on a specific
3897     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 3495  Internet-Draft        LinuxSampler Contr Line 3913  Internet-Draft        LinuxSampler Contr
3913    
3914        S: "2"        S: "2"
3915    
3916  6.4.28.  Listing all effect sends on a sampler channel  
3917    
3918    
3919    Schoenebeck               Expires July 13, 2014                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol         January 2014
3922    
3923    
3924    6.4.31.  Listing all effect sends on a sampler channel
3925    
3926     The front-end can ask for a list of effect sends on a specific     The front-end can ask for a list of effect sends on a specific
3927     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 3521  Internet-Draft        LinuxSampler Contr Line 3947  Internet-Draft        LinuxSampler Contr
3947    
3948        S: ""        S: ""
3949    
3950    6.4.32.  Getting effect send information
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
 6.4.29.  Getting effect send information  
3951    
3952     The front-end can ask for the current settings of an effect send     The front-end can ask for the current settings of an effect send
3953     entity by sending the following command:     entity by sending the following command:
# Line 3539  Internet-Draft        LinuxSampler Contr Line 3957  Internet-Draft        LinuxSampler Contr
3957     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
3958     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3959     command and <fx-send-id> reflects the numerical ID of the effect send     command and <fx-send-id> reflects the numerical ID of the effect send
3960     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
3961     FX_SENDS" (Section 6.4.28) command.     FX_SENDS" (Section 6.4.31) command.
3962    
3963     Possible Answers:     Possible Answers:
3964    
# Line 3552  Internet-Draft        LinuxSampler Contr Line 3970  Internet-Draft        LinuxSampler Contr
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires July 13, 2014                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol         January 2014
3978    
3979    
3980    
3981    
3982           NAME -           NAME -
3983    
3984              name of the effect send entity              name of the effect send entity (note that this character
3985                string may contain escape sequences (Section 7.1))
3986    
3987             MIDI_CONTROLLER -
3988    
3989                a value between 0 and 127 reflecting the MIDI controller
3990                which is able to modify the effect send's send level
3991    
3992             LEVEL -
3993    
3994                optionally dotted number reflecting the effect send's
3995                current send level (where a value < 1.0 means attenuation
3996                and a value > 1.0 means amplification)
3997    
3998           AUDIO_OUTPUT_ROUTING -           AUDIO_OUTPUT_ROUTING -
3999    
# Line 3564  Internet-Draft        LinuxSampler Contr Line 4003  Internet-Draft        LinuxSampler Contr
4003              send's output channel 0 is routed to channel 0 of the audio              send's output channel 0 is routed to channel 0 of the audio
4004              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
4005              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
4006              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.34) for details),
4007                if an internal send effect is assigned to the effect send,
4008                then this setting defines the audio channel routing to that
4009                effect instance respectively
4010    
4011             EFFECT -
4012    
4013                destination send effect chain ID and destination effect
4014                chain position, separated by comma in the form "<effect-
4015                chain>,<chain-pos>" or "NONE" if there is no send effect
4016                assigned to the effect send
4017    
4018     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4019    
# Line 3574  Internet-Draft        LinuxSampler Contr Line 4023  Internet-Draft        LinuxSampler Contr
4023    
4024        S: "NAME: Reverb Send"        S: "NAME: Reverb Send"
4025    
4026             "MIDI_CONTROLLER: 91"
4027    
4028    
4029    
4030    
4031    Schoenebeck               Expires July 13, 2014                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol         January 2014
4034    
4035    
4036             "LEVEL: 0.3"
4037    
4038           "AUDIO_OUTPUT_ROUTING: 2,3"           "AUDIO_OUTPUT_ROUTING: 2,3"
4039    
4040             "EFFECT: NONE"
4041    
4042             "."
4043    
4044          C: "GET FX_SEND INFO 0 1"
4045    
4046          S: "NAME: Delay Send (Internal)"
4047    
4048  Schoenebeck               Expires July 2, 2007                 [Page 64]           "MIDI_CONTROLLER: 93"
4049    
4050  Internet-Draft        LinuxSampler Control Protocol        December 2006           "LEVEL: 0.51"
4051    
4052             "AUDIO_OUTPUT_ROUTING: 1,2"
4053    
4054             "EFFECT: 2,0"
4055    
4056           "."           "."
4057    
4058  6.4.30.  Altering effect send's audio routing  6.4.33.  Changing effect send's name
4059    
4060       The front-end can alter the current name of an effect send entity by
4061       sending the following command:
4062    
4063          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
4064    
4065       Where <sampler-chan> is the sampler channel number as returned by the
4066       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4067       command, <fx-send-id> reflects the numerical ID of the effect send
4068       entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4069       FX_SENDS" (Section 6.4.31) command and <name> is the new name of the
4070       effect send entity, which does not have to be unique (name MUST be
4071       encapsulated into apostrophes and supports escape sequences as
4072       described in chapter "Character Set and Escape Sequences
4073       (Section 7.1)").
4074    
4075       Possible Answers:
4076    
4077          "OK" -
4078    
4079             on success
4080    
4081          "ERR:<error-code>:<error-message>" -
4082    
4083    
4084    
4085    
4086    
4087    Schoenebeck               Expires July 13, 2014                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol         January 2014
4090    
4091    
4092             in case it failed, providing an appropriate error code and
4093             error message
4094    
4095       Example:
4096    
4097          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
4098    
4099          S: "OK"
4100    
4101    6.4.34.  Altering effect send's audio routing
4102    
4103     The front-end can alter the destination of an effect send's audio     The front-end can alter the destination of an effect send's audio
4104     channel on a specific sampler channel by sending the following     channel on a specific sampler channel by sending the following
# Line 3599  Internet-Draft        LinuxSampler Contr Line 4110  Internet-Draft        LinuxSampler Contr
4110     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4111     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4112     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4113     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4114     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.31) command, <audio-src> is the numerical ID
4115     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
4116     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
4117     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.  If an
4118       internal send effect is assigned to the effect send, then this
4119       setting defines the audio channel routing to that effect instance
4120       respectively.
4121    
4122     Note that effect sends can only route audio to the same audio output     Note that effect sends can only route audio to the same audio output
4123     device as assigned to the effect send's sampler channel.  Also note     device as assigned to the effect send's sampler channel.  Also note
# Line 3623  Internet-Draft        LinuxSampler Contr Line 4137  Internet-Draft        LinuxSampler Contr
4137    
4138           on success           on success
4139    
4140    
4141    
4142    
4143    Schoenebeck               Expires July 13, 2014                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol         January 2014
4146    
4147    
4148        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4149    
4150           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
# Line 3634  Internet-Draft        LinuxSampler Contr Line 4156  Internet-Draft        LinuxSampler Contr
4156           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4157           error message           error message
4158    
4159       Example:
4160    
4161          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
4162    
4163          S: "OK"
4164    
4165    6.4.35.  Assigning destination effect to an effect send
4166    
4167       The front-end can (re-)assign a destination effect to an effect send
4168       by sending the following command:
4169    
4170          SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain>
4171          <chain-pos>
4172    
4173       Where <sampler-chan> is the sampler channel number as returned by the
4174       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4175       command, <fx-send-id> reflects the numerical ID of the effect send
4176       entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4177       FX_SENDS" (Section 6.4.31) command, <effect-chain> by the numerical
4178       ID of the destination effect chain as returned by the "ADD
4179       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
4180       (Section 6.11.13) command and <chain-pos> reflects the exact effect
4181       chain position in the effect chain which hosts the actual destination
4182       effect.
4183    
4184       Possible Answers:
4185    
4186          "OK" -
4187    
4188             on success
4189    
4190          "ERR:<error-code>:<error-message>" -
4191    
4192             in case it failed, providing an appropriate error code and
4193             error message
4194    
4195       Example:
4196    
4197    
4198    
4199  Schoenebeck               Expires July 2, 2007                 [Page 65]  Schoenebeck               Expires July 13, 2014                [Page 75]
4200    
4201  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
4202    
4203    
4204          C: "SET FX_SEND EFFECT 0 0 2 5"
4205    
4206          S: "OK"
4207    
4208    6.4.36.  Removing destination effect from an effect send
4209    
4210       The front-end can (re-)assign a destination effect to an effect send
4211       by sending the following command:
4212    
4213          REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id>
4214    
4215       Where <sampler-chan> is the sampler channel number as returned by the
4216       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4217       command, <fx-send-id> reflects the numerical ID of the effect send
4218       entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4219       FX_SENDS" (Section 6.4.31) command.
4220    
4221       After the destination effect has been removed from the effect send,
4222       the audio signal of the effect send will be routed directly to the
4223       audio output device, according to the audio channel routing setting
4224       of the effect send.
4225    
4226       Possible Answers:
4227    
4228          "OK" -
4229    
4230             on success
4231    
4232          "ERR:<error-code>:<error-message>" -
4233    
4234             in case it failed, providing an appropriate error code and
4235             error message
4236    
4237     Example:     Example:
4238    
4239        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"        C: "REMOVE FX_SEND EFFECT 0 0"
4240    
4241        S: "OK"        S: "OK"
4242    
4243  6.4.31.  Resetting a sampler channel  6.4.37.  Altering effect send's MIDI controller
4244    
4245       The front-end can alter the MIDI controller of an effect send entity
4246       by sending the following command:
4247    
4248          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
4249          ctrl>
4250    
4251       Where <sampler-chan> is the sampler channel number as returned by the
4252    
4253    
4254    
4255    Schoenebeck               Expires July 13, 2014                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol         January 2014
4258    
4259    
4260       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4261       command, <fx-send-id> reflects the numerical ID of the effect send
4262       entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4263       FX_SENDS" (Section 6.4.31) command and <midi-ctrl> reflects the MIDI
4264       controller which shall be able to modify the effect send's send
4265       level.
4266    
4267       Possible Answers:
4268    
4269          "OK" -
4270    
4271             on success
4272    
4273          "WRN:<warning-code>:<warning-message>" -
4274    
4275             if MIDI controller was set, but there are noteworthy issue(s)
4276             related, providing an appropriate warning code and warning
4277             message
4278    
4279          "ERR:<error-code>:<error-message>" -
4280    
4281             in case it failed, providing an appropriate error code and
4282             error message
4283    
4284       Example:
4285    
4286          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
4287    
4288          S: "OK"
4289    
4290    6.4.38.  Altering effect send's send level
4291    
4292       The front-end can alter the current send level of an effect send
4293       entity by sending the following command:
4294    
4295          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
4296    
4297       Where <sampler-chan> is the sampler channel number as returned by the
4298       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4299       command, <fx-send-id> reflects the numerical ID of the effect send
4300       entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4301       FX_SENDS" (Section 6.4.31) command and <volume> is an optionally
4302       dotted positive number (a value smaller than 1.0 means attenuation,
4303       whereas a value greater than 1.0 means amplification) reflecting the
4304       new send level.
4305    
4306       Possible Answers:
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires July 13, 2014                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol         January 2014
4314    
4315    
4316          "OK" -
4317    
4318             on success
4319    
4320          "WRN:<warning-code>:<warning-message>" -
4321    
4322             if new send level was set, but there are noteworthy issue(s)
4323             related, providing an appropriate warning code and warning
4324             message
4325    
4326          "ERR:<error-code>:<error-message>" -
4327    
4328             in case it failed, providing an appropriate error code and
4329             error message
4330    
4331       Example:
4332    
4333          C: "SET FX_SEND LEVEL 0 0 0.15"
4334    
4335          S: "OK"
4336    
4337    6.4.39.  Sending MIDI messages to sampler channel
4338    
4339       The front-end can send MIDI events to a specific sampler channel by
4340       sending the following command:
4341    
4342          SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>
4343    
4344       Where <sampler-chan> is the sampler channel number as returned by the
4345       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4346       command, <arg1> and <arg2> arguments depend on the <midi-msg>
4347       argument, which specifies the MIDI message type.  Currently, the
4348       following MIDI messages are supported:
4349    
4350          "NOTE_ON" -
4351    
4352             For turning on MIDI notes, where <arg1> specifies the key
4353             number and <arg2> the velocity as described in the MIDI
4354             specification.
4355    
4356          "NOTE_OFF" -
4357    
4358             For turning a currently playing MIDI note off, where <arg1>
4359             specifies the key number and <arg2> the velocity as described
4360             in the MIDI specification.
4361    
4362    
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires July 13, 2014                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol         January 2014
4370    
4371    
4372          "CC" -
4373    
4374             For changing a MIDI controller, where <arg1> specifies the
4375             controller number and <arg2> the new value of the controller as
4376             described in the Control Change section of the MIDI
4377             specification.
4378    
4379       CAUTION: This command is provided for implementations of virtual MIDI
4380       keyboards and no realtime guarantee whatsoever will be made!
4381    
4382       Possible Answers:
4383    
4384          "OK" -
4385    
4386             on success
4387    
4388          "ERR:<error-code>:<error-message>" -
4389    
4390             in case it failed, providing an appropriate error code and
4391             error message
4392    
4393       Example:
4394    
4395          C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
4396    
4397          S: "OK"
4398    
4399    6.4.40.  Resetting a sampler channel
4400    
4401     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
4402     following command:     following command:
# Line 3667  Internet-Draft        LinuxSampler Contr Line 4416  Internet-Draft        LinuxSampler Contr
4416    
4417        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4418    
4419    
4420    
4421    
4422    
4423    Schoenebeck               Expires July 13, 2014                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol         January 2014
4426    
4427    
4428           if channel was reset, but there are noteworthy issue(s)           if channel was reset, but there are noteworthy issue(s)
4429           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4430           message           message
# Line 3690  Internet-Draft        LinuxSampler Contr Line 4448  Internet-Draft        LinuxSampler Contr
4448     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
4449     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
4450    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4451        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
4452    
4453     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
# Line 3723  Internet-Draft        LinuxSampler Contr Line 4474  Internet-Draft        LinuxSampler Contr
4474    
4475    
4476    
4477    
4478    
4479    Schoenebeck               Expires July 13, 2014                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol         January 2014
4482    
4483    
4484    
4485    
4486  6.5.2.  Unregister front-end for not receiving event messages  6.5.2.  Unregister front-end for not receiving event messages
4487    
4488     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
# Line 3745  Internet-Draft        LinuxSampler Contr Line 4505  Internet-Draft        LinuxSampler Contr
4505           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4506           message           message
4507    
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4508        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4509    
4510           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3778  Internet-Draft        LinuxSampler Contr Line 4530  Internet-Draft        LinuxSampler Contr
4530    
4531     Possible Answers:     Possible Answers:
4532    
4533    
4534    
4535    Schoenebeck               Expires July 13, 2014                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol         January 2014
4538    
4539    
4540        "OK" -        "OK" -
4541    
4542           usually           usually
# Line 3800  Internet-Draft        LinuxSampler Contr Line 4559  Internet-Draft        LinuxSampler Contr
4559     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4560     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4561    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4562  6.6.  Global commands  6.6.  Global commands
4563    
4564     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
# Line 3834  Internet-Draft        LinuxSampler Contr Line 4584  Internet-Draft        LinuxSampler Contr
4584    
4585     Possible Answers:     Possible Answers:
4586    
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires July 13, 2014                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol         January 2014
4594    
4595    
4596        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4597        voices.        voices.
4598    
4599  6.6.3.  Reset sampler  6.6.3.  Current number of active disk streams
4600    
4601       The front-end can ask for the current number of active disk streams
4602       on the sampler by sending the following command:
4603    
4604          GET TOTAL_STREAM_COUNT
4605    
4606       Possible Answers:
4607    
4608          LinuxSampler will answer by returning the number of all active
4609          disk streams on the sampler.
4610    
4611    6.6.4.  Reset sampler
4612    
4613     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
4614     command:     command:
# Line 3854  Internet-Draft        LinuxSampler Contr Line 4625  Internet-Draft        LinuxSampler Contr
4625    
4626    
4627    
4628    6.6.5.  General sampler informations
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
 6.6.4.  General sampler informations  
4629    
4630     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
4631     instance by sending the following command:     instance by sending the following command:
# Line 3882  Internet-Draft        LinuxSampler Contr Line 4642  Internet-Draft        LinuxSampler Contr
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires July 13, 2014                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol         January 2014
4650    
4651    
4652    
4653    
4654           DESCRIPTION -           DESCRIPTION -
4655    
4656              arbitrary textual description about the sampler              arbitrary textual description about the sampler (note that
4657                the character string may contain escape sequences
4658                (Section 7.1))
4659    
4660           VERSION -           VERSION -
4661    
# Line 3895  Internet-Draft        LinuxSampler Contr Line 4666  Internet-Draft        LinuxSampler Contr
4666              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
4667              (see Section 2 for details)              (see Section 2 for details)
4668    
4669             INSTRUMENTS_DB_SUPPORT -
4670    
4671                either yes or no, specifies whether the sampler is build
4672                with instruments database support.
4673    
4674     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4675     Other fields might be added in future.     Other fields might be added in future.
4676    
4677  6.6.5.  Getting global volume attenuation     Example:
4678    
4679          C: "GET SERVER INFO"
4680    
4681          S: "DESCRIPTION: LinuxSampler - modular, streaming capable
4682          sampler"
4683    
4684             "VERSION: 1.0.0.svn23"
4685    
4686             "PROTOCOL_VERSION: 1.5"
4687    
4688             "INSTRUMENTS_DB_SUPPORT: no"
4689    
4690             "."
4691    
4692    6.6.6.  Getting global volume attenuation
4693    
4694     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
4695     attenuation by sending the following command:     attenuation by sending the following command:
# Line 3907  Internet-Draft        LinuxSampler Contr Line 4698  Internet-Draft        LinuxSampler Contr
4698    
4699     Possible Answers:     Possible Answers:
4700    
4701    
4702    
4703    Schoenebeck               Expires July 13, 2014                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol         January 2014
4706    
4707    
4708        The sampler will always answer by returning the optional dotted        The sampler will always answer by returning the optional dotted
4709        floating point coefficient, reflecting the current global volume        floating point coefficient, reflecting the current global volume
4710        attenuation.        attenuation.
4711    
4712     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4713     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4714     this parameter.     this parameter.
4715    
4716  6.6.6.  Setting global volume attenuation  6.6.7.  Setting global volume attenuation
4717    
4718     The client can alter the current global sampler-wide volume     The client can alter the current global sampler-wide volume
4719     attenuation by sending the following command:     attenuation by sending the following command:
# Line 3952  Internet-Draft        LinuxSampler Contr Line 4742  Internet-Draft        LinuxSampler Contr
4742           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4743           error message           error message
4744    
4745    6.6.8.  Getting global voice limit
4746    
4747       The client can ask for the current global sampler-wide limit for
4748       maximum voices by sending the following command:
4749    
4750          GET VOICES
4751    
4752       Possible Answers:
4753    
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires July 13, 2014                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol         January 2014
4762    
4763    
4764          LinuxSampler will answer by returning the number for the current
4765          limit of maximum voices.
4766    
4767       The voice limit setting defines how many voices should maximum be
4768       processed by the sampler at the same time.  If the user triggers new
4769       notes which would exceed that voice limit, the sampler engine will
4770       react by stealing old voices for those newly triggered notes.  Note
4771       that the amount of voices triggered by a new note can be larger than
4772       one and is dependent to the respective instrument and probably
4773       further criterias.
4774    
4775    6.6.9.  Setting global voice limit
4776    
4777       The client can alter the current global sampler-wide limit for
4778       maximum voices by sending the following command:
4779    
4780          SET VOICES <max-voices>
4781    
4782       Where <max-voices> should be replaced by the integer value,
4783       reflecting the new global amount limit of maximum voices.  This value
4784       has to be larger than 0.
4785    
4786       Possible Answers:
4787    
4788          "OK" -
4789    
4790             on success
4791    
4792          "WRN:<warning-code>:<warning-message>" -
4793    
4794             if the voice limit was set, but there are noteworthy issue(s)
4795             related, providing an appropriate warning code and warning
4796             message
4797    
4798          "ERR:<error-code>:<error-message>" -
4799    
4800             in case it failed, providing an appropriate error code and
4801             error message
4802    
4803       Note: the given value will be passed to all sampler engine instances.
4804       The total amount of maximum voices on the running system might thus
4805       be as big as the given value multiplied by the current amount of
4806       engine instances.
4807    
4808       Caution: when adjusting the voice limit, you SHOULD also adjust the
4809       disk stream limit respectively and vice versa.
4810    
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires July 13, 2014                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol         January 2014
4818    
4819    
4820    6.6.10.  Getting global disk stream limit
4821    
4822       The client can ask for the current global sampler-wide limit for
4823       maximum disk streams by sending the following command:
4824    
4825          GET STREAMS
4826    
4827       Possible Answers:
4828    
4829          LinuxSampler will answer by returning the number for the current
4830          limit of maximum disk streams.
4831    
4832       The disk stream limit setting defines how many disk streams should
4833       maximum be processed by a sampler engine at the same time.  The
4834       higher this value, the more memory (RAM) will be occupied, since
4835       every disk streams allocates a certain buffer size for being able to
4836       perform its streaming operations.
4837    
4838    6.6.11.  Setting global disk stream limit
4839    
4840       The client can alter the current global sampler-wide limit for
4841       maximum disk streams by sending the following command:
4842    
4843          SET STREAMS <max-streams>
4844    
4845       Where <max-streams> should be replaced by the integer value,
4846       reflecting the new global amount limit of maximum disk streams.  This
4847       value has to be positive.
4848    
4849       Possible Answers:
4850    
4851          "OK" -
4852    
4853             on success
4854    
4855          "WRN:<warning-code>:<warning-message>" -
4856    
4857             if the disk stream limit was set, but there are noteworthy
4858             issue(s) related, providing an appropriate warning code and
4859             warning message
4860    
4861          "ERR:<error-code>:<error-message>" -
4862    
4863             in case it failed, providing an appropriate error code and
4864             error message
4865    
4866       Note: the given value will be passed to all sampler engine instances.
4867       The total amount of maximum disk streams on the running system might
4868    
4869    
4870    
4871    Schoenebeck               Expires July 13, 2014                [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol         January 2014
4874    
4875    
4876       thus be as big as the given value multiplied by the current amount of
4877       engine instances.
4878    
4879       Caution: when adjusting the disk stream limit, you SHOULD also adjust
4880       the voice limit respectively and vice versa.
4881    
4882  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4883    
4884     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 3969  Internet-Draft        LinuxSampler Contr Line 4896  Internet-Draft        LinuxSampler Contr
4896     front-end has to explicitly create at least one map, add entries to     front-end has to explicitly create at least one map, add entries to
4897     the map and tell the respective sampler channel(s) which MIDI     the map and tell the respective sampler channel(s) which MIDI
4898     instrument map to use, so the sampler knows how to react on a given     instrument map to use, so the sampler knows how to react on a given
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4899     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
4900     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
4901     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4902     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler     (Section 6.4.27) for how to assign a MIDI instrument map to a sampler
4903     channel.     channel.
4904    
4905     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
# Line 3998  Internet-Draft        LinuxSampler Contr Line 4917  Internet-Draft        LinuxSampler Contr
4917        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4918    
4919     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
4920     to the new map.  MIDI instrument Map names do not have to be unique.     to the new map.  MIDI instrument Map names do not have to be unique,
4921       but MUST be encapsulated into apostrophes and support escape
4922       sequences as described in chapter "Character Set and Escape Sequences
4923       (Section 7.1)".
4924    
4925    
4926    
4927    Schoenebeck               Expires July 13, 2014                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol         January 2014
4930    
4931    
4932     Possible Answers:     Possible Answers:
4933    
# Line 4024  Internet-Draft        LinuxSampler Contr Line 4953  Internet-Draft        LinuxSampler Contr
4953    
4954        C: "ADD MIDI_INSTRUMENT_MAP"        C: "ADD MIDI_INSTRUMENT_MAP"
4955    
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4956        S: "OK[5]"        S: "OK[5]"
4957    
4958  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
# Line 4056  Internet-Draft        LinuxSampler Contr Line 4976  Internet-Draft        LinuxSampler Contr
4976    
4977           in case the map(s) could be deleted           in case the map(s) could be deleted
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires July 13, 2014                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol         January 2014
4986    
4987    
4988        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4989    
4990           when the given map does not exist           when the given map does not exist
# Line 4079  Internet-Draft        LinuxSampler Contr Line 5008  Internet-Draft        LinuxSampler Contr
5008    
5009     Possible Answers:     Possible Answers:
5010    
   
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
5011        The sampler will answer by returning the current number of MIDI        The sampler will answer by returning the current number of MIDI
5012        instrument maps.        instrument maps.
5013    
# Line 4113  Internet-Draft        LinuxSampler Contr Line 5032  Internet-Draft        LinuxSampler Contr
5032    
5033     Example:     Example:
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires July 13, 2014                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol         January 2014
5042    
5043    
5044        C: "LIST MIDI_INSTRUMENT_MAPS"        C: "LIST MIDI_INSTRUMENT_MAPS"
5045    
5046        S: "0,1,5,12"        S: "0,1,5,12"
# Line 4138  Internet-Draft        LinuxSampler Contr Line 5066  Internet-Draft        LinuxSampler Contr
5066    
5067    
5068    
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
   
   
5069           NAME -           NAME -
5070    
5071              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
5072              unique              unique (note that this character string may contain escape
5073                sequences (Section 7.1))
5074    
5075             DEFAULT -
5076    
5077                either true or false, defines whether this map is the
5078                default map
5079    
5080     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5081    
# Line 4160  Internet-Draft        LinuxSampler Contr Line 5085  Internet-Draft        LinuxSampler Contr
5085    
5086        S: "NAME: Standard Map"        S: "NAME: Standard Map"
5087    
5088             "DEFAULT: true"
5089    
5090           "."           "."
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires July 13, 2014                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol         January 2014
5098    
5099    
5100  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
5101    
5102     The front-end can alter the custom name of a MIDI instrument map by     The front-end can alter the custom name of a MIDI instrument map by
# Line 4170  Internet-Draft        LinuxSampler Contr Line 5105  Internet-Draft        LinuxSampler Contr
5105        SET MIDI_INSTRUMENT_MAP NAME <map> <name>        SET MIDI_INSTRUMENT_MAP NAME <map> <name>
5106    
5107     Where <map> is the numerical ID of the map and <name> the new custom     Where <map> is the numerical ID of the map and <name> the new custom
5108     name of the map, which does not have to be unique.     name of the map, which does not have to be unique (name MUST be
5109       encapsulated into apostrophes and supports escape sequences as
5110       described in chapter "Character Set and Escape Sequences
5111       (Section 7.1)").
5112    
5113     Possible Answers:     Possible Answers:
5114    
# Line 4193  Internet-Draft        LinuxSampler Contr Line 5131  Internet-Draft        LinuxSampler Contr
5131     The front-end can create a new or replace an existing entry in a     The front-end can create a new or replace an existing entry in a
5132     sampler's MIDI instrument map by sending the following command:     sampler's MIDI instrument map by sending the following command:
5133    
5134          MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
5135          <engine_name> <filename> <instrument_index> <volume_value>
5136          [<instr_load_mode>] [<name>]
 Schoenebeck               Expires July 2, 2007                 [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
       MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>  
       <filename> <instrument_index> <volume_value> [<instr_load_mode>]  
       [<name>]  
5137    
5138     Where <map> is the numeric ID of the map to alter, <midi_bank> is an     Where <map> is the numeric ID of the map to alter, <midi_bank> is an
5139     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
# Line 4211  Internet-Draft        LinuxSampler Contr Line 5141  Internet-Draft        LinuxSampler Contr
5141     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
5142     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
5143     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
5144     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes,
5145     <instrument_index> the index (integer value) of the instrument within     supporting escape sequences as described in chapter "Character Set
5146     the given file, <volume_value> reflects the master volume of the     and Escape Sequences (Section 7.1)"), <instrument_index> the index
5147     instrument as optionally dotted number (where a value < 1.0 means     (integer value) of the instrument within the given file,
5148     attenuation and a value > 1.0 means amplification).  This parameter  
5149     easily allows to adjust the volume of all intruments within a custom  
5150     instrument map without having to adjust their instrument files.  The  
5151     OPTIONAL <instr_load_mode> argument defines the life time of the  Schoenebeck               Expires July 13, 2014                [Page 92]
5152     instrument, that is when the instrument should be loaded, when freed  
5153     and has exactly the following possibilities:  Internet-Draft        LinuxSampler Control Protocol         January 2014
5154    
5155    
5156       <volume_value> reflects the master volume of the instrument as
5157       optionally dotted number (where a value < 1.0 means attenuation and a
5158       value > 1.0 means amplification).  This parameter easily allows to
5159       adjust the volume of all intruments within a custom instrument map
5160       without having to adjust their instrument files.  The OPTIONAL
5161       <instr_load_mode> argument defines the life time of the instrument,
5162       that is when the instrument should be loaded, when freed and has
5163       exactly the following possibilities:
5164    
5165        "ON_DEMAND" -        "ON_DEMAND" -
5166    
# Line 4241  Internet-Draft        LinuxSampler Contr Line 5181  Internet-Draft        LinuxSampler Contr
5181    
5182        "PERSISTENT" -        "PERSISTENT" -
5183    
5184           The instrument will immediately be loaded into memory in the           The instrument will immediately be loaded into memory when this
5185           background when this mapping command is sent and the instrument           mapping command is sent and the instrument is kept all the
5186           is kept all the time.  Instruments with this mode are only           time.  Instruments with this mode are only freed when the
5187           freed when the sampler is reset or all mapping entries with           sampler is reset or all mapping entries with this mode (and
5188           this mode (and respective instrument) are explicitly changed to           respective instrument) are explicitly changed to "ON_DEMAND"
5189           "ON_DEMAND" and no sampler channel is using the instrument           and no sampler channel is using the instrument anymore.
          anymore.  
   
   
   
   
 Schoenebeck               Expires July 2, 2007                 [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
5190    
5191        not supplied -        not supplied -
5192    
# Line 4270  Internet-Draft        LinuxSampler Contr Line 5201  Internet-Draft        LinuxSampler Contr
5201     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
5202     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
5203     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
5204    
5205    
5206    
5207    Schoenebeck               Expires July 13, 2014                [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol         January 2014
5210    
5211    
5212     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
5213     supported by the respective sampler engine (which is technically the     supported by the respective sampler engine (which is technically the
5214     case when the engine provides an InstrumentManager for its format).     case when the engine provides an InstrumentManager for its format).
# Line 4282  Internet-Draft        LinuxSampler Contr Line 5221  Internet-Draft        LinuxSampler Contr
5221     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
5222     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
5223     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
5224     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes, supporting escape sequences as described in chapter
5225     displaying an appropriate name for mapped instruments (using "GET     "Character Set and Escape Sequences (Section 7.1)") for the mapping
5226     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     entry, useful for frontends for displaying an appropriate name for
5227       mapped instruments (using "GET MIDI_INSTRUMENT INFO"
5228     The "MAP MIDI_INSTRUMENT" command will immediately return, thus it     (Section 6.7.11)).
5229     will not block when an instrument is to be loaded due to a  
5230     "PERSISTENT" type entry as instruments are loaded in the background.     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
5231     As a consequence this command may not necessarily return an error     completely established in the sampler.  The OPTIONAL "NON_MODAL"
5232     i.e. when the given instrument file does not exist or may turn out to     argument however causes the respective "MAP MIDI_INSTRUMENT" command
5233     be corrupt.     to return immediately, that is to let the sampler establish the
5234       mapping in the background.  So this argument might be especially
5235       useful for mappings with a "PERSISTENT" type, because these have to
5236       load the respective instruments immediately and might thus block for
5237       a very long time.  It is recommended however to use the OPTIONAL
5238       "NON_MODAL" argument only if really necessary, because it has the
5239       following drawbacks: as "NON_MODAL" instructions return immediately,
5240       they may not necessarily return an error i.e. when the given
5241       instrument file turns out to be corrupt, beside that subsequent
5242       commands in a LSCP instruction sequence might fail, because mandatory
5243       mappings are not yet completed.
5244    
5245     Possible Answers:     Possible Answers:
5246    
# Line 4308  Internet-Draft        LinuxSampler Contr Line 5257  Internet-Draft        LinuxSampler Contr
5257    
5258    
5259    
5260  Schoenebeck               Expires July 2, 2007                 [Page 77]  
5261    
5262    
5263    Schoenebeck               Expires July 13, 2014                [Page 94]
5264    
5265  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
5266    
5267    
5268        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
# Line 4333  Internet-Draft        LinuxSampler Contr Line 5285  Internet-Draft        LinuxSampler Contr
5285    
5286        S: "OK"        S: "OK"
5287    
5288        C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
5289        PERSISTENT 'Foo Drumkit'"        foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
5290    
5291        S: "OK"        S: "OK"
5292    
5293  6.7.8.  Getting ammount of MIDI instrument map entries  6.7.8.  Getting amount of MIDI instrument map entries
5294    
5295     The front-end can query the amount of currently existing entries in a     The front-end can query the amount of currently existing entries in a
5296     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
# Line 4364  Internet-Draft        LinuxSampler Contr Line 5316  Internet-Draft        LinuxSampler Contr
5316    
5317    
5318    
5319  Schoenebeck               Expires July 2, 2007                 [Page 78]  Schoenebeck               Expires July 13, 2014                [Page 95]
5320    
5321  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
5322    
5323    
5324        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
# Line 4420  Internet-Draft        LinuxSampler Contr Line 5372  Internet-Draft        LinuxSampler Contr
5372    
5373    
5374    
5375  Schoenebeck               Expires July 2, 2007                 [Page 79]  Schoenebeck               Expires July 13, 2014                [Page 96]
5376    
5377  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
5378    
5379    
5380        "OK" -        "OK" -
# Line 4466  Internet-Draft        LinuxSampler Contr Line 5418  Internet-Draft        LinuxSampler Contr
5418           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
5419           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
5420           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
5421           be unique.           be unique. (note that this character string may contain escape
5422             sequences (Section 7.1))
5423    
5424        "ENGINE_NAME" -        "ENGINE_NAME" -
5425    
# Line 4475  Internet-Draft        LinuxSampler Contr Line 5428  Internet-Draft        LinuxSampler Contr
5428    
5429    
5430    
5431    Schoenebeck               Expires July 13, 2014                [Page 97]
 Schoenebeck               Expires July 2, 2007                 [Page 80]  
5432    
5433  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
5434    
5435    
5436        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
5437    
5438           File name of the instrument.           File name of the instrument (note that this path may contain
5439             escape sequences (Section 7.1)).
5440    
5441        "INSTRUMENT_NR" -        "INSTRUMENT_NR" -
5442    
# Line 4493  Internet-Draft        LinuxSampler Contr Line 5446  Internet-Draft        LinuxSampler Contr
5446    
5447           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
5448           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
5449           cannot be changed.           cannot be changed (note that this character string may contain
5450             escape sequences (Section 7.1)).
5451    
5452        "LOAD_MODE" -        "LOAD_MODE" -
5453    
# Line 4526  Internet-Draft        LinuxSampler Contr Line 5480  Internet-Draft        LinuxSampler Contr
5480    
5481           "VOLUME: 1.0"           "VOLUME: 1.0"
5482    
          "."  
   
5483    
5484    
5485    
5486    
5487  Schoenebeck               Expires July 2, 2007                 [Page 81]  Schoenebeck               Expires July 13, 2014                [Page 98]
5488    
5489  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
5490    
5491    
5492             "."
5493    
5494  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
5495    
5496     The front-end can clear a whole MIDI instrument map, that is delete     The front-end can clear a whole MIDI instrument map, that is delete
# Line 4571  Internet-Draft        LinuxSampler Contr Line 5525  Internet-Draft        LinuxSampler Contr
5525    
5526        S: "OK"        S: "OK"
5527    
5528    6.8.  Managing Instruments Database
5529    
5530       The following commands describe how to use and manage the instruments
5531       database.
5532    
5533       Notice:
5534    
5535          All command arguments representing a path or instrument/directory
5536          name support escape sequences as described in chapter "Character
5537          Set and Escape Sequences (Section 7.1)".
5538    
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires July 13, 2014                [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol         January 2014
5546    
5547    
5548          All occurrences of a forward slash in instrument and directory
5549          names are escaped with its hex (\x2f) or octal (\057) escape
5550          sequence.
5551    
5552    6.8.1.  Creating a new instrument directory
5553    
5554       The front-end can add a new instrument directory to the instruments
5555       database by sending the following command:
5556    
5557          ADD DB_INSTRUMENT_DIRECTORY <dir>
5558    
5559       Where <dir> is the absolute path name of the directory to be created
5560       (encapsulated into apostrophes).
5561    
5562       Possible Answers:
5563    
5564          "OK" -
5565    
5566             on success
5567    
5568          "ERR:<error-code>:<error-message>" -
5569    
5570             when the directory could not be created, which can happen if
5571             the directory already exists or the name contains not allowed
5572             symbols
5573    
5574       Examples:
5575    
5576          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
5577    
5578          S: "OK"
5579    
5580    6.8.2.  Deleting an instrument directory
5581    
5582       The front-end can delete a particular instrument directory from the
5583       instruments database by sending the following command:
5584    
5585          REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
5586    
5587       Where <dir> is the absolute path name of the directory to delete.
5588       The optional FORCE argument can be used to force the deletion of a
5589       non-empty directory and all its content.
5590    
5591       Possible Answers:
5592    
5593          "OK" -
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck               Expires July 13, 2014               [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol         January 2014
5602    
5603    
5604             if the directory is deleted successfully
5605    
5606          "ERR:<error-code>:<error-message>" -
5607    
5608             if the given directory does not exist, or if trying to delete a
5609             non-empty directory, without using the FORCE argument.
5610    
5611       Examples:
5612    
5613          C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
5614    
5615          S: "OK"
5616    
5617    6.8.3.  Getting amount of instrument directories
5618    
5619       The front-end can retrieve the current amount of directories in a
5620       specific directory by sending the following command:
5621    
5622          GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
5623    
5624       Where <dir> should be replaced by the absolute path name of the
5625       directory.  If RECURSIVE is specified, the number of all directories,
5626       including those located in subdirectories of the specified directory,
5627       will be returned.
5628    
5629       Possible Answers:
5630    
5631          The current number of instrument directories in the specified
5632          directory.
5633    
5634          "ERR:<error-code>:<error-message>" -
5635    
5636             if the given directory does not exist.
5637    
5638       Example:
5639    
5640          C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
5641    
5642          S: "2"
5643    
5644    6.8.4.  Listing all directories in specific directory
5645    
5646       The front-end can retrieve the current list of directories in
5647       specific directory by sending the following command:
5648    
5649          LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
5650    
5651       Where <dir> should be replaced by the absolute path name of the
5652    
5653    
5654    
5655    Schoenebeck               Expires July 13, 2014               [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol         January 2014
5658    
5659    
5660       directory.  If RECURSIVE is specified, the absolute path names of all
5661       directories, including those located in subdirectories of the
5662       specified directory, will be returned.
5663    
5664       Possible Answers:
5665    
5666          A comma separated list of all instrument directories (encapsulated
5667          into apostrophes) in the specified directory.
5668    
5669          "ERR:<error-code>:<error-message>" -
5670    
5671             if the given directory does not exist.
5672    
5673       Example:
5674    
5675          C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
5676    
5677          S: "'Piano Collection','Percussion Collection'"
5678    
5679          C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
5680    
5681          S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
5682          Collection/Acoustic/New','/Percussion Collection'"
5683    
5684    6.8.5.  Getting instrument directory information
5685    
5686       The front-end can ask for the current settings of an instrument
5687       directory by sending the following command:
5688    
5689          GET DB_INSTRUMENT_DIRECTORY INFO <dir>
5690    
5691       Where <dir> should be replaced by the absolute path name of the
5692       directory the front-end is interested in.
5693    
5694       Possible Answers:
5695    
5696          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5697          answer line begins with the settings category name followed by a
5698          colon and then a space character <SP> and finally the info
5699          character string to that setting category.  At the moment the
5700          following categories are defined:
5701    
5702    
5703    
5704             DESCRIPTION -
5705    
5706                A brief description of the directory content.  Note that the
5707                character string may contain escape sequences (Section 7.1).
5708    
5709    
5710    
5711    Schoenebeck               Expires July 13, 2014               [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol         January 2014
5714    
5715    
5716             CREATED -
5717    
5718                The creation date and time of the directory, represented in
5719                "YYYY-MM-DD HH:MM:SS" format
5720    
5721             MODIFIED -
5722    
5723                The date and time of the last modification of the directory,
5724                represented in "YYYY-MM-DD HH:MM:SS" format
5725    
5726       The mentioned fields above don't have to be in particular order.
5727    
5728       Example:
5729    
5730          C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
5731    
5732          S: "DESCRIPTION: Piano collection of instruments in GigaSampler
5733          format."
5734    
5735             "CREATED: 2007-02-05 10:23:12"
5736    
5737             "MODIFIED: 2007-04-07 12:50:21"
5738    
5739             "."
5740    
5741    6.8.6.  Renaming an instrument directory
5742    
5743       The front-end can alter the name of a specific instrument directory
5744       by sending the following command:
5745    
5746          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5747    
5748       Where <dir> is the absolute path name of the directory and <name> is
5749       the new name for that directory.
5750    
5751       Possible Answers:
5752    
5753          "OK" -
5754    
5755             on success
5756    
5757          "ERR:<error-code>:<error-message>" -
5758    
5759             in case the given directory does not exists, or if a directory
5760             with name equal to the new name already exists.
5761    
5762       Example:
5763    
5764    
5765    
5766    
5767    Schoenebeck               Expires July 13, 2014               [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol         January 2014
5770    
5771    
5772          C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5773          'Acoustic'"
5774    
5775          S: "OK"
5776    
5777    6.8.7.  Moving an instrument directory
5778    
5779       The front-end can move a specific instrument directory by sending the
5780       following command:
5781    
5782          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5783    
5784       Where <dir> is the absolute path name of the directory to move and
5785       <dst> is the location where the directory will be moved to.
5786    
5787       Possible Answers:
5788    
5789          "OK" -
5790    
5791             on success
5792    
5793          "ERR:<error-code>:<error-message>" -
5794    
5795             in case a given directory does not exists, or if a directory
5796             with name equal to the name of the specified directory already
5797             exists in the destination directory.  Error is also thrown when
5798             trying to move a directory to a subdirectory of itself.
5799    
5800       Example:
5801    
5802          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5803          Acoustic'"
5804    
5805          S: "OK"
5806    
5807    6.8.8.  Copying instrument directories
5808    
5809       The front-end can copy a specific instrument directory by sending the
5810       following command:
5811    
5812          COPY DB_INSTRUMENT_DIRECTORY <dir> <dst>
5813    
5814       Where <dir> is the absolute path name of the directory to copy and
5815       <dst> is the location where the directory will be copied to.
5816    
5817       Possible Answers:
5818    
5819    
5820    
5821    
5822    
5823    Schoenebeck               Expires July 13, 2014               [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol         January 2014
5826    
5827    
5828          "OK" -
5829    
5830             on success
5831    
5832          "ERR:<error-code>:<error-message>" -
5833    
5834             in case a given directory does not exists, or if a directory
5835             with name equal to the name of the specified directory already
5836             exists in the destination directory.  Error is also thrown when
5837             trying to copy a directory to a subdirectory of itself.
5838    
5839       Example:
5840    
5841          C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5842          '/Acoustic/Pianos'"
5843    
5844          S: "OK"
5845    
5846    6.8.9.  Changing the description of directory
5847    
5848       The front-end can alter the description of a specific instrument
5849       directory by sending the following command:
5850    
5851          SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5852    
5853       Where <dir> is the absolute path name of the directory and <desc> is
5854       the new description for the directory (encapsulated into apostrophes,
5855       supporting escape sequences as described in chapter "Character Set
5856       and Escape Sequences (Section 7.1)").
5857    
5858       Possible Answers:
5859    
5860          "OK" -
5861    
5862             on success
5863    
5864          "ERR:<error-code>:<error-message>" -
5865    
5866             in case the given directory does not exists.
5867    
5868       Example:
5869    
5870          C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5871          collection of piano instruments in various format.'"
5872    
5873          S: "OK"
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires July 13, 2014               [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol         January 2014
5882    
5883    
5884    6.8.10.  Finding directories
5885    
5886       The front-end can search for directories in specific directory by
5887       sending the following command:
5888    
5889          FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-
5890          list>
5891    
5892       Where <dir> should be replaced by the absolute path name of the
5893       directory to search in.  If NON_RECURSIVE is specified, the
5894       directories located in subdirectories of the specified directory will
5895       not be searched. <criteria-list> is a list of search criterias in
5896       form of "key1=val1 key2=val2 ...".  The following criterias are
5897       allowed:
5898    
5899       NAME='<search-string>'
5900    
5901          Restricts the search to directories, which names satisfy the
5902          supplied search string (encapsulated into apostrophes, supporting
5903          escape sequences as described in chapter "Character Set and Escape
5904          Sequences (Section 7.1)").
5905    
5906       CREATED='[<date-after>]..[<date-before>]'
5907    
5908          Restricts the search to directories, which creation date satisfies
5909          the specified period, where <date-after> and <date-before> are in
5910          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5911          search is restricted to directories created before <date-before>.
5912          If <date-before> is omitted, the search is restricted to
5913          directories created after <date-after>.
5914    
5915       MODIFIED='[<date-after>]..[<date-before>]'
5916    
5917          Restricts the search to directories, which date of last
5918          modification satisfies the specified period, where <date-after>
5919          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5920          after> is omitted the search is restricted to directories, which
5921          are last modified before <date-before>.  If <date-before> is
5922          omitted, the search is restricted to directories, which are last
5923          modified after <date-after>.
5924    
5925       DESCRIPTION='<search-string>'
5926    
5927          Restricts the search to directories with description that
5928          satisfies the supplied search string (encapsulated into
5929          apostrophes, supporting escape sequences as described in chapter
5930          "Character Set and Escape Sequences (Section 7.1)").
5931    
5932    
5933    
5934    
5935    Schoenebeck               Expires July 13, 2014               [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol         January 2014
5938    
5939    
5940       Where <search-string> is either a regular expression, or a word list
5941       separated with spaces for OR search and with '+' for AND search.
5942    
5943       Possible Answers:
5944    
5945          A comma separated list with the absolute path names (encapsulated
5946          into apostrophes) of all directories in the specified directory
5947          that satisfy the supplied search criterias.
5948    
5949          "ERR:<error-code>:<error-message>" -
5950    
5951             if the given directory does not exist.
5952    
5953       Example:
5954    
5955          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5956    
5957          S: "'/Piano Collection'"
5958    
5959          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5960          30:13'"
5961    
5962          S: "'/Piano Collection','/Percussions'"
5963    
5964    6.8.11.  Adding instruments to the instruments database
5965    
5966       The front-end can add one or more instruments to the instruments
5967       database by sending the following command:
5968    
5969          ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir>
5970          <file_path> [<instr_index>]
5971    
5972       Where <db_dir> is the absolute path name of a directory (encapsulated
5973       into apostrophes) in the instruments database in which only the new
5974       instruments (that are not already in the database) will be added,
5975       <file_path> is the absolute path name of a file or directory in the
5976       file system (encapsulated into apostrophes).  In case an instrument
5977       file is supplied, only the instruments in the specified file will be
5978       added to the instruments database.  If the optional <instr_index>
5979       (the index of the instrument within the given file) is supplied too,
5980       then only the specified instrument will be added.  In case a
5981       directory is supplied, the instruments in that directory will be
5982       added.  The OPTIONAL <mode> argument is only applied when a directory
5983       is provided as <file_path> and specifies how the scanning will be
5984       done and has exactly the following possibilities:
5985    
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck               Expires July 13, 2014               [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol         January 2014
5994    
5995    
5996          "RECURSIVE" -
5997    
5998             All instruments will be processed, including those in the
5999             subdirectories, and the respective subdirectory tree structure
6000             will be recreated in the instruments database
6001    
6002          "NON_RECURSIVE" -
6003    
6004             Only the instruments in the specified directory will be added,
6005             the instruments in the subdirectories will not be processed.
6006    
6007          "FLAT" -
6008    
6009             All instruments will be processed, including those in the
6010             subdirectories, but the respective subdirectory structure will
6011             not be recreated in the instruments database.  All instruments
6012             will be added directly in the specified database directory.
6013    
6014       If FILE_AS_DIR argument is supplied, all instruments in an instrument
6015       file will be added to a separate directory in the instruments
6016       database, which name will be the name of the instrument file with the
6017       file extension stripped off.
6018    
6019       The difference between regular and NON_MODAL versions of the command
6020       is that the regular command returns when the scanning is finished
6021       while NON_MODAL version returns immediately and a background process
6022       is launched.  The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
6023       command can be used to monitor the scanning progress.
6024    
6025       Possible Answers:
6026    
6027          "OK" -
6028    
6029             on success when NON_MODAL is not supplied
6030    
6031          "OK[<job-id>]" -
6032    
6033             on success when NON_MODAL is supplied, where <job-id> is a
6034             numerical ID used to obtain status information about the job
6035             progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
6036    
6037          "ERR:<error-code>:<error-message>" -
6038    
6039             if an invalid path is specified.
6040    
6041       Examples:
6042    
6043    
6044    
6045    
6046    
6047    Schoenebeck               Expires July 13, 2014               [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol         January 2014
6050    
6051    
6052          C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
6053          Bosendorfer 290.gig' 0"
6054    
6055          S: "OK"
6056    
6057    6.8.12.  Removing an instrument
6058    
6059       The front-end can remove a particular instrument from the instruments
6060       database by sending the following command:
6061    
6062          REMOVE DB_INSTRUMENT <instr_path>
6063    
6064       Where <instr_path> is the absolute path name (in the instruments
6065       database) of the instrument to remove.
6066    
6067       Possible Answers:
6068    
6069          "OK" -
6070    
6071             if the instrument is removed successfully
6072    
6073          "ERR:<error-code>:<error-message>" -
6074    
6075             if the given path does not exist or is a directory.
6076    
6077       Examples:
6078    
6079          C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
6080    
6081          S: "OK"
6082    
6083    6.8.13.  Getting amount of instruments
6084    
6085       The front-end can retrieve the current amount of instruments in a
6086       specific directory by sending the following command:
6087    
6088          GET DB_INSTRUMENTS [RECURSIVE] <dir>
6089    
6090       Where <dir> should be replaced by the absolute path name of the
6091       directory.  If RECURSIVE is specified, the number of all instruments,
6092       including those located in subdirectories of the specified directory,
6093       will be returned.
6094    
6095       Possible Answers:
6096    
6097          The current number of instruments in the specified directory.
6098    
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires July 13, 2014               [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol         January 2014
6106    
6107    
6108          "ERR:<error-code>:<error-message>" -
6109    
6110             if the given directory does not exist.
6111    
6112       Example:
6113    
6114          C: "GET DB_INSTRUMENTS '/Piano Collection'"
6115    
6116          S: "2"
6117    
6118    6.8.14.  Listing all instruments in specific directory
6119    
6120       The front-end can retrieve the current list of instruments in
6121       specific directory by sending the following command:
6122    
6123          LIST DB_INSTRUMENTS [RECURSIVE] <dir>
6124    
6125       Where <dir> should be replaced by the absolute path name of the
6126       directory.  If RECURSIVE is specified, the absolute path names of all
6127       instruments, including those located in subdirectories of the
6128       specified directory, will be returned.
6129    
6130       Possible Answers:
6131    
6132          A comma separated list of all instruments (encapsulated into
6133          apostrophes) in the specified directory.
6134    
6135          "ERR:<error-code>:<error-message>" -
6136    
6137             if the given directory does not exist.
6138    
6139       Example:
6140    
6141          C: "LIST DB_INSTRUMENTS '/Piano Collection'"
6142    
6143          S: "'Bosendorfer 290','Steinway D'"
6144    
6145          C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
6146    
6147          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
6148          Steinway D','/Piano Collection/Lite/Free Piano'"
6149    
6150    6.8.15.  Getting instrument information
6151    
6152       The front-end can ask for the current settings of an instrument by
6153       sending the following command:
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck               Expires July 13, 2014               [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol         January 2014
6162    
6163    
6164          GET DB_INSTRUMENT INFO <instr_path>
6165    
6166       Where <instr_path> should be replaced by the absolute path name of
6167       the instrument the front-end is interested in.
6168    
6169       Possible Answers:
6170    
6171          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6172          answer line begins with the settings category name followed by a
6173          colon and then a space character <SP> and finally the info
6174          character string to that setting category.  At the moment the
6175          following categories are defined:
6176    
6177    
6178    
6179             INSTRUMENT_FILE -
6180    
6181                File name of the instrument.  Note that the character string
6182                may contain escape sequences (Section 7.1).
6183    
6184             INSTRUMENT_NR -
6185    
6186                Index of the instrument within the file.
6187    
6188             FORMAT_FAMILY -
6189    
6190                The format family of the instrument.
6191    
6192             FORMAT_VERSION -
6193    
6194                The format version of the instrument.
6195    
6196             SIZE -
6197    
6198                The size of the instrument in bytes.
6199    
6200             CREATED -
6201    
6202                The date and time when the instrument is added in the
6203                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
6204                format
6205    
6206             MODIFIED -
6207    
6208                The date and time of the last modification of the
6209                instrument's database settings, represented in "YYYY-MM-DD
6210                HH:MM:SS" format
6211    
6212    
6213    
6214    
6215    Schoenebeck               Expires July 13, 2014               [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol         January 2014
6218    
6219    
6220             DESCRIPTION -
6221    
6222                A brief description of the instrument.  Note that the
6223                character string may contain escape sequences (Section 7.1).
6224    
6225             IS_DRUM -
6226    
6227                either true or false, determines whether the instrument is a
6228                drumkit or a chromatic instrument
6229    
6230             PRODUCT -
6231    
6232                The product title of the instrument.  Note that the
6233                character string may contain escape sequences (Section 7.1).
6234    
6235             ARTISTS -
6236    
6237                Lists the artist names.  Note that the character string may
6238                contain escape sequences (Section 7.1).
6239    
6240             KEYWORDS -
6241    
6242                Provides a list of keywords that refer to the instrument.
6243                Keywords are separated with semicolon and blank.  Note that
6244                the character string may contain escape sequences
6245                (Section 7.1).
6246    
6247       The mentioned fields above don't have to be in particular order.
6248    
6249       Example:
6250    
6251          C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
6252    
6253          S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
6254    
6255             "INSTRUMENT_NR: 0"
6256    
6257             "FORMAT_FAMILY: GIG"
6258    
6259             "FORMAT_VERSION: 2"
6260    
6261             "SIZE: 2050871870"
6262    
6263             "CREATED: 2007-02-05 10:23:12"
6264    
6265             "MODIFIED: 2007-04-07 12:50:21"
6266    
6267    
6268    
6269    
6270    
6271    Schoenebeck               Expires July 13, 2014               [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol         January 2014
6274    
6275    
6276             "DESCRIPTION: "
6277    
6278             "IS_DRUM: false"
6279    
6280             "PRODUCT: GRANDIOSO Bosendorfer 290"
6281    
6282             "ARTISTS: Post Musical Instruments"
6283    
6284             "KEYWORDS: Bosendorfer"
6285    
6286             "."
6287    
6288    6.8.16.  Renaming an instrument
6289    
6290       The front-end can alter the name of a specific instrument by sending
6291       the following command:
6292    
6293          SET DB_INSTRUMENT NAME <instr> <name>
6294    
6295       Where <instr> is the absolute path name of the instrument and <name>
6296       is the new name for that instrument.
6297    
6298       Possible Answers:
6299    
6300          "OK" -
6301    
6302             on success
6303    
6304          "ERR:<error-code>:<error-message>" -
6305    
6306             in case the given instrument does not exists, or if an
6307             instrument with name equal to the new name already exists.
6308    
6309       Example:
6310    
6311          C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
6312          'Bosendorfer 290'"
6313    
6314          S: "OK"
6315    
6316    6.8.17.  Moving an instrument
6317    
6318       The front-end can move a specific instrument to another directory by
6319       sending the following command:
6320    
6321          MOVE DB_INSTRUMENT <instr> <dst>
6322    
6323       Where <instr> is the absolute path name of the instrument to move and
6324    
6325    
6326    
6327    Schoenebeck               Expires July 13, 2014               [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol         January 2014
6330    
6331    
6332       <dst> is the directory where the instrument will be moved to.
6333    
6334       Possible Answers:
6335    
6336          "OK" -
6337    
6338             on success
6339    
6340          "ERR:<error-code>:<error-message>" -
6341    
6342             in case the given instrument does not exists, or if an
6343             instrument with name equal to the name of the specified
6344             instrument already exists in the destination directory.
6345    
6346       Example:
6347    
6348          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
6349          Collection/Acoustic'"
6350    
6351          S: "OK"
6352    
6353    6.8.18.  Copying instruments
6354    
6355       The front-end can copy a specific instrument to another directory by
6356       sending the following command:
6357    
6358          COPY DB_INSTRUMENT <instr> <dst>
6359    
6360       Where <instr> is the absolute path name of the instrument to copy and
6361       <dst> is the directory where the instrument will be copied to.
6362    
6363       Possible Answers:
6364    
6365          "OK" -
6366    
6367             on success
6368    
6369          "ERR:<error-code>:<error-message>" -
6370    
6371             in case the given instrument does not exists, or if an
6372             instrument with name equal to the name of the specified
6373             instrument already exists in the destination directory.
6374    
6375       Example:
6376    
6377          C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
6378          '/Acoustic/Pianos/'"
6379    
6380    
6381    
6382    
6383    Schoenebeck               Expires July 13, 2014               [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol         January 2014
6386    
6387    
6388          S: "OK"
6389    
6390    6.8.19.  Changing the description of instrument
6391    
6392       The front-end can alter the description of a specific instrument by
6393       sending the following command:
6394    
6395          SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
6396    
6397       Where <instr> is the absolute path name of the instrument and <desc>
6398       is the new description for the instrument (encapsulated into
6399       apostrophes, supporting escape sequences as described in chapter
6400       "Character Set and Escape Sequences (Section 7.1)").
6401    
6402       Possible Answers:
6403    
6404          "OK" -
6405    
6406             on success
6407    
6408          "ERR:<error-code>:<error-message>" -
6409    
6410             in case the given instrument does not exists.
6411    
6412       Example:
6413    
6414          C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
6415          Bosendorfer 290' 'No comment :)'"
6416    
6417          S: "OK"
6418    
6419    6.8.20.  Finding instruments
6420    
6421       The front-end can search for instruments in specific directory by
6422       sending the following command:
6423    
6424          FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
6425    
6426       Where <dir> should be replaced by the absolute path name of the
6427       directory to search in.  If NON_RECURSIVE is specified, the
6428       directories located in subdirectories of the specified directory will
6429       not be searched. <criteria-list> is a list of search criterias in
6430       form of "key1=val1 key2=val2 ...".  The following criterias are
6431       allowed:
6432    
6433       NAME='<search-string>'
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck               Expires July 13, 2014               [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol         January 2014
6442    
6443    
6444          Restricts the search to instruments, which names satisfy the
6445          supplied search string (encapsulated into apostrophes, supporting
6446          escape sequences as described in chapter "Character Set and Escape
6447          Sequences (Section 7.1)").
6448    
6449       SIZE=[<min>]..[<max>]
6450    
6451          Restricts the search to instruments, which size is in the
6452          specified range.  If <min> is omitted, the search results are
6453          restricted to instruments with size less then or equal to <max>.
6454          If <max> is omitted, the search is restricted to instruments with
6455          size greater then or equal to <min>.
6456    
6457       CREATED='[<date-after>]..[<date-before>]'
6458    
6459          Restricts the search to instruments, which creation date satisfies
6460          the specified period, where <date-after> and <date-before> are in
6461          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
6462          search is restricted to instruments created before <date-before>.
6463          If <date-before> is omitted, the search is restricted to
6464          instruments created after <date-after>.
6465    
6466       MODIFIED='[<date-after>]..[<date-before>]'
6467    
6468          Restricts the search to instruments, which date of last
6469          modification satisfies the specified period, where <date-after>
6470          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
6471          after> is omitted the search is restricted to instruments, which
6472          are last modified before <date-before>.  If <date-before> is
6473          omitted, the search is restricted to instruments, which are last
6474          modified after <date-after>.
6475    
6476       DESCRIPTION='<search-string>'
6477    
6478          Restricts the search to instruments with description that
6479          satisfies the supplied search string (encapsulated into
6480          apostrophes, supporting escape sequences as described in chapter
6481          "Character Set and Escape Sequences (Section 7.1)").
6482    
6483       PRODUCT='<search-string>'
6484    
6485          Restricts the search to instruments with product info that
6486          satisfies the supplied search string (encapsulated into
6487          apostrophes, supporting escape sequences as described in chapter
6488          "Character Set and Escape Sequences (Section 7.1)").
6489    
6490       ARTISTS='<search-string>'
6491    
6492    
6493    
6494    
6495    Schoenebeck               Expires July 13, 2014               [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol         January 2014
6498    
6499    
6500          Restricts the search to instruments with artists info that
6501          satisfies the supplied search string (encapsulated into
6502          apostrophes, supporting escape sequences as described in chapter
6503          "Character Set and Escape Sequences (Section 7.1)").
6504    
6505       KEYWORDS='<search-string>'
6506    
6507          Restricts the search to instruments with keyword list that
6508          satisfies the supplied search string (encapsulated into
6509          apostrophes, supporting escape sequences as described in chapter
6510          "Character Set and Escape Sequences (Section 7.1)").
6511    
6512       IS_DRUM=true | false
6513    
6514          Either true or false.  Restricts the search to drum kits or
6515          chromatic instruments.
6516    
6517       FORMAT_FAMILIES='<format-list>'
6518    
6519          Restricts the search to instruments of the supplied format
6520          families, where <format-list> is a comma separated list of format
6521          families.
6522    
6523       Where <search-string> is either a regular expression, or a word list
6524       separated with spaces for OR search and with '+' for AND search.
6525    
6526       Possible Answers:
6527    
6528          A comma separated list with the absolute path names (encapsulated
6529          into apostrophes) of all instruments in the specified directory
6530          that satisfy the supplied search criterias.
6531    
6532          "ERR:<error-code>:<error-message>" -
6533    
6534             if the given directory does not exist.
6535    
6536       Example:
6537    
6538          C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
6539          290'"
6540    
6541          S: "'/Piano Collection/Bosendorfer 290'"
6542    
6543          C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
6544          09:30:13..'"
6545    
6546          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
6547          Steinway D'"
6548    
6549    
6550    
6551    Schoenebeck               Expires July 13, 2014               [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol         January 2014
6554    
6555    
6556    6.8.21.  Getting job status information
6557    
6558       The front-end can ask for the current status of a particular database
6559       instruments job by sending the following command:
6560    
6561          GET DB_INSTRUMENTS_JOB INFO <job-id>
6562    
6563       Where <job-id> should be replaced by the numerical ID of the job the
6564       front-end is interested in.
6565    
6566       Possible Answers:
6567    
6568          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6569          answer line begins with the settings category name followed by a
6570          colon and then a space character <SP> and finally the info
6571          character string to that setting category.  At the moment the
6572          following categories are defined:
6573    
6574    
6575    
6576             FILES_TOTAL -
6577    
6578                The total number of files scheduled for scanning
6579    
6580             FILES_SCANNED -
6581    
6582                The current number of scanned files
6583    
6584             SCANNING -
6585    
6586                The absolute path name of the file which is currently being
6587                scanned
6588    
6589             STATUS -
6590    
6591                An integer value between 0 and 100 indicating the scanning
6592                progress percentage of the file which is currently being
6593                scanned
6594    
6595       The mentioned fields above don't have to be in particular order.
6596    
6597       Example:
6598    
6599          C: "GET DB_INSTRUMENTS_JOB INFO 2"
6600    
6601          S: "FILES_TOTAL: 12"
6602    
6603    
6604    
6605    
6606    
6607    Schoenebeck               Expires July 13, 2014               [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol         January 2014
6610    
6611    
6612             "FILES_SCANNED: 7"
6613    
6614             "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
6615    
6616             "STATUS: 42"
6617    
6618             "."
6619    
6620    6.8.22.  Formatting the instruments database
6621    
6622       The front-end can remove all instruments and directories and re-
6623       create the instruments database structure (e.g., in case of a
6624       database corruption) by sending the following command:
6625    
6626          FORMAT INSTRUMENTS_DB
6627    
6628       Possible Answers:
6629    
6630          "OK" -
6631    
6632             on success
6633    
6634          "ERR:<error-code>:<error-message>" -
6635    
6636             If the formatting of the instruments database failed.
6637    
6638    6.8.23.  Checking for lost instrument files
6639    
6640       The front-end can retrieve the list of all instrument files in the
6641       instruments database that don't exist in the filesystem by sending
6642       the following command:
6643    
6644          FIND LOST DB_INSTRUMENT_FILES
6645    
6646       Possible Answers:
6647    
6648          A comma separated list with the absolute path names (encapsulated
6649          into apostrophes) of all lost instrument files.
6650    
6651          "ERR:<error-code>:<error-message>" -
6652    
6653             in case it failed, providing an appropriate error code and
6654             error message.
6655    
6656       Example:
6657    
6658    
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires July 13, 2014               [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol         January 2014
6666    
6667    
6668          C: "FIND LOST DB_INSTRUMENT_FILES"
6669    
6670          S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
6671          Piano.gig'"
6672    
6673    6.8.24.  Replacing an instrument file
6674    
6675       The front-end can substitute all occurrences of an instrument file in
6676       the instruments database with a new one by sending the following
6677       command:
6678    
6679          SET DB_INSTRUMENT FILE_PATH <old_path> <new_path>
6680    
6681       Where <old_path> is the absolute path name of the instrument file to
6682       substitute with <new_path>.
6683    
6684       Possible Answers:
6685    
6686          "OK" -
6687    
6688             on success
6689    
6690          "ERR:<error-code>:<error-message>" -
6691    
6692             in case it failed, providing an appropriate error code and
6693             error message.
6694    
6695       Example:
6696    
6697          C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig'
6698          '/gigs/pianos/Bosendorfer 290.gig'"
6699    
6700          S: "OK"
6701    
6702    6.9.  Editing Instruments
6703    
6704       The sampler allows to edit instruments while playing with the sampler
6705       by spawning an external (3rd party) instrument editor application for
6706       a given instrument.  The 3rd party instrument editor applications
6707       have to place a respective plugin DLL file into the sampler's plugins
6708       directory.  The sampler will automatically try to load all plugin
6709       DLLs in that directory on startup and only on startup!
6710    
6711       At the moment there is only one command for this feature set, but
6712       this will most probably change in future.
6713    
6714    
6715    
6716    
6717    
6718    
6719    Schoenebeck               Expires July 13, 2014               [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol         January 2014
6722    
6723    
6724    6.9.1.  Opening an appropriate instrument editor application
6725    
6726       The front-end can request to open an appropriate instrument editor
6727       application by sending the following command:
6728    
6729          EDIT CHANNEL INSTRUMENT <sampler-channel>
6730    
6731       Where <sampler-channel> should be replaced by the number of the
6732       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
6733       "LIST CHANNELS" (Section 6.4.4) command.
6734    
6735       The sampler will try to ask all registered instrument editors (or to
6736       be more specific: their sampler plugins) whether they are capable to
6737       handle the instrument on the given sampler channel.  The sampler will
6738       simply use the first instrument editor application which replied with
6739       a positive answer and spawn that instrument editor application within
6740       the sampler's process and provide that application access to the
6741       instrument's data structures, so both applications can share and
6742       access the same instruments data at the same time, thus allowing to
6743       immediately hear changes with the sampler made by the instrument
6744       editor.
6745    
6746       Note: consequently instrument editors are always spawned locally on
6747       the same machine where the sampler is running on!
6748    
6749       Possible Answers:
6750    
6751          "OK" -
6752    
6753             when an appropriate instrument editor was launched
6754    
6755          "WRN:<warning-code>:<warning-message>" -
6756    
6757  Schoenebeck               Expires July 2, 2007                 [Page 82]           when an appropriate instrument editor was launched, but there
6758             are noteworthy issues
6759    
6760          "ERR:<error-code>:<error-message>" -
6761    
6762             when an appropriate instrument editor could not be launched
6763    
6764       Examples:
6765    
6766          C: "EDIT CHANNEL INSTRUMENT 0"
6767    
6768          S: "OK"
6769    
6770    
6771    
6772    
6773    
6774    
6775    Schoenebeck               Expires July 13, 2014               [Page 121]
6776    
6777  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
6778    
6779    
6780    6.10.  Managing Files
6781    
6782       You can query detailed informations about files located at the same
6783       system where the sampler instance is running on.  Using this command
6784       set allows to retrieve file informations even remotely from another
6785       machine.
6786    
6787    6.10.1.  Retrieving amount of instruments of a file
6788    
6789       The front-end can retrieve the amount of instruments within a given
6790       instrument file by sending the following command:
6791    
6792          GET FILE INSTRUMENTS <filename>
6793    
6794       Where <filename> is the name of the instrument file (encapsulated
6795       into apostrophes, supporting escape sequences as described in chapter
6796       "Character Set and Escape Sequences (Section 7.1)").
6797    
6798       The sampler will try to ask all sampler engines, whether they support
6799       the given file and ask the first engine with a positive answer for
6800       the amount of instruments.
6801    
6802       Possible Answers:
6803    
6804          On success, the sampler will answer by returning the amount of
6805          instruments.
6806    
6807          "ERR:<error-code>:<error-message>" -
6808    
6809             if the file could not be handled
6810    
6811       Examples:
6812    
6813          C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6814    
6815          S: "10"
6816    
6817    6.10.2.  Retrieving all instruments of a file
6818    
6819       The front-end can retrieve a list of all instruments within a given
6820       instrument file by sending the following command:
6821    
6822          LIST FILE INSTRUMENTS <filename>
6823    
6824       Where <filename> is the name of the instrument file (encapsulated
6825       into apostrophes, supporting escape sequences as described in chapter
6826       "Character Set and Escape Sequences (Section 7.1)").
6827    
6828    
6829    
6830    
6831    Schoenebeck               Expires July 13, 2014               [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol         January 2014
6834    
6835    
6836       The sampler will try to ask all sampler engines, whether they support
6837       the given file and ask the first engine with a positive answer for a
6838       list of IDs for the instruments in the given file.
6839    
6840       Possible Answers:
6841    
6842          On success, the sampler will answer by returning a comma separated
6843          list of instrument IDs.
6844    
6845          "ERR:<error-code>:<error-message>" -
6846    
6847             if the file could not be handled
6848    
6849       Examples:
6850    
6851          C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6852    
6853          S: "0,1,2,3,4,5,6,7,8,9"
6854    
6855    6.10.3.  Retrieving informations about one instrument in a file
6856    
6857       The front-end can retrieve detailed informations about a specific
6858       instrument within a given instrument file by sending the following
6859       command:
6860    
6861          GET FILE INSTRUMENT INFO <filename> <instr-id>
6862    
6863       Where <filename> is the name of the instrument file (encapsulated
6864       into apostrophes, supporting escape sequences as described in chapter
6865       "Character Set and Escape Sequences (Section 7.1)") and <instr-id> is
6866       the numeric instrument ID as returned by the "LIST FILE INSTRUMENTS"
6867       (Section 6.10.2) command.
6868    
6869       The sampler will try to ask all sampler engines, whether they support
6870       the given file and ask the first engine with a positive answer for
6871       informations about the specific instrument in the given file.
6872    
6873       Possible Answers:
6874    
6875          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6876          answer line begins with the settings category name followed by a
6877          colon and then a space character <SP> and finally the info
6878          character string to that setting category.  At the moment the
6879          following categories are defined:
6880    
6881    
6882    
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires July 13, 2014               [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol         January 2014
6890    
6891    
6892             NAME -
6893    
6894                name of the instrument as stored in the instrument file
6895    
6896             FORMAT_FAMILY -
6897    
6898                name of the sampler format of the given instrument
6899    
6900             FORMAT_VERSION -
6901    
6902                version of the sampler format the instrumen is stored as
6903    
6904             PRODUCT -
6905    
6906                official product name of the instrument as stored in the
6907                file
6908    
6909             ARTISTS -
6910    
6911                artists / sample library vendor of the instrument
6912    
6913             KEY_BINDINGS -
6914    
6915                comma separated list of integer values representing the
6916                instrument's key mapping in the range between 0 .. 127,
6917                reflecting the analog meaning of the MIDI specification.
6918    
6919             KEYSWITCH_BINDINGS -
6920    
6921                comma separated list of integer values representing the
6922                instrument's keyswitch mapping in the range between 0 ..
6923                127, reflecting the analog meaning of the MIDI
6924                specification.
6925    
6926       The mentioned fields above don't have to be in particular order.
6927    
6928       Example:
6929    
6930          C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
6931    
6932          S: "NAME: Lunatic Loops"
6933    
6934             "FORMAT_FAMILY: GIG"
6935    
6936             "FORMAT_VERSION: 3"
6937    
6938             "PRODUCT: The Backbone Bongo Beats"
6939    
6940    
6941    
6942    
6943    Schoenebeck               Expires July 13, 2014               [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol         January 2014
6946    
6947    
6948             "ARTISTS: Jimmy the Fish"
6949    
6950             "."
6951    
6952    6.11.  Managing Effects
6953    
6954       Audio effects (e.g. reverb, delay, compression) can be applied to the
6955       audio signals generated by the sampler.  The sampler usually provides
6956       a set of internal audio effects for this task.  The exact set of
6957       effects depends on the availability of third party effect plugins
6958       installed on the system where the sampler runs on.
6959    
6960       At the moment only "send effects" are supported.  Support for "insert
6961       effects" and "master effects" is planned to be added at a later
6962       point.
6963    
6964       The following commands allow to retrieve the set of internal effects
6965       available to the sampler, detailed informations about those effects
6966       and to create and destroy instances of such effects.  After an
6967       instance of an effect is created, the effect instance can be inserted
6968       into the audio signal path of the sampler, e.g. as send effect.
6969    
6970       The sampler allows to create an arbitrary amount of so called send
6971       effect chains.  Each effect chain can host an arbitrary amount of
6972       effect instances.  The output of the first effect instance in an
6973       effect chain is fed to the input of the second effect instance of the
6974       chain and so on.  So effects in one chain are processed sequentially.
6975       Send effect chains however are processed in parallel to other send
6976       effect chains.  Audio signals of sampler channels are fed to send
6977       effects by creating FX sends to the respective sampler channel and
6978       assigning a destination send effect to that FX by using the "SET
6979       FX_SEND EFFECT" (Section 6.4.35) command.  The latter allows to route
6980       the FX send to the beginning of a send effect chain, as well as
6981       directly to any other position of the send effect chain.
6982    
6983    6.11.1.  Retrieve amount of available effects
6984    
6985       The front-end can retrieve the amount of internal effects, available
6986       to the sampler by sending the following command:
6987    
6988          GET AVAILABLE_EFFECTS
6989    
6990       Possible Answers:
6991    
6992          The sampler will answer by returning the current number of effects
6993          available to the sampler.
6994    
6995       Examples:
6996    
6997    
6998    
6999    Schoenebeck               Expires July 13, 2014               [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol         January 2014
7002    
7003    
7004          C: "GET AVAILABLE_EFFECTS"
7005    
7006          S: "129"
7007    
7008    6.11.2.  Get list of available effects
7009    
7010       The set of available internal effects can change at runtime.  The
7011       front-end can retrieve the list of internal effects, available to the
7012       sampler by sending the following command:
7013    
7014          LIST AVAILABLE_EFFECTS
7015    
7016       Possible Answers:
7017    
7018          The sampler will answer by returning a comma separated list with
7019          numerical IDs of effects.  Note: the numercial ID of an effect is
7020          generated by the sampler for the current moment.  The numerical ID
7021          of the same effect can change at runtime, e.g. when the user
7022          requests a rescan of available effect plugins.
7023    
7024       Example:
7025    
7026          C: "LIST AVAILABLE_EFFECTS"
7027    
7028          S: "5,6,7,120,121,122,123,124"
7029    
7030    6.11.3.  Retrieving general information about an effect
7031    
7032       The front-end can ask for general informations about an effect by
7033       sending the following command:
7034    
7035          GET EFFECT INFO <effect-index>
7036    
7037       Where <effect-index> is the numerical ID of an effect as returned by
7038       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
7039    
7040       Possible Answers:
7041    
7042          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7043          answer line begins with the effect information category name,
7044          followed by a colon and then a space character <SP> and finally
7045          the info character string to that effect information category.  At
7046          the moment the following categories are defined:
7047    
7048    
7049    
7050             SYSTEM -
7051    
7052    
7053    
7054    
7055    Schoenebeck               Expires July 13, 2014               [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol         January 2014
7058    
7059    
7060                name of the effect plugin system the effect is based on
7061                (e.g.  "LADSPA")
7062    
7063             MODULE -
7064    
7065                module of the effect plugin system that contains this
7066                effect, the module is usually the dynamic-linked library
7067                (DLL) filename of the effect plugin, including full path
7068                (note that this filename may contain escape sequences
7069                (Section 7.1))
7070    
7071             NAME -
7072    
7073                character string defining the unique name of the effect
7074                within its module (note that the character string may
7075                contain escape sequences (Section 7.1))
7076    
7077             DESCRIPTION -
7078    
7079                human readable name of the effect, intended to be displayed
7080                in user interfaces (note that the character string may
7081                contain escape sequences (Section 7.1))
7082    
7083       The mentioned fields above don't have to be in particular order.
7084    
7085       Example:
7086    
7087          C: "GET EFFECT INFO 121"
7088    
7089          S: "SYSTEM: LADSPA"
7090    
7091             "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"
7092    
7093             "NAME: lowpass_iir"
7094    
7095             "DESCRIPTION: Glame Lowpass Filter"
7096    
7097             "."
7098    
7099    6.11.4.  Creating an instance of an effect by its portable ID
7100    
7101       The front-end can spawn an instance of the desired effect by sending
7102       the following command:
7103    
7104          CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name>
7105    
7106       Where <effect-system> is the "SYSTEM" field, <module> the "MODULE"
7107       field and <effect-name> the "NAME" field as returned by the "GET
7108    
7109    
7110    
7111    Schoenebeck               Expires July 13, 2014               [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol         January 2014
7114    
7115    
7116       EFFECT INFO" (Section 6.11.3) command.  The filename of argument
7117       <module> and the character string of argument <effect-name> may
7118       contain escape sequences (Section 7.1).
7119    
7120       The sampler will try to load the requested effect and to create an
7121       instance of it.  To allow loading the same effect on a different
7122       machine, probably even running a completely different operating
7123       system (e.g.  Linux vs. Windows), the sampler tries to match <module>
7124       "softly".  That means it first tries to find an effect that exactly
7125       matches the given <module> argument.  If there is no exact match, the
7126       sampler will try to lower the restrictions on matching the <module>
7127       argument more and more, e.g. by ignoring upper / lower case
7128       differences and by ignoring the path of the DLL filename and file
7129       extension.  If there is still no match at the end, the sampler will
7130       try to ignore the <module> argument completely and as a last resort
7131       search for an effect that only matches the given <effect-system> and
7132       <effect-name> arguments.
7133    
7134       Possible Answers:
7135    
7136          "OK[<effect-instance>]" -
7137    
7138             in case the effect instance was successfully created, where
7139             <effect-instance> is the numerical ID of the new effect
7140             instance
7141    
7142          "WRN:<warning-code>:<warning-message>" -
7143    
7144             in case the effect instance was spawned successfully, but there
7145             are noteworthy issue(s) related, providing an appropriate
7146             warning code and warning message
7147    
7148          "ERR:<error-code>:<error-message>" -
7149    
7150             if the effect could not be instantiated
7151    
7152       Examples:
7153    
7154          C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/
7155          mod_delay_1419.so' 'modDelay'"
7156    
7157          S: "OK[0]"
7158    
7159    6.11.5.  Creating an instance of an effect by its numerical ID
7160    
7161       The front-end can spawn an instance of the desired effect by sending
7162       the following command:
7163    
7164    
7165    
7166    
7167    Schoenebeck               Expires July 13, 2014               [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol         January 2014
7170    
7171    
7172          CREATE EFFECT_INSTANCE <effect-index>
7173    
7174       Where <effect-index> is the numerical ID of the effect as returned by
7175       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
7176    
7177       The sampler will try to load the requested effect and to create an
7178       instance of it.
7179    
7180       Note: Since the numerical ID of a certain effect can change at any
7181       time, you should not use this command in LSCP files to restore a
7182       certain effect at a later time!  To store a sampler session including
7183       all its effects, use the portable text-based version of "CREATE
7184       EFFECT_INSTANCE" (Section 6.11.4) instead!  This allows to restore a
7185       sampler session with all its effects also on other machines, possibly
7186       even running a completely different operating system (e.g.  Linux vs.
7187       Windows), with different plugin directories or plugin DLL names.
7188    
7189       Possible Answers:
7190    
7191          "OK[<effect-instance>]" -
7192    
7193             in case the effect instance was successfully created, where
7194             <effect-instance> is the numerical ID of the new effect
7195             instance
7196    
7197          "WRN:<warning-code>:<warning-message>" -
7198    
7199             in case the effect instance was spawned successfully, but there
7200             are noteworthy issue(s) related, providing an appropriate
7201             warning code and warning message
7202    
7203          "ERR:<error-code>:<error-message>" -
7204    
7205             if the effect could not be instantiated
7206    
7207       Examples:
7208    
7209          C: "CREATE EFFECT_INSTANCE 72"
7210    
7211          S: "OK[5]"
7212    
7213    6.11.6.  Destroy an effect instance
7214    
7215       The front-end can destroy an unusued effect instance and thus freeing
7216       it from memory by sending the following command:
7217    
7218    
7219    
7220    
7221    
7222    
7223    Schoenebeck               Expires July 13, 2014               [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol         January 2014
7226    
7227    
7228          DESTROY EFFECT_INSTANCE <effect-instance>
7229    
7230       Where <effect-instance> is the numerical ID of the effect instance as
7231       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7232       EFFECT_INSTANCES" (Section 6.11.8) command.
7233    
7234       The effect instance can only be destroyed if it's not used in any
7235       part of the sampler's audio signal path anymore.  If the effect
7236       instance is still in use somewhere, trying to destroy the effect
7237       instance will result in an error message.
7238    
7239       Possible Answers:
7240    
7241          "OK" -
7242    
7243             in case the effect instance was successfully destroyed
7244    
7245          "ERR:<error-code>:<error-message>" -
7246    
7247             in case it failed, providing an appropriate error code and
7248             error message
7249    
7250       Examples:
7251    
7252          C: "DESTROY EFFECT_INSTANCE 5"
7253    
7254          S: "OK"
7255    
7256    6.11.7.  Retrieve amount of effect instances
7257    
7258       The front-end can retrieve the current amount of effect instances by
7259       sending the following command:
7260    
7261          GET EFFECT_INSTANCES
7262    
7263       Possible Answers:
7264    
7265          The sampler will answer by returning the current number of effect
7266          instances created and not yet destroyed in the current sampler
7267          session.
7268    
7269       Examples:
7270    
7271          C: "GET EFFECT_INSTANCES"
7272    
7273          S: "14"
7274    
7275    
7276    
7277    
7278    
7279    Schoenebeck               Expires July 13, 2014               [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol         January 2014
7282    
7283    
7284    6.11.8.  Get list of effect instances
7285    
7286       The front-end can retrieve the current list of effect instances by
7287       sending the following command:
7288    
7289          LIST EFFECT_INSTANCES
7290    
7291       Possible Answers:
7292    
7293          The sampler will answer by returning a comma separated list with
7294          numerical IDs of effects instances.
7295    
7296       Example:
7297    
7298          C: "LIST EFFECT_INSTANCES"
7299    
7300          S: "9,11,14,15,16,17,25"
7301    
7302    6.11.9.  Retrieving current information about an effect instance
7303    
7304       The front-end can ask for the current informations about a particular
7305       effect instance by sending the following command:
7306    
7307          GET EFFECT_INSTANCE INFO <effect-instance>
7308    
7309       Where <effect-instance> is the numerical ID of an effect instance as
7310       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7311       EFFECT_INSTANCES" (Section 6.11.8) command.
7312    
7313       Possible Answers:
7314    
7315          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7316          answer line begins with the information category name, followed by
7317          a colon and then a space character <SP> and finally the info
7318          character string to that information category.  At the moment the
7319          following categories are defined:
7320    
7321    
7322    
7323             SYSTEM -
7324    
7325                name of the effect plugin system the effect is based on
7326                (e.g.  "LADSPA")
7327    
7328             MODULE -
7329    
7330                module of the effect plugin system that contains this
7331                effect, the module is usually the dynamic-linked library
7332    
7333    
7334    
7335    Schoenebeck               Expires July 13, 2014               [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol         January 2014
7338    
7339    
7340                (DLL) filename of the effect plugin, including full path
7341                (note that this filename may contain escape sequences
7342                (Section 7.1))
7343    
7344             NAME -
7345    
7346                character string defining the unique name of the effect
7347                within its module (note that the character string may
7348                contain escape sequences (Section 7.1))
7349    
7350             DESCRIPTION -
7351    
7352                human readable name of the effect, intended to be displayed
7353                in user interfaces (note that the character string may
7354                contain escape sequences (Section 7.1))
7355    
7356             INPUT_CONTROLS -
7357    
7358                amount of input controls the effect instance provides, to
7359                allow controlling the effect parameters in realtime
7360    
7361       The mentioned fields above don't have to be in particular order.
7362    
7363       Example:
7364    
7365          C: "GET EFFECT_INSTANCE INFO 3"
7366    
7367          S: "SYSTEM: LADSPA"
7368    
7369             "MODULE: /usr/lib/ladspa/mod_delay_1419.so"
7370    
7371             "NAME: modDelay"
7372    
7373             "DESCRIPTION: Modulatable delay"
7374    
7375             "INPUT_CONTROLS: 1"
7376    
7377             "."
7378    
7379    6.11.10.  Retrieving information about an effect parameter
7380    
7381       Effects typically provide a certain set of effect parameters which
7382       can be altered by the user in realtime (e.g. depth of a reverb
7383       effect, duration of a delay effect, dry / wet signal ratio).  Those
7384       controllable effect parameters are called "input controls".  The
7385       front-end can ask for the current informations of an effect
7386       instance's input control by sending the following command:
7387    
7388    
7389    
7390    
7391    Schoenebeck               Expires July 13, 2014               [Page 132]
7392    
7393    Internet-Draft        LinuxSampler Control Protocol         January 2014
7394    
7395    
7396          GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-
7397          control>
7398    
7399       Where <effect-instance> is the numerical ID of an effect instance as
7400       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7401       EFFECT_INSTANCES" (Section 6.11.8) command and <input-control> is the
7402       index of the input control within the numerical bounds as returned by
7403       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7404       (Section 6.11.9) command.
7405    
7406       Possible Answers:
7407    
7408          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7409          answer line begins with the information category name, followed by
7410          a colon and then a space character <SP> and finally the info
7411          character string to that information category.  There are
7412          information categories which are always returned, independent of
7413          the respective effect parameter and there are optional information
7414          categories which are only shown for certain effect parameters.  At
7415          the moment the following categories are defined:
7416    
7417    
7418    
7419             DESCRIPTION -
7420    
7421                (always returned) human readable name of the effect
7422                parameter, intended to be displayed in user interfaces (note
7423                that the character string may contain escape sequences
7424                (Section 7.1))
7425    
7426             VALUE -
7427    
7428                (always returned) current (optional dotted) floating point
7429                value of this effect parameter
7430    
7431             RANGE_MIN -
7432    
7433                (optionally returned) minimum allowed value for this effect
7434                parameter
7435    
7436             RANGE_MAX -
7437    
7438                (optionally returned) maximum allowed value for this effect
7439                parameter
7440    
7441             POSSIBILITIES -
7442    
7443    
7444    
7445    
7446    
7447    Schoenebeck               Expires July 13, 2014               [Page 133]
7448    
7449    Internet-Draft        LinuxSampler Control Protocol         January 2014
7450    
7451    
7452                (optionally returned) comma separated list of (optional
7453                dotted) floating point numbers, reflecting the exact set of
7454                possible values for this effect parameter
7455    
7456             DEFAULT -
7457    
7458                (optionally returned) default value of this effect parameter
7459    
7460       The mentioned fields above don't have to be in particular order.
7461    
7462       Example:
7463    
7464          C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"
7465    
7466          S: "DESCRIPTION: Base delay (s)"
7467    
7468             "VALUE: 0.500"
7469    
7470             "RANGE_MIN: 0.000"
7471    
7472             "."
7473    
7474    6.11.11.  Altering an effect parameter
7475    
7476       The front-end can alter the current value of an effect parameter by
7477       sending the following command:
7478    
7479          SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-
7480          control> <value>
7481    
7482       Where <effect-instance> is the numerical ID of the effect instance as
7483       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7484       EFFECT_INSTANCES" (Section 6.11.8) command, <input-control> is the
7485       index of the input control within the numerical bounds as returned by
7486       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7487       (Section 6.11.9) command and <value> is the new (optional dotted)
7488       floating point value for this effect parameter.
7489    
7490       Possible Answers:
7491    
7492          "OK" -
7493    
7494             in case the effect was altered successfully
7495    
7496          "ERR:<error-code>:<error-message>" -
7497    
7498             in case it failed, providing an appropriate error code and
7499             error message
7500    
7501    
7502    
7503    Schoenebeck               Expires July 13, 2014               [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol         January 2014
7506    
7507    
7508       Examples:
7509    
7510          C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"
7511    
7512          S: "OK"
7513    
7514    6.11.12.  Retrieve amount of send effect chains
7515    
7516       The front-end can retrieve the current amount of send effect chains
7517       of an audio output device by sending the following command:
7518    
7519          GET SEND_EFFECT_CHAINS <audio-device>
7520    
7521       Where <audio-device> should be replaced by the numerical ID of the
7522       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7523       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7524       command.
7525    
7526       Possible Answers:
7527    
7528          The sampler will answer by returning the current number of send
7529          effect chains of the supplied audio output device.
7530    
7531       Examples:
7532    
7533          C: "GET SEND_EFFECT_CHAINS 0"
7534    
7535          S: "4"
7536    
7537    6.11.13.  Retrieve list of send effect chains
7538    
7539       The front-end can retrieve the current list of send effect chains of
7540       an audio output device by sending the following command:
7541    
7542          LIST SEND_EFFECT_CHAINS <audio-device>
7543    
7544       Where <audio-device> should be replaced by the numerical ID of the
7545       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7546       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7547       command.
7548    
7549       Possible Answers:
7550    
7551          The sampler will answer by returning a comma separated list with
7552          numerical IDs of send effect chains of the supplied audio output
7553          device.
7554    
7555       Examples:
7556    
7557    
7558    
7559    Schoenebeck               Expires July 13, 2014               [Page 135]
7560    
7561    Internet-Draft        LinuxSampler Control Protocol         January 2014
7562    
7563    
7564          C: "LIST SEND_EFFECT_CHAINS 0"
7565    
7566          S: "3,4,7"
7567    
7568    6.11.14.  Add send effect chain
7569    
7570       The front-end can add a send effect chain by sending the following
7571       command:
7572    
7573          ADD SEND_EFFECT_CHAIN <audio-device>
7574    
7575       Where <audio-device> should be replaced by the numerical ID of the
7576       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7577       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7578       command.
7579    
7580       Possible Answers:
7581    
7582          "OK[<effect-chain>]" -
7583    
7584             in case the send effect chain was added successfully, where
7585             <effect-chain> is the numerical ID of the new send effect chain
7586    
7587          "ERR:<error-code>:<error-message>" -
7588    
7589             if the send effect chain could not be added
7590    
7591       Examples:
7592    
7593          C: "ADD SEND_EFFECT_CHAIN 0"
7594    
7595          S: "OK[2]"
7596    
7597    6.11.15.  Remove send effect chain
7598    
7599       The front-end can remove a send effect chain by sending the following
7600       command:
7601    
7602          REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain>
7603    
7604       Where <audio-device> should be replaced by the numerical ID of the
7605       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7606       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7607       command and <effect-chain> by the numerical ID as returned by the
7608       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7609       SEND_EFFECT_CHAINS" (Section 6.11.13) command.
7610    
7611       Possible Answers:
7612    
7613    
7614    
7615    Schoenebeck               Expires July 13, 2014               [Page 136]
7616    
7617    Internet-Draft        LinuxSampler Control Protocol         January 2014
7618    
7619    
7620          "OK" -
7621    
7622             in case the send effect chain was removed successfully
7623    
7624          "ERR:<error-code>:<error-message>" -
7625    
7626             if the send effect chain could not be removed
7627    
7628       Examples:
7629    
7630          C: "REMOVE SEND_EFFECT_CHAIN 0 2"
7631    
7632          S: "OK"
7633    
7634    6.11.16.  Retrieving information about a send effect chain
7635    
7636       The front-end can ask for informations of a send effect chain by
7637       sending the following command:
7638    
7639          GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain>
7640    
7641       Where <audio-device> should be replaced by the numerical ID of the
7642       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7643       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7644       command and <effect-chain> by the numerical ID as returned by the
7645       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7646       SEND_EFFECT_CHAINS" (Section 6.11.13) command.
7647    
7648       Possible Answers:
7649    
7650          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7651          answer line begins with the information category name, followed by
7652          a colon and then a space character <SP> and finally the info
7653          character string to that information category.  At the moment the
7654          following categories are defined:
7655    
7656    
7657    
7658             EFFECT_COUNT -
7659    
7660                amount of effects in this send effect chain
7661    
7662             EFFECT_SEQUENCE -
7663    
7664                comma separated list of the numerical IDs of the effect
7665                instances in this send effect chain, in the order as they
7666                are procssed in the effect chain
7667    
7668    
7669    
7670    
7671    Schoenebeck               Expires July 13, 2014               [Page 137]
7672    
7673    Internet-Draft        LinuxSampler Control Protocol         January 2014
7674    
7675    
7676       The mentioned fields above don't have to be in particular order.
7677    
7678       Example:
7679    
7680          C: "GET SEND_EFFECT_CHAIN INFO 0 2"
7681    
7682          S: "EFFECT_COUNT: 3"
7683    
7684             "EFFECT_SEQUENCE: 31,4,7"
7685    
7686             "."
7687    
7688    6.11.17.  Append effect instance to a send effect chain
7689    
7690       The front-end can add an unused effect instance to the end of a send
7691       effect chain by sending the following command:
7692    
7693          APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7694          <effect-instance>
7695    
7696       Where <audio-device> should be replaced by the numerical ID of the
7697       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7698       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7699       command and <effect-chain> by the numerical ID as returned by the
7700       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7701       SEND_EFFECT_CHAINS" (Section 6.11.13) command and <effect-instance>
7702       as returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7703       EFFECT_INSTANCES" (Section 6.11.8) command.
7704    
7705       Only unused effect instances can be added to the effect chain.
7706       Trying to add an effect instance which is already in use somewhere in
7707       the audio signal path of the sampler will result in an error.
7708    
7709       Possible Answers:
7710    
7711          "OK" -
7712    
7713             in case the effect instance was added successfully to the chain
7714    
7715          "ERR:<error-code>:<error-message>" -
7716    
7717             if the effect instance could not be added
7718    
7719       Examples:
7720    
7721          C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"
7722    
7723    
7724    
7725    
7726    
7727    Schoenebeck               Expires July 13, 2014               [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol         January 2014
7730    
7731    
7732          S: "OK"
7733    
7734    6.11.18.  Insert effect instance to a send effect chain
7735    
7736       The front-end can add an unused effect instance to a certain position
7737       of a send effect chain by sending the following command:
7738    
7739          INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7740          <chain-pos> <effect-instance>
7741    
7742       Where <audio-device> should be replaced by the numerical ID of the
7743       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7744       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7745       command, <effect-chain> by the numerical ID as returned by the "ADD
7746       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7747       (Section 6.11.13) command, <effect-instance> as returned by the
7748       "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST EFFECT_INSTANCES"
7749       (Section 6.11.8) command and <chain-pos> the exact position of the
7750       effect chain where the supplied effect shall be inserted to.
7751    
7752       Only unused effect instances can be added to the effect chain.
7753       Trying to add an effect instance which is already in use somewhere in
7754       the audio signal path of the sampler will result in an error.
7755    
7756       Possible Answers:
7757    
7758          "OK" -
7759    
7760             in case the effect instance was added successfully to the chain
7761    
7762          "ERR:<error-code>:<error-message>" -
7763    
7764             if the effect instance could not be added
7765    
7766       Examples:
7767    
7768          C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"
7769    
7770          S: "OK"
7771    
7772    6.11.19.  Remove effect instance from send effect chain
7773    
7774       The front-end can remove an effect instance from a certain position
7775       of a send effect chain by sending the following command:
7776    
7777          REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7778          <chain-pos>
7779    
7780    
7781    
7782    
7783    Schoenebeck               Expires July 13, 2014               [Page 139]
7784    
7785    Internet-Draft        LinuxSampler Control Protocol         January 2014
7786    
7787    
7788       Where <audio-device> should be replaced by the numerical ID of the
7789       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7790       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7791       command, <effect-chain> by the numerical ID as returned by the "ADD
7792       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7793       (Section 6.11.13) command and <chain-pos> the exact position of the
7794       effect instance to be removed from the effect chain.
7795    
7796       Possible Answers:
7797    
7798          "OK" -
7799    
7800             in case the effect instance was removed successfully
7801    
7802          "ERR:<error-code>:<error-message>" -
7803    
7804             if the effect instance could not be removed
7805    
7806       Examples:
7807    
7808          C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"
7809    
7810          S: "OK"
7811    
7812    
7813    
7814    
7815    
7816    
7817    
7818    
7819    
7820    
7821    
7822    
7823    
7824    
7825    
7826    
7827    
7828    
7829    
7830    
7831    
7832    
7833    
7834    
7835    
7836    
7837    
7838    
7839    Schoenebeck               Expires July 13, 2014               [Page 140]
7840    
7841    Internet-Draft        LinuxSampler Control Protocol         January 2014
7842    
7843    
7844  7.  Command Syntax  7.  Command Syntax
# Line 4644  Internet-Draft        LinuxSampler Contr Line 7892  Internet-Draft        LinuxSampler Contr
7892    
7893    
7894    
7895  Schoenebeck               Expires July 2, 2007                 [Page 83]  Schoenebeck               Expires July 13, 2014               [Page 141]
7896    
7897  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
7898    
7899    
7900        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4661  Internet-Draft        LinuxSampler Contr Line 7909  Internet-Draft        LinuxSampler Contr
7909    
7910        / UNSUBSCRIBE SP unsubscribe_event        / UNSUBSCRIBE SP unsubscribe_event
7911    
       / SELECT SP text  
   
7912        / RESET SP reset_instruction        / RESET SP reset_instruction
7913    
7914        / CLEAR SP clear_instruction        / CLEAR SP clear_instruction
7915    
7916          / FIND SP find_instruction
7917    
7918          / MOVE SP move_instruction
7919    
7920          / COPY SP copy_instruction
7921    
7922          / EDIT SP edit_instruction
7923    
7924          / FORMAT SP format_instruction
7925    
7926          / SEND SP send_instruction
7927    
7928          / APPEND SP append_instruction
7929    
7930          / INSERT SP insert_instruction
7931    
7932        / RESET        / RESET
7933    
7934        / QUIT        / QUIT
# Line 4675  Internet-Draft        LinuxSampler Contr Line 7937  Internet-Draft        LinuxSampler Contr
7937    
7938        CHANNEL        CHANNEL
7939    
7940          / CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index
7941    
7942          / CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP
7943          midi_input_port_index
7944    
7945          / DB_INSTRUMENT_DIRECTORY SP db_path
7946    
7947    
7948    
7949    
7950    
7951    Schoenebeck               Expires July 13, 2014               [Page 142]
7952    
7953    Internet-Draft        LinuxSampler Control Protocol         January 2014
7954    
7955    
7956          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
7957    
7958          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP
7959          db_path SP filename
7960    
7961          / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
7962    
7963          / DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP
7964          filename
7965    
7966          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
7967    
7968          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
7969          instrument_index
7970    
7971          / DB_INSTRUMENTS SP db_path SP filename
7972    
7973          / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
7974    
7975        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
7976    
7977        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
7978    
7979          / SEND_EFFECT_CHAIN SP device_index
7980    
7981     subscribe_event =     subscribe_event =
7982    
7983        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
# Line 4691  Internet-Draft        LinuxSampler Contr Line 7990  Internet-Draft        LinuxSampler Contr
7990    
7991        / CHANNEL_COUNT        / CHANNEL_COUNT
7992    
7993          / CHANNEL_MIDI
7994    
7995          / DEVICE_MIDI
7996    
7997        / VOICE_COUNT        / VOICE_COUNT
7998    
7999        / STREAM_COUNT        / STREAM_COUNT
# Line 4700  Internet-Draft        LinuxSampler Contr Line 8003  Internet-Draft        LinuxSampler Contr
8003    
8004    
8005    
8006  Schoenebeck               Expires July 2, 2007                 [Page 84]  
8007    Schoenebeck               Expires July 13, 2014               [Page 143]
8008    
8009  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
8010    
8011    
8012        / CHANNEL_INFO        / CHANNEL_INFO
8013    
8014          / FX_SEND_COUNT
8015    
8016          / FX_SEND_INFO
8017    
8018        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
8019    
8020        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
# Line 4715  Internet-Draft        LinuxSampler Contr Line 8023  Internet-Draft        LinuxSampler Contr
8023    
8024        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
8025    
8026          / DB_INSTRUMENT_DIRECTORY_COUNT
8027    
8028          / DB_INSTRUMENT_DIRECTORY_INFO
8029    
8030          / DB_INSTRUMENT_COUNT
8031    
8032          / DB_INSTRUMENT_INFO
8033    
8034          / DB_INSTRUMENTS_JOB_INFO
8035    
8036        / MISCELLANEOUS        / MISCELLANEOUS
8037    
8038          / TOTAL_STREAM_COUNT
8039    
8040        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
8041    
8042          / GLOBAL_INFO
8043    
8044          / EFFECT_INSTANCE_COUNT
8045    
8046          / EFFECT_INSTANCE_INFO
8047    
8048          / SEND_EFFECT_CHAIN_COUNT
8049    
8050          / SEND_EFFECT_CHAIN_INFO
8051    
8052     unsubscribe_event =     unsubscribe_event =
8053    
8054        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
# Line 4727  Internet-Draft        LinuxSampler Contr Line 8057  Internet-Draft        LinuxSampler Contr
8057    
8058        / MIDI_INPUT_DEVICE_COUNT        / MIDI_INPUT_DEVICE_COUNT
8059    
8060    
8061    
8062    
8063    Schoenebeck               Expires July 13, 2014               [Page 144]
8064    
8065    Internet-Draft        LinuxSampler Control Protocol         January 2014
8066    
8067    
8068        / MIDI_INPUT_DEVICE_INFO        / MIDI_INPUT_DEVICE_INFO
8069    
8070        / CHANNEL_COUNT        / CHANNEL_COUNT
8071    
8072          / CHANNEL_MIDI
8073    
8074          / DEVICE_MIDI
8075    
8076        / VOICE_COUNT        / VOICE_COUNT
8077    
8078        / STREAM_COUNT        / STREAM_COUNT
# Line 4739  Internet-Draft        LinuxSampler Contr Line 8081  Internet-Draft        LinuxSampler Contr
8081    
8082        / CHANNEL_INFO        / CHANNEL_INFO
8083    
8084          / FX_SEND_COUNT
8085    
8086          / FX_SEND_INFO
8087    
8088        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
8089    
8090        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
# Line 4747  Internet-Draft        LinuxSampler Contr Line 8093  Internet-Draft        LinuxSampler Contr
8093    
8094        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
8095    
8096          / DB_INSTRUMENT_DIRECTORY_COUNT
8097    
8098          / DB_INSTRUMENT_DIRECTORY_INFO
8099    
8100          / DB_INSTRUMENT_COUNT
8101    
8102          / DB_INSTRUMENT_INFO
8103    
8104          / DB_INSTRUMENTS_JOB_INFO
8105    
8106        / MISCELLANEOUS        / MISCELLANEOUS
8107    
8108          / TOTAL_STREAM_COUNT
8109    
8110        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
8111    
8112     map_instruction =        / GLOBAL_INFO
8113    
8114          / EFFECT_INSTANCE_COUNT
8115    
8116    
8117    
8118    
8119  Schoenebeck               Expires July 2, 2007                 [Page 85]  Schoenebeck               Expires July 13, 2014               [Page 145]
8120    
8121  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
8122    
8123    
8124          / EFFECT_INSTANCE_INFO
8125    
8126          / SEND_EFFECT_CHAIN_COUNT
8127    
8128        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / SEND_EFFECT_CHAIN_INFO
8129    
8130       map_instruction =
8131    
8132          MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
8133        engine_name SP filename SP instrument_index SP volume_value        engine_name SP filename SP instrument_index SP volume_value
8134    
8135        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
8136        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
8137        instr_load_mode        instr_load_mode
8138    
8139        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
8140        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
8141        entry_name        entry_name
8142    
8143        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
8144        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
8145        instr_load_mode SP entry_name        instr_load_mode SP entry_name
8146    
8147     unmap_instruction =     unmap_instruction =
# Line 4784  Internet-Draft        LinuxSampler Contr Line 8152  Internet-Draft        LinuxSampler Contr
8152    
8153        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
8154    
8155          / CHANNEL SP MIDI_INPUT SP sampler_channel
8156    
8157          / CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index
8158    
8159          / CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP
8160          midi_input_port_index
8161    
8162        / MIDI_INSTRUMENT_MAP SP midi_map        / MIDI_INSTRUMENT_MAP SP midi_map
8163    
8164        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
8165    
8166          / SEND_EFFECT_CHAIN SP device_index SP effect_chain
8167    
8168          / SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8169          chain_pos
8170    
8171    
8172    
8173    
8174    
8175    Schoenebeck               Expires July 13, 2014               [Page 146]
8176    
8177    Internet-Draft        LinuxSampler Control Protocol         January 2014
8178    
8179    
8180          / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
8181    
8182          / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
8183    
8184          / DB_INSTRUMENT_DIRECTORY SP db_path
8185    
8186          / DB_INSTRUMENT SP db_path
8187    
8188     get_instruction =     get_instruction =
8189    
8190        AVAILABLE_ENGINES        AVAILABLE_ENGINES
8191    
8192          / AVAILABLE_EFFECTS
8193    
8194          / EFFECT_INSTANCES
8195    
8196          / EFFECT SP INFO SP effect_index
8197    
8198          / EFFECT_INSTANCE SP INFO SP effect_instance
8199    
8200          / EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP
8201          input_control
8202    
8203          / SEND_EFFECT_CHAINS SP device_index
8204    
8205          / SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
8206    
8207        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
8208    
8209        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
# Line 4810  Internet-Draft        LinuxSampler Contr Line 8222  Internet-Draft        LinuxSampler Contr
8222        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
8223        key_val_list        key_val_list
8224    
8225          / AUDIO_OUTPUT_DEVICES
8226    
8227    
 Schoenebeck               Expires July 2, 2007                 [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
8228    
8229    
8230        / AUDIO_OUTPUT_DEVICES  
8231    Schoenebeck               Expires July 13, 2014               [Page 147]
8232    
8233    Internet-Draft        LinuxSampler Control Protocol         January 2014
8234    
8235    
8236        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
8237    
# Line 4848  Internet-Draft        LinuxSampler Contr Line 8262  Internet-Draft        LinuxSampler Contr
8262    
8263        / SERVER SP INFO        / SERVER SP INFO
8264    
8265          / TOTAL_STREAM_COUNT
8266    
8267        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
8268    
8269        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
# Line 4868  Internet-Draft        LinuxSampler Contr Line 8284  Internet-Draft        LinuxSampler Contr
8284    
8285    
8286    
8287  Schoenebeck               Expires July 2, 2007                 [Page 87]  Schoenebeck               Expires July 13, 2014               [Page 148]
8288    
8289  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
8290    
8291    
8292        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / FX_SEND SP INFO SP sampler_channel SP fx_send_id
8293    
8294          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
8295    
8296          / DB_INSTRUMENT_DIRECTORIES SP db_path
8297    
8298          / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
8299    
8300          / DB_INSTRUMENTS SP RECURSIVE SP db_path
8301    
8302          / DB_INSTRUMENTS SP db_path
8303    
8304          / DB_INSTRUMENT SP INFO SP db_path
8305    
8306          / DB_INSTRUMENTS_JOB SP INFO SP number
8307    
8308        / VOLUME        / VOLUME
8309    
8310          / VOICES
8311    
8312          / STREAMS
8313    
8314          / FILE SP INSTRUMENTS SP filename
8315    
8316          / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
8317    
8318     set_instruction =     set_instruction =
8319    
8320        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
# Line 4888  Internet-Draft        LinuxSampler Contr Line 8326  Internet-Draft        LinuxSampler Contr
8326        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
8327        param_val_list        param_val_list
8328    
8329          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
8330    
8331        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
8332        param_val_list        param_val_list
8333    
8334          / EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP
8335          input_control SP control_value
8336    
8337        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
8338    
8339    
8340    
8341    
8342    
8343    Schoenebeck               Expires July 13, 2014               [Page 149]
8344    
8345    Internet-Draft        LinuxSampler Control Protocol         January 2014
8346    
8347    
8348        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
8349    
8350          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
8351    
8352        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
8353        SP audio_channel_index SP audio_channel_index        SP audio_channel_index SP audio_channel_index
8354    
8355          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
8356          midi_ctrl
8357    
8358          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
8359          volume_value
8360    
8361          / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP
8362          effect_chain SP chain_pos
8363    
8364          / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
8365    
8366          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
8367          stringval_escaped
8368    
8369          / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
8370    
8371          / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
8372    
8373          / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
8374    
8375        / ECHO SP boolean        / ECHO SP boolean
8376    
8377        / VOLUME SP volume_value        / VOLUME SP volume_value
8378    
8379          / VOICES SP number
8380    
8381          / STREAMS SP number
8382    
8383     create_instruction =     create_instruction =
8384    
8385        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 4914  Internet-Draft        LinuxSampler Contr Line 8392  Internet-Draft        LinuxSampler Contr
8392    
8393        / FX_SEND SP sampler_channel SP midi_ctrl        / FX_SEND SP sampler_channel SP midi_ctrl
8394    
8395    
8396    
8397    
8398    
8399    Schoenebeck               Expires July 13, 2014               [Page 150]
8400    
8401    Internet-Draft        LinuxSampler Control Protocol         January 2014
8402    
8403    
8404        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
8405    
8406          / EFFECT_INSTANCE SP effect_index
8407    
8408          / EFFECT_INSTANCE SP effect_system SP module SP effect_name
8409    
8410     reset_instruction =     reset_instruction =
8411    
8412        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
8413    
8414     clear_instruction =     clear_instruction =
8415    
8416          MIDI_INSTRUMENTS SP midi_map
8417    
8418          / MIDI_INSTRUMENTS SP ALL
8419    
8420  Schoenebeck               Expires July 2, 2007                 [Page 88]     find_instruction =
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
8421    
8422          DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
8423    
8424        MIDI_INSTRUMENTS SP midi_map        / DB_INSTRUMENTS SP db_path SP query_val_list
8425    
8426        / MIDI_INSTRUMENTS SP ALL        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
8427          query_val_list
8428    
8429          / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
8430    
8431          / LOST SP DB_INSTRUMENT_FILES
8432    
8433       move_instruction =
8434    
8435          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8436    
8437          / DB_INSTRUMENT SP db_path SP db_path
8438    
8439       copy_instruction =
8440    
8441          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8442    
8443          / DB_INSTRUMENT SP db_path SP db_path
8444    
8445     destroy_instruction =     destroy_instruction =
8446    
# Line 4939  Internet-Draft        LinuxSampler Contr Line 8448  Internet-Draft        LinuxSampler Contr
8448    
8449        / MIDI_INPUT_DEVICE SP number        / MIDI_INPUT_DEVICE SP number
8450    
8451    
8452    
8453    
8454    
8455    Schoenebeck               Expires July 13, 2014               [Page 151]
8456    
8457    Internet-Draft        LinuxSampler Control Protocol         January 2014
8458    
8459    
8460        / FX_SEND SP sampler_channel SP fx_send_id        / FX_SEND SP sampler_channel SP fx_send_id
8461    
8462          / EFFECT_INSTANCE SP number
8463    
8464     load_instruction =     load_instruction =
8465    
8466        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
8467    
8468        / ENGINE SP load_engine_args        / ENGINE SP load_engine_args
8469    
8470       append_instruction =
8471    
8472          SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8473          effect_instance
8474    
8475       insert_instruction =
8476    
8477          SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8478          chain_pos SP effect_instance
8479    
8480     set_chan_instruction =     set_chan_instruction =
8481    
8482        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
# Line 4974  Internet-Draft        LinuxSampler Contr Line 8504  Internet-Draft        LinuxSampler Contr
8504    
8505        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
8506    
       / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map  
   
8507    
8508    
8509    
8510    
8511  Schoenebeck               Expires July 2, 2007                 [Page 89]  Schoenebeck               Expires July 13, 2014               [Page 152]
8512    
8513  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
8514    
8515    
8516          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
8517    
8518        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
8519    
8520        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
8521    
8522       edit_instruction =
8523    
8524          CHANNEL SP INSTRUMENT SP sampler_channel
8525    
8526       format_instruction =
8527    
8528          INSTRUMENTS_DB
8529    
8530       modal_arg =
8531    
8532          /* epsilon (empty argument) */
8533    
8534          / NON_MODAL SP
8535    
8536     key_val_list =     key_val_list =
8537    
8538        string '=' param_val_list        string '=' param_val_list
# Line 5009  Internet-Draft        LinuxSampler Contr Line 8553  Internet-Draft        LinuxSampler Contr
8553    
8554        / CHANNELS        / CHANNELS
8555    
8556          / CHANNEL SP MIDI_INPUTS SP sampler_channel
8557    
8558        / AVAILABLE_ENGINES        / AVAILABLE_ENGINES
8559    
8560          / AVAILABLE_EFFECTS
8561    
8562          / EFFECT_INSTANCES
8563    
8564    
8565    
8566    
8567    Schoenebeck               Expires July 13, 2014               [Page 153]
8568    
8569    Internet-Draft        LinuxSampler Control Protocol         January 2014
8570    
8571    
8572          / SEND_EFFECT_CHAINS SP number
8573    
8574        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
8575    
8576        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 5023  Internet-Draft        LinuxSampler Contr Line 8583  Internet-Draft        LinuxSampler Contr
8583    
8584        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
8585    
8586          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
8587    
8588          / DB_INSTRUMENT_DIRECTORIES SP db_path
8589    
8590          / DB_INSTRUMENTS SP RECURSIVE SP db_path
8591    
8592          / DB_INSTRUMENTS SP db_path
8593    
8594          / FILE SP INSTRUMENTS SP filename
8595    
8596       send_instruction =
8597    
8598          CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP
8599          number
8600    
8601     load_instr_args =     load_instr_args =
8602    
8603        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 5033  Internet-Draft        LinuxSampler Contr Line 8608  Internet-Draft        LinuxSampler Contr
8608    
8609        engine_name SP sampler_channel        engine_name SP sampler_channel
8610    
8611       instr_load_mode =
8612    
8613          ON_DEMAND
8614    
8615          / ON_DEMAND_HOLD
8616    
8617  Schoenebeck               Expires July 2, 2007                 [Page 90]        / PERSISTENT
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
8618    
8619       effect_instance =
8620    
    instr_load_mode =  
8621    
       ON_DEMAND  
8622    
8623        / ON_DEMAND_HOLD  Schoenebeck               Expires July 13, 2014               [Page 154]
8624    
8625    Internet-Draft        LinuxSampler Control Protocol         January 2014
8626    
8627        / PERSISTENT  
8628          number
8629    
8630     device_index =     device_index =
8631    
# Line 5089  Internet-Draft        LinuxSampler Contr Line 8667  Internet-Draft        LinuxSampler Contr
8667    
8668     midi_ctrl =     midi_ctrl =
8669    
8670          number
8671    
8672       volume_value =
8673    
8674          dotnum
8675    
 Schoenebeck               Expires July 2, 2007                 [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
8676    
8677    
       number  
8678    
8679     volume_value =  Schoenebeck               Expires July 13, 2014               [Page 155]
8680    
8681    Internet-Draft        LinuxSampler Control Protocol         January 2014
8682    
       dotnum  
8683    
8684        / number        / number
8685    
8686       control_value =
8687    
8688          real
8689    
8690     sampler_channel =     sampler_channel =
8691    
8692        number        number
# Line 5123  Internet-Draft        LinuxSampler Contr Line 8705  Internet-Draft        LinuxSampler Contr
8705    
8706     filename =     filename =
8707    
8708        stringval        path
8709    
8710       db_path =
8711    
8712          path
8713    
8714     map_name =     map_name =
8715    
8716        stringval        stringval_escaped
8717    
8718     entry_name =     entry_name =
8719    
8720        stringval        stringval_escaped
8721    
8722     fx_send_name =     fx_send_name =
8723    
8724        stringval        stringval_escaped
8725    
8726       effect_name =
8727    
8728          stringval_escaped
8729    
8730       effect_index =
8731    
8732    
8733    
8734    
8735    Schoenebeck               Expires July 13, 2014               [Page 156]
8736    
8737    Internet-Draft        LinuxSampler Control Protocol         January 2014
8738    
8739    
8740          number
8741    
8742       effect_chain =
8743    
8744          number
8745    
8746       chain_pos =
8747    
8748          number
8749    
8750       input_control =
8751    
8752          number
8753    
8754     param_val_list =     param_val_list =
8755    
# Line 5145  Internet-Draft        LinuxSampler Contr Line 8759  Internet-Draft        LinuxSampler Contr
8759    
8760     param_val =     param_val =
8761    
8762          string
8763    
8764          / stringval
8765    
8766          / number
8767    
8768          / dotnum
8769    
8770       query_val_list =
8771    
8772          string '=' query_val
8773    
8774          / query_val_list SP string '=' query_val
8775    
8776       query_val =
8777    
8778          text_escaped
8779    
8780  Schoenebeck               Expires July 2, 2007                 [Page 92]        / stringval_escaped
8781    
8782       scan_mode =
8783    
8784          RECURSIVE
8785    
8786          / NON_RECURSIVE
8787    
8788    
8789    
8790    
8791    Schoenebeck               Expires July 13, 2014               [Page 157]
8792    
8793  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
8794    
8795    
8796          / FLAT
8797    
8798       effect_system =
8799    
8800        string        string
8801    
8802        / stringval     module =
8803    
8804        / number        filename
8805    
8806        / dotnum  7.1.  Character Set and Escape Sequences
8807    
8808       Older versions of this protocol up to and including v1.1 only
8809       supported the standard ASCII character set (ASCII code 0 - 127)
8810       [RFC20], all younger versions of this protocol however support the
8811       Extended ASCII character set (ASCII code 0 - 255).  The same group of
8812       younger protocols also support escape sequences, but only for
8813       certain, explicitly declared parts of the protocol.  The supported
8814       escape sequences are defined as follows:
8815    
8816       +------------------------+------------------------------------------+
8817       | ASCII Character        | Translated into (Name)                   |
8818       | Sequence               |                                          |
8819       +------------------------+------------------------------------------+
8820       | \n                     | new line                                 |
8821       |                        |                                          |
8822       | \r                     | carriage return                          |
8823       |                        |                                          |
8824       | \f                     | form feed                                |
8825       |                        |                                          |
8826       | \t                     | horizontal tab                           |
8827       |                        |                                          |
8828       | \v                     | vertical tab                             |
8829       |                        |                                          |
8830       | \'                     | apostrophe                               |
8831       |                        |                                          |
8832       | \"                     | quotation mark                           |
8833       |                        |                                          |
8834       | \\                     | backslash                                |
8835       |                        |                                          |
8836       | \OOO                   | three digit octal ASCII code of the      |
8837       |                        | character                                |
8838       |                        |                                          |
8839       | \xHH                   | two digit hex ASCII code of the          |
8840       |                        | character                                |
8841       +------------------------+------------------------------------------+
8842    
8843       Notice: due to the transition of certain parts of the protocol which
8844    
8845    
8846    
8847    Schoenebeck               Expires July 13, 2014               [Page 158]
8848    
8849    Internet-Draft        LinuxSampler Control Protocol         January 2014
8850    
8851    
8852       now support escape sequences, a slight backward incompatibility to
8853       protocols version v1.1 and younger has been introduced.  The only
8854       difference is that in parts of the protocol where escape characters
8855       are now supported, a backslash characters MUST be escaped as well
8856       (that is as double backslash), whereas in the old versions a single
8857       backslash was sufficient.
8858    
8859       The following LSCP commands support escape sequences as part of their
8860       filename / path based arguments and / or may contain a filename /
8861       path with escape sequences in their response:
8862    
8863          "LOAD INSTRUMENT" (Section 6.4.1)
8864    
8865          "GET CHANNEL INFO" (Section 6.4.10)
8866    
8867          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
8868    
8869          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
8870    
8871          "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
8872    
8873          "ADD DB_INSTRUMENTS" (Section 6.8.11)
8874    
8875          "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
8876    
8877          "REMOVE DB_INSTRUMENT" (Section 6.8.12)
8878    
8879          "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
8880    
8881          "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
8882    
8883          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
8884    
8885          "GET DB_INSTRUMENTS" (Section 6.8.13)
8886    
8887          "LIST DB_INSTRUMENTS" (Section 6.8.14)
8888    
8889          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
8890    
8891          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
8892    
8893          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
8894    
8895          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
8896    
8897          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
8898    
8899    
8900    
8901    
8902    
8903    Schoenebeck               Expires July 13, 2014               [Page 159]
8904    
8905    Internet-Draft        LinuxSampler Control Protocol         January 2014
8906    
8907    
8908          "FIND DB_INSTRUMENTS" (Section 6.8.20)
8909    
8910          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
8911    
8912          "MOVE DB_INSTRUMENT" (Section 6.8.17)
8913    
8914          "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
8915    
8916          "COPY DB_INSTRUMENT" (Section 6.8.18)
8917    
8918          "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
8919    
8920          "FIND LOST DB_INSTRUMENT_FILES" (Section 6.8.23)
8921    
8922          "SET DB_INSTRUMENT FILE_PATH" (Section 6.8.24)
8923    
8924          "GET FILE INSTRUMENTS" (Section 6.10.1)
8925    
8926          "LIST FILE INSTRUMENTS" (Section 6.10.2)
8927    
8928          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
8929    
8930          "GET EFFECT INFO" (Section 6.11.3)
8931    
8932          "GET EFFECT_INSTANCE INFO" (Section 6.11.9)
8933    
8934          "CREATE EFFECT_INSTANCE" (Section 6.11.4)
8935    
8936       Note that the forward slash character ('/') has a special meaning in
8937       filename / path based arguments: it acts as separator of the nodes in
8938       the path, thus if a directory- or filename includes a forward slash
8939       (not intended as path node separator), you MUST escape that slash
8940       either with the respective hex escape sequence ("\x2f") or with the
8941       respective octal escape sequence ("\057").
8942    
8943       Note for Windows: file path arguments in LSCP are expected to use
8944       forward slashes as directory node separator similar to Unix based
8945       operating systems.  In contrast to Unix however a Windows typical
8946       drive character is expected to be prefixed to the path.  That is an
8947       original Windows file path like "D:\Sounds\My.gig" would become in
8948       LSCP: "D:/Sounds/My.gig".
8949    
8950       The following LSCP commands even support escape sequences as part of
8951       at least one of their text-based arguments (i.e. entity name,
8952       description) and / or may contain escape sequences in at least one of
8953       their text-based fields in their response:
8954    
8955    
8956    
8957    
8958    
8959    Schoenebeck               Expires July 13, 2014               [Page 160]
8960    
8961    Internet-Draft        LinuxSampler Control Protocol         January 2014
8962    
8963    
8964          "GET SERVER INFO" (Section 6.6.5)
8965    
8966          "GET ENGINE INFO" (Section 6.4.9)
8967    
8968          "GET CHANNEL INFO" (Section 6.4.10)
8969    
8970          "CREATE FX_SEND" (Section 6.4.28)
8971    
8972          "GET FX_SEND INFO" (Section 6.4.32)
8973    
8974          "SET FX_SEND NAME" (Section 6.4.33)
8975    
8976          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
8977    
8978          "GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5)
8979    
8980          "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
8981    
8982          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
8983    
8984          "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
8985    
8986          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
8987    
8988          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
8989    
8990          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
8991    
8992          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
8993    
8994          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
8995    
8996          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
8997    
8998          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
8999    
9000          "FIND DB_INSTRUMENTS" (Section 6.8.20)
9001    
9002          "GET EFFECT INFO" (Section 6.11.3)
9003    
9004          "GET EFFECT_INSTANCE INFO" (Section 6.11.9)
9005    
9006          "CREATE EFFECT_INSTANCE" (Section 6.11.4)
9007    
9008       Please note that these lists are manually maintained.  If you find a
9009       command that also supports escape sequences we forgot to mention
9010       here, please report it!
9011    
9012  Schoenebeck               Expires July 2, 2007                 [Page 93]  
9013    
9014    
9015    Schoenebeck               Expires July 13, 2014               [Page 161]
9016    
9017  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9018    
9019    
9020  8.  Events  8.  Events
# Line 5260  Internet-Draft        LinuxSampler Contr Line 9068  Internet-Draft        LinuxSampler Contr
9068    
9069    
9070    
9071  Schoenebeck               Expires July 2, 2007                 [Page 94]  Schoenebeck               Expires July 13, 2014               [Page 162]
9072    
9073  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9074    
9075    
9076        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 5303  Internet-Draft        LinuxSampler Contr Line 9111  Internet-Draft        LinuxSampler Contr
9111     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
9112     channels.     channels.
9113    
9114  8.6.  Number of active voices changed  8.6.  MIDI data on a sampler channel arrived
9115    
9116     Client may want to be notified when the number of voices on the back-     Client may want to be notified when MIDI data arrive on sampler
9117     end changes by issuing the following command:     channels on back-end side, by issuing the following command:
9118    
9119        SUBSCRIBE VOICE_COUNT        SUBSCRIBE CHANNEL_MIDI
9120    
9121     Server will start sending the following notification messages:     Server will start sending one of the the following notification
9122       messages:
9123    
9124    
9125    
9126    
9127    Schoenebeck               Expires July 13, 2014               [Page 163]
9128    
9129    Internet-Draft        LinuxSampler Control Protocol         January 2014
9130    
9131    
9132          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"
9133    
9134          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"
9135    
9136       where <channel-id> will be replaced by the ID of the sampler channel
9137       where the MIDI data arrived. <note> and <velocity> are integer values
9138       in the range between 0 .. 127, reflecting the analog meaning of the
9139       MIDI specification.
9140    
9141       CAUTION: no guarantee whatsoever will be made that MIDI events are
9142       actually all delivered by this mechanism!  With other words: events
9143       could be lost at any time!  This restriction was made to keep the RT-
9144       safeness of the backend's MIDI and audio thread unaffected by this
9145       feature.
9146    
9147    8.7.  MIDI data on a MIDI input device arrived
9148    
9149       Client may want to be notified when MIDI data arrive on MIDI input
9150       devices by issuing the following command:
9151    
9152          SUBSCRIBE DEVICE_MIDI
9153    
9154       Server will start sending one of the the following notification
9155       messages:
9156    
9157          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note>
9158          <velocity>"
9159    
9160          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note>
9161          <velocity>"
9162    
9163       where <device-id> <port-id> will be replaced by the IDs of the
9164       respective MIDI input device and the device's MIDI port where the
9165       MIDI data arrived. <note> and <velocity> are integer values in the
9166       range between 0 .. 127, reflecting the analog meaning of the MIDI
9167       specification.
9168    
9169  Schoenebeck               Expires July 2, 2007                 [Page 95]     CAUTION: no guarantee whatsoever will be made that MIDI events are
9170       actually all delivered by this mechanism!  With other words: events
9171       could be lost at any time!  This restriction was made to keep the RT-
9172       safeness of the backend's MIDI and audio thread unaffected by this
9173       feature.
9174    
9175    8.8.  Number of active voices changed
9176    
9177       Client may want to be notified when the number of voices on the back-
9178       end changes by issuing the following command:
9179    
9180    
9181    
9182    
9183    Schoenebeck               Expires July 13, 2014               [Page 164]
9184    
9185  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9186    
9187    
9188        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        SUBSCRIBE VOICE_COUNT
9189    
9190       Server will start sending the following notification messages:
9191    
9192          "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
9193    
9194     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
9195     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
9196     voices on that channel.     voices on that channel.
9197    
9198  8.7.  Number of active disk streams changed  8.9.  Number of active disk streams changed
9199    
9200     Client may want to be notified when the number of streams on the     Client may want to be notified when the number of streams on the
9201     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 5343  Internet-Draft        LinuxSampler Contr Line 9211  Internet-Draft        LinuxSampler Contr
9211     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
9212     active disk streams on that channel.     active disk streams on that channel.
9213    
9214  8.8.  Disk stream buffer fill state changed  8.10.  Disk stream buffer fill state changed
9215    
9216     Client may want to be notified when the buffer fill state of a disk     Client may want to be notified when the buffer fill state of a disk
9217     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 5360  Internet-Draft        LinuxSampler Contr Line 9228  Internet-Draft        LinuxSampler Contr
9228     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
9229     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
9230    
9231  8.9.  Channel information changed  8.11.  Channel information changed
9232    
9233     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
9234     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
9235    
       SUBSCRIBE CHANNEL_INFO  
9236    
    Server will start sending the following notification messages:  
9237    
9238    
9239    Schoenebeck               Expires July 13, 2014               [Page 165]
9240    
9241    Internet-Draft        LinuxSampler Control Protocol         January 2014
9242    
9243    
9244  Schoenebeck               Expires July 2, 2007                 [Page 96]        SUBSCRIBE CHANNEL_INFO
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
9245    
9246       Server will start sending the following notification messages:
9247    
9248        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
9249    
# Line 5386  Internet-Draft        LinuxSampler Contr Line 9254  Internet-Draft        LinuxSampler Contr
9254     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
9255     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
9256    
9257  8.10.  Total number of active voices changed  8.12.  Number of effect sends changed
9258    
9259       Client may want to be notified when the number of effect sends on a
9260       particular sampler channel is changed by issuing the following
9261       command:
9262    
9263          SUBSCRIBE FX_SEND_COUNT
9264    
9265       Server will start sending the following notification messages:
9266    
9267          "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
9268    
9269       where <channel-id> will be replaced by the numerical ID of the
9270       sampler channel, on which the effect sends number is changed and <fx-
9271       sends> will be replaced by the new number of effect sends on that
9272       channel.
9273    
9274    8.13.  Effect send information changed
9275    
9276       Client may want to be notified when changes were made to effect sends
9277       on a a particular sampler channel by issuing the following command:
9278    
9279          SUBSCRIBE FX_SEND_INFO
9280    
9281       Server will start sending the following notification messages:
9282    
9283          "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
9284    
9285       where <channel-id> will be replaced by the numerical ID of the
9286       sampler channel, on which an effect send entity is changed and <fx-
9287       send-id> will be replaced by the numerical ID of the changed effect
9288       send.
9289    
9290    
9291    
9292    
9293    
9294    
9295    Schoenebeck               Expires July 13, 2014               [Page 166]
9296    
9297    Internet-Draft        LinuxSampler Control Protocol         January 2014
9298    
9299    
9300    8.14.  Total number of active voices changed
9301    
9302     Client may want to be notified when the total number of voices on the     Client may want to be notified when the total number of voices on the
9303     back-end changes by issuing the following command:     back-end changes by issuing the following command:
# Line 5395  Internet-Draft        LinuxSampler Contr Line 9306  Internet-Draft        LinuxSampler Contr
9306    
9307     Server will start sending the following notification messages:     Server will start sending the following notification messages:
9308    
9309        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
9310    
9311     where <voices> will be replaced by the new number of all currently     where <voices> will be replaced by the new number of all currently
9312     active voices.     active voices.
9313    
9314  8.11.  Number of MIDI instrument maps changed  8.15.  Total number of active disk streams changed
9315    
9316       Client may want to be notified when the total number of disk streams
9317       on the back-end changes by issuing the following command:
9318    
9319          SUBSCRIBE TOTAL_STREAM_COUNT
9320    
9321       Server will start sending the following notification messages:
9322    
9323          "NOTIFY:TOTAL_STREAM_COUNT:<streams>"
9324    
9325       where <streams> will be replaced by the new number of all currently
9326       active disk streams.
9327    
9328    8.16.  Number of MIDI instrument maps changed
9329    
9330     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
9331     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 5414  Internet-Draft        LinuxSampler Contr Line 9339  Internet-Draft        LinuxSampler Contr
9339     where <maps> will be replaced by the new number of MIDI instrument     where <maps> will be replaced by the new number of MIDI instrument
9340     maps.     maps.
9341    
9342  8.12.  MIDI instrument map information changed  8.17.  MIDI instrument map information changed
9343    
9344     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
9345     instrument maps on the back-end by issuing the following command:     instrument maps on the back-end by issuing the following command:
9346    
       SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO  
   
    Server will start sending the following notification messages:  
9347    
9348    
9349    
9350    
9351    Schoenebeck               Expires July 13, 2014               [Page 167]
9352    
9353    Internet-Draft        LinuxSampler Control Protocol         January 2014
9354    
9355    
9356  Schoenebeck               Expires July 2, 2007                 [Page 97]        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
9357    
9358       Server will start sending the following notification messages:
9359    
9360        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
9361    
# Line 5443  Internet-Draft        LinuxSampler Contr Line 9367  Internet-Draft        LinuxSampler Contr
9367     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
9368     message is sufficient here.     message is sufficient here.
9369    
9370  8.13.  Number of MIDI instruments changed  8.18.  Number of MIDI instruments changed
9371    
9372     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
9373     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 5458  Internet-Draft        LinuxSampler Contr Line 9382  Internet-Draft        LinuxSampler Contr
9382     which the nuber of instruments has changed and <instruments> will be     which the nuber of instruments has changed and <instruments> will be
9383     replaced by the new number of MIDI instruments in the specified map.     replaced by the new number of MIDI instruments in the specified map.
9384    
9385  8.14.  MIDI instrument information changed  8.19.  MIDI instrument information changed
9386    
9387     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
9388     instruments on the back-end by issuing the following command:     instruments on the back-end by issuing the following command:
# Line 5480  Internet-Draft        LinuxSampler Contr Line 9404  Internet-Draft        LinuxSampler Contr
9404    
9405    
9406    
9407    Schoenebeck               Expires July 13, 2014               [Page 168]
9408    
9409    Internet-Draft        LinuxSampler Control Protocol         January 2014
9410    
9411    
9412    8.20.  Global settings changed
9413    
9414       Client may want to be notified when changes to the global settings of
9415       the sampler were made by issuing the following command:
9416    
9417          SUBSCRIBE GLOBAL_INFO
9418    
9419       Server will start sending the following types of notification
9420       messages:
9421    
9422          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
9423          volume of the sampler is changed, where <volume> will be replaced
9424          by the optional dotted floating point value, reflecting the new
9425          global volume parameter.
9426    
9427          "NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the
9428          golbal limit of the sampler for maximum voices is changed, where
9429          <max-voices> will be an integer value, reflecting the new global
9430          voice limit parameter.
9431    
9432          "NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the
9433          golbal limit of the sampler for maximum disk streams is changed,
9434          where <max-streams> will be an integer value, reflecting the new
9435          global disk streams limit parameter.
9436    
9437    8.21.  Number of database instrument directories changed
9438    
9439       Client may want to be notified when the number of instrument
9440       directories in a particular directory in the instruments database is
9441       changed by issuing the following command:
9442    
9443          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
9444    
9445       Server will start sending the following notification messages:
9446    
9447          "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
9448    
9449       where <dir-path> will be replaced by the absolute path name of the
9450       directory in the instruments database, in which the number of
9451       directories is changed.
9452    
9453       Note that when a non-empty directory is removed, this event is not
9454       sent for the subdirectories in that directory.
9455    
9456    8.22.  Database instrument directory information changed
9457    
9458       Client may want to be notified when changes were made to directories
9459       in the instruments database by issuing the following command:
9460    
9461    
9462    
9463    Schoenebeck               Expires July 13, 2014               [Page 169]
9464    
9465    Internet-Draft        LinuxSampler Control Protocol         January 2014
9466    
9467    
9468          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
9469    
9470       Server will start sending the following notification messages:
9471    
9472          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
9473    
9474       where <dir-path> will be replaced by the absolute path name of the
9475       directory, for which information changes occurred.  The front-end
9476       will have to send the respective command to actually get the updated
9477       directory info.  Because these messages will be triggered by LSCP
9478       commands issued by other clients rather than real time events
9479       happening on the server, it is believed that an empty notification
9480       message is sufficient here.
9481    
9482          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
9483          name>"
9484    
9485       where <old-dir-path> is the old absolute path name of the directory
9486       (encapsulated into apostrophes), which name is changes and <new-name>
9487       is the new name of the directory, encapsulated into apostrophes.
9488    
9489    8.23.  Number of database instruments changed
9490    
9491       Client may want to be notified when the number of instruments in a
9492       particular directory in the instruments database is changed by
9493       issuing the following command:
9494    
9495          SUBSCRIBE DB_INSTRUMENT_COUNT
9496    
9497       Server will start sending the following notification messages:
9498    
9499          "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
9500    
9501       where <dir-path> will be replaced by the absolute path name of the
9502       directory in the instruments database, in which the number of
9503       instruments is changed.
9504    
9505       Note that when a non-empty directory is removed, this event is not
9506       sent for the instruments in that directory.
9507    
9508    8.24.  Database instrument information changed
9509    
9510       Client may want to be notified when changes were made to instruments
9511       in the instruments database by issuing the following command:
9512    
9513          SUBSCRIBE DB_INSTRUMENT_INFO
9514    
9515       Server will start sending the following notification messages:
9516    
9517    
9518    
9519    Schoenebeck               Expires July 13, 2014               [Page 170]
9520    
9521    Internet-Draft        LinuxSampler Control Protocol         January 2014
9522    
9523    
9524          "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
9525    
9526       where <instr-path> will be replaced by the absolute path name of the
9527       instrument, which settings are changed.  The front-end will have to
9528       send the respective command to actually get the updated directory
9529       info.  Because these messages will be triggered by LSCP commands
9530       issued by other clients rather than real time events happening on the
9531       server, it is believed that an empty notification message is
9532       sufficient here.
9533    
9534          "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
9535    
9536       where <old-instr-path> is the old absolute path name of the
9537       instrument (encapsulated into apostrophes), which name is changes and
9538       <new-name> is the new name of the instrument, encapsulated into
9539       apostrophes.
9540    
9541    8.25.  Database job status information changed
9542    
9543       Client may want to be notified when the status of particular database
9544       instruments job is changed by issuing the following command:
9545    
9546          SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
9547    
9548       Server will start sending the following notification messages:
9549    
9550          "NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"
9551    
9552       where <job-id> will be replaced by the numerical ID of the job, which
9553       status is changed.  The front-end will have to send the respective
9554       command to actually get the status info.  Because these messages will
9555       be triggered by LSCP commands issued by other clients rather than
9556       real time events happening on the server, it is believed that an
9557       empty notification message is sufficient here.
9558    
9559    8.26.  Number of effect instances changed
9560    
9561       Client may want to be notified when the number of effect instances is
9562       changed by issuing the following command:
9563    
9564          SUBSCRIBE EFFECT_INSTANCE_COUNT
9565    
9566       Server will start sending the following notification messages:
9567    
9568          "EFFECT_INSTANCE_COUNT:<instances>"
9569    
9570       where <instances> will be replaced by the new number of effect
9571       instances.
9572    
9573    
9574    
9575  Schoenebeck               Expires July 2, 2007                 [Page 98]  Schoenebeck               Expires July 13, 2014               [Page 171]
9576    
9577  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9578    
9579    
9580    8.27.  Effect instance information changed
9581    
9582       Client may want to be notified when changes were made to effect
9583       instances on the back-end by issuing the following command:
9584    
9585          SUBSCRIBE EFFECT_INSTANCE_INFO
9586    
9587       Server will start sending the following notification messages:
9588    
9589          "EFFECT_INSTANCE_INFO:<instance-id>"
9590    
9591       where <instance-id> will be replaced by the numerical ID of the
9592       effect instance.
9593    
9594    8.28.  Number of send effect chains changed
9595    
9596       Client may want to be notified when the number of send effect chains
9597       is changed by issuing the following command:
9598    
9599          SUBSCRIBE SEND_EFFECT_CHAIN_COUNT
9600    
9601       Server will start sending the following notification messages:
9602    
9603          "NOTIFY:SEND_EFFECT_CHAIN_COUNT:<device-id> <chains>"
9604    
9605       where <device-id> will be replaced by the numerical ID of the audio
9606       output device, in which the number of send effect chains is changed
9607       and <chains> will be replaced by the new number of send effect
9608       chains.
9609    
9610    8.29.  Send effect chain information changed
9611    
9612  8.15.  Miscellaneous and debugging events     Client may want to be notified when changes were made to send effect
9613       chains on the back-end by issuing the following command:
9614    
9615          SUBSCRIBE SEND_EFFECT_CHAIN_INFO
9616    
9617       Server will start sending the following notification messages:
9618    
9619          "SEND_EFFECT_CHAIN_INFO:<device-id> <chain-id> <instances>" -
9620          Notifies that the number of effect instances in a particular send
9621          effect chain is changed, where <device-id> will be replaced by the
9622          numerical ID of the audio output device the send effect chain
9623          belongs to, <chain-id> will be replaced by the numerical ID of the
9624          send effect chain in which the number of effect instances has
9625          changed and <instances> will be replaced by the new number of
9626          effect instances in the specified send effect chain.
9627    
9628    
9629    
9630    
9631    Schoenebeck               Expires July 13, 2014               [Page 172]
9632    
9633    Internet-Draft        LinuxSampler Control Protocol         January 2014
9634    
9635    
9636    8.30.  Miscellaneous and debugging events
9637    
9638     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
9639     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 5540  Internet-Draft        LinuxSampler Contr Line 9684  Internet-Draft        LinuxSampler Contr
9684    
9685    
9686    
9687  Schoenebeck               Expires July 2, 2007                 [Page 99]  Schoenebeck               Expires July 13, 2014               [Page 173]
9688    
9689  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9690    
9691    
9692  9.  Security Considerations  9.  Security Considerations
# Line 5596  Internet-Draft        LinuxSampler Contr Line 9740  Internet-Draft        LinuxSampler Contr
9740    
9741    
9742    
9743  Schoenebeck               Expires July 2, 2007                [Page 100]  Schoenebeck               Expires July 13, 2014               [Page 174]
9744    
9745  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9746    
9747    
9748  10.  Acknowledgments  10.  Acknowledgments
# Line 5652  Internet-Draft        LinuxSampler Contr Line 9796  Internet-Draft        LinuxSampler Contr
9796    
9797    
9798    
9799  Schoenebeck               Expires July 2, 2007                [Page 101]  Schoenebeck               Expires July 13, 2014               [Page 175]
9800    
9801  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9802    
9803    
9804  11.  References  11.  References
9805    
9806       [RFC20]    UCLA, "ASCII format for Network Interchange", RFC 20,
9807                  1969.
9808    
9809     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
9810                Requirement Levels", RFC 2119, 1997.                Requirement Levels", RFC 2119, 1997.
9811    
# Line 5705  Internet-Draft        LinuxSampler Contr Line 9852  Internet-Draft        LinuxSampler Contr
9852    
9853    
9854    
9855    Schoenebeck               Expires July 13, 2014               [Page 176]
   
   
 Schoenebeck               Expires July 2, 2007                [Page 102]  
9856    
9857  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9858    
9859    
9860  Author's Address  Author's Address
9861    
9862     C. Schoenebeck     C. Schoenebeck
9863     Interessengemeinschaft Software Engineering e. V.     LinuxSampler.org
9864     Max-Planck-Str. 39     Crudebyte Engineering
9865     74081 Heilbronn     Hofgartenstr. 3
9866       74189 Weinsberg
9867     Germany     Germany
9868    
9869     Email: schoenebeck at software minus engineering dot org     Phone: +49 7134 911614
9870       Email: cuse@users.sf.net
9871    
9872    
9873    
# Line 5762  Author's Address Line 9908  Author's Address
9908    
9909    
9910    
9911    Schoenebeck               Expires July 13, 2014               [Page 177]
   
 Schoenebeck               Expires July 2, 2007                [Page 103]  
9912    
9913  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2014
9914    
9915    
9916  Full Copyright Statement  Full Copyright Statement
9917    
9918     Copyright (C) The Internet Society (2006).     Copyright (C) The IETF Trust (2014).
9919    
9920     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
9921     contained in BCP 78, and except as set forth therein, the authors     contained in BCP 78, and except as set forth therein, the authors
# Line 5779  Full Copyright Statement Line 9923  Full Copyright Statement
9923    
9924     This document and the information contained herein are provided on an     This document and the information contained herein are provided on an
9925     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
9926     OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET     OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
9927     ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,     THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
9928     INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE     OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
9929     INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED     THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
9930     WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.     WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
9931    
9932    
# Line 5811  Intellectual Property Line 9955  Intellectual Property
9955     ietf-ipr@ietf.org.     ietf-ipr@ietf.org.
9956    
9957    
 Acknowledgment  
9958    
    Funding for the RFC Editor function is provided by the IETF  
    Administrative Support Activity (IASA).  
9959    
9960    
9961    
9962    
9963    
9964  Schoenebeck               Expires July 2, 2007                [Page 104]  
9965    
9966    
9967    Schoenebeck               Expires July 13, 2014               [Page 178]
9968    
Legend:
Removed from v.1006  
changed lines
  Added in v.2498
  ViewVC Help
Powered by ViewVC