/[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 1773 by iliev, Wed Sep 10 15:14:31 2008 UTC revision 2139 by schoenebeck, Mon Oct 4 22:17:58 2010 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: March 14, 2009                               September 10, 2008  Expires: April 8, 2011                                   October 5, 2010
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.4                                  LSCP 1.5
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 April 8, 2011.
    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 March 14, 2009.  
41    
 Copyright Notice  
42    
    Copyright (C) The IETF Trust (2008).  
43    
44    
45    
# Line 50  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55    Schoenebeck               Expires April 8, 2011                 [Page 1]
56    
57    Internet-Draft        LinuxSampler Control Protocol         October 2010
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 April 8, 2011                 [Page 2]
112    
113    Internet-Draft        LinuxSampler Control Protocol         October 2010
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  . . . . . . . .  50
125           6.4.11.  Current number of active voices  . . . . . . . . . .  53
126           6.4.12.  Current number of active disk streams  . . . . . . .  54
127           6.4.13.  Current fill state of disk stream buffers  . . . . .  54
128           6.4.14.  Setting audio output device  . . . . . . . . . . . .  55
129           6.4.15.  Setting audio output type  . . . . . . . . . . . . .  56
130           6.4.16.  Setting audio output channel . . . . . . . . . . . .  57
131           6.4.17.  Setting MIDI input device  . . . . . . . . . . . . .  58
132           6.4.18.  Setting MIDI input type  . . . . . . . . . . . . . .  58
133           6.4.19.  Setting MIDI input port  . . . . . . . . . . . . . .  59
134           6.4.20.  Setting MIDI input channel . . . . . . . . . . . . .  60
135           6.4.21.  Setting channel volume . . . . . . . . . . . . . . .  60
136           6.4.22.  Muting a sampler channel . . . . . . . . . . . . . .  61
137           6.4.23.  Soloing a sampler channel  . . . . . . . . . . . . .  62
138           6.4.24.  Assigning a MIDI instrument map to a sampler
139                    channel  . . . . . . . . . . . . . . . . . . . . . .  62
140           6.4.25.  Adding an effect send to a sampler channel . . . . .  63
141           6.4.26.  Removing an effect send from a sampler channel . . .  65
142           6.4.27.  Getting amount of effect sends on a sampler
143                    channel  . . . . . . . . . . . . . . . . . . . . . .  65
144           6.4.28.  Listing all effect sends on a sampler channel  . . .  66
145           6.4.29.  Getting effect send information  . . . . . . . . . .  66
146           6.4.30.  Changing effect send's name  . . . . . . . . . . . .  68
147           6.4.31.  Altering effect send's audio routing . . . . . . . .  69
148           6.4.32.  Assigning destination effect to an effect send . . .  70
149           6.4.33.  Removing destination effect from an effect send  . .  71
150           6.4.34.  Altering effect send's MIDI controller . . . . . . .  71
151           6.4.35.  Altering effect send's send level  . . . . . . . . .  72
152           6.4.36.  Sending MIDI messages to sampler channel . . . . . .  73
153           6.4.37.  Resetting a sampler channel  . . . . . . . . . . . .  74
154         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  75
155           6.5.1.   Register front-end for receiving event messages  . .  75
156           6.5.2.   Unregister front-end for not receiving event
157                    messages . . . . . . . . . . . . . . . . . . . . . .  75
158           6.5.3.   Enable or disable echo of commands . . . . . . . . .  76
159           6.5.4.   Close client connection  . . . . . . . . . . . . . .  77
160         6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  77
161           6.6.1.   Current number of active voices  . . . . . . . . . .  77
162           6.6.2.   Maximum amount of active voices  . . . . . . . . . .  77
163           6.6.3.   Current number of active disk streams  . . . . . . .  77
164    
165    
166    
167    Schoenebeck               Expires April 8, 2011                 [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol         October 2010
170    
171    
172           6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  78
173           6.6.5.   General sampler informations . . . . . . . . . . . .  78
174           6.6.6.   Getting global volume attenuation  . . . . . . . . .  79
175           6.6.7.   Setting global volume attenuation  . . . . . . . . .  79
176           6.6.8.   Getting global voice limit . . . . . . . . . . . . .  80
177           6.6.9.   Setting global voice limit . . . . . . . . . . . . .  80
178           6.6.10.  Getting global disk stream limit . . . . . . . . . .  81
179           6.6.11.  Setting global disk stream limit . . . . . . . . . .  81
180         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  82
181           6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  83
182           6.7.2.   Delete one particular or all MIDI instrument maps  .  84
183           6.7.3.   Get amount of existing MIDI instrument maps  . . . .  84
184           6.7.4.   Getting all created MIDI instrument maps . . . . . .  85
185           6.7.5.   Getting MIDI instrument map information  . . . . . .  85
186           6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  86
187           6.7.7.   Create or replace a MIDI instrument map entry  . . .  87
188           6.7.8.   Getting ammount of MIDI instrument map entries . . .  89
189           6.7.9.   Getting indeces of all entries of a MIDI
190                    instrument map . . . . . . . . . . . . . . . . . . .  90
191           6.7.10.  Remove an entry from the MIDI instrument map . . . .  91
192           6.7.11.  Get current settings of MIDI instrument map entry  .  91
193           6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  93
194         6.8.  Managing Instruments Database . . . . . . . . . . . . . .  94
195           6.8.1.   Creating a new instrument directory  . . . . . . . .  94
196           6.8.2.   Deleting an instrument directory . . . . . . . . . .  95
197           6.8.3.   Getting amount of instrument directories . . . . . .  95
198           6.8.4.   Listing all directories in specific directory  . . .  96
199           6.8.5.   Getting instrument directory information . . . . . .  97
200           6.8.6.   Renaming an instrument directory . . . . . . . . . .  98
201           6.8.7.   Moving an instrument directory . . . . . . . . . . .  98
202           6.8.8.   Copying instrument directories . . . . . . . . . . .  99
203           6.8.9.   Changing the description of directory  . . . . . . . 100
204           6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 100
205           6.8.11.  Adding instruments to the instruments database . . . 102
206           6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 103
207           6.8.13.  Getting amount of instruments  . . . . . . . . . . . 104
208           6.8.14.  Listing all instruments in specific directory  . . . 104
209           6.8.15.  Getting instrument information . . . . . . . . . . . 105
210           6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 107
211           6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 108
212           6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 109
213           6.8.19.  Changing the description of instrument . . . . . . . 109
214           6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 110
215           6.8.21.  Getting job status information . . . . . . . . . . . 112
216           6.8.22.  Formatting the instruments database  . . . . . . . . 113
217           6.8.23.  Checking for lost instrument files . . . . . . . . . 114
218           6.8.24.  Replacing an instrument file . . . . . . . . . . . . 114
219         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 115
220    
221    
222    
223    Schoenebeck               Expires April 8, 2011                 [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol         October 2010
226    
227    
228           6.9.1.   Opening an appropriate instrument editor
229                    application  . . . . . . . . . . . . . . . . . . . . 115
230         6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 116
231           6.10.1.  Retrieving amount of instruments of a file . . . . . 116
232           6.10.2.  Retrieving all instruments of a file . . . . . . . . 117
233           6.10.3.  Retrieving informations about one instrument in a
234                    file . . . . . . . . . . . . . . . . . . . . . . . . 117
235         6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 119
236           6.11.1.  Retrieve amount of available effects . . . . . . . . 120
237           6.11.2.  Get list of available effects  . . . . . . . . . . . 120
238           6.11.3.  Retrieving general information about an effect . . . 121
239           6.11.4.  Creating an instance of an effect by its portable
240                    ID . . . . . . . . . . . . . . . . . . . . . . . . . 122
241           6.11.5.  Creating an instance of an effect by its
242                    numerical ID . . . . . . . . . . . . . . . . . . . . 123
243           6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 124
244           6.11.7.  Retrieve amount of effect instances  . . . . . . . . 125
245           6.11.8.  Get list of effect instances . . . . . . . . . . . . 125
246           6.11.9.  Retrieving current information about an effect
247                    instance . . . . . . . . . . . . . . . . . . . . . . 125
248           6.11.10. Retrieving information about an effect parameter . . 127
249           6.11.11. Altering an effect parameter . . . . . . . . . . . . 129
250           6.11.12. Retrieve amount of send effect chains  . . . . . . . 129
251           6.11.13. Retrieve list of send effect chains  . . . . . . . . 130
252           6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 130
253           6.11.15. Remove send effect chain . . . . . . . . . . . . . . 131
254           6.11.16. Retrieving information about a send effect chain . . 132
255           6.11.17. Append effect instance to a send effect chain  . . . 133
256           6.11.18. Insert effect instance to a send effect chain  . . . 133
257           6.11.19. Remove effect instance from send effect chain  . . . 134
258       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 136
259         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 152
260       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
261         8.1.  Number of audio output devices changed  . . . . . . . . . 157
262         8.2.  Audio output device's settings changed  . . . . . . . . . 157
263         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 157
264         8.4.  MIDI input device's settings changed  . . . . . . . . . . 158
265         8.5.  Number of sampler channels changed  . . . . . . . . . . . 158
266         8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 158
267         8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 159
268         8.8.  Number of active voices changed . . . . . . . . . . . . . 159
269         8.9.  Number of active disk streams changed . . . . . . . . . . 160
270         8.10. Disk stream buffer fill state changed . . . . . . . . . . 160
271         8.11. Channel information changed . . . . . . . . . . . . . . . 160
272         8.12. Number of effect sends changed  . . . . . . . . . . . . . 161
273         8.13. Effect send information changed . . . . . . . . . . . . . 161
274         8.14. Total number of active voices changed . . . . . . . . . . 162
275         8.15. Total number of active disk streams changed . . . . . . . 162
276    
277    
278    
279    Schoenebeck               Expires April 8, 2011                 [Page 5]
280    
281    Internet-Draft        LinuxSampler Control Protocol         October 2010
282    
283    
284         8.16. Number of MIDI instrument maps changed  . . . . . . . . . 162
285         8.17. MIDI instrument map information changed . . . . . . . . . 162
286         8.18. Number of MIDI instruments changed  . . . . . . . . . . . 163
287         8.19. MIDI instrument information changed . . . . . . . . . . . 163
288         8.20. Global settings changed . . . . . . . . . . . . . . . . . 164
289         8.21. Number of database instrument directories changed . . . . 164
290         8.22. Database instrument directory information changed . . . . 164
291         8.23. Number of database instruments changed  . . . . . . . . . 165
292         8.24. Database instrument information changed . . . . . . . . . 165
293         8.25. Database job status information changed . . . . . . . . . 166
294         8.26. Miscellaneous and debugging events  . . . . . . . . . . . 166
295       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 168
296       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 169
297       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 170
298       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 171
299       Intellectual Property and Copyright Statements  . . . . . . . . . 172
300    
301    
302    
303    
304    
305    
306    
307    
 Schoenebeck              Expires March 14, 2009                 [Page 1]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
308    
309    
 Abstract  
310    
    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.  
311    
312    
 Table of Contents  
313    
    1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6  
    2.  Versioning of this specification  . . . . . . . . . . . . . .   7  
    3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8  
    4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9  
    5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10  
      5.1.  Request/response communication method . . . . . . . . . .  10  
        5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11  
      5.2.  Subscribe/notify communication method . . . . . . . . . .  13  
    6.  Description for control commands  . . . . . . . . . . . . . .  15  
      6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15  
      6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15  
        6.2.1.  Getting amount of available audio output drivers  . .  16  
        6.2.2.  Getting all available audio output drivers  . . . . .  16  
        6.2.3.  Getting information about a specific audio output  
                driver  . . . . . . . . . . . . . . . . . . . . . . .  16  
        6.2.4.  Getting information about specific audio output  
                driver parameter  . . . . . . . . . . . . . . . . . .  17  
        6.2.5.  Creating an audio output device . . . . . . . . . . .  21  
        6.2.6.  Destroying an audio output device . . . . . . . . . .  22  
        6.2.7.  Getting all created audio output device count . . . .  23  
        6.2.8.  Getting all created audio output device list  . . . .  23  
        6.2.9.  Getting current settings of an audio output device  .  23  
        6.2.10. Changing settings of audio output devices . . . . . .  25  
        6.2.11. Getting information about an audio channel  . . . . .  26  
        6.2.12. Getting information about specific audio channel  
                parameter . . . . . . . . . . . . . . . . . . . . . .  27  
        6.2.13. Changing settings of audio output channels  . . . . .  29  
      6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30  
        6.3.1.  Getting amount of available MIDI input drivers  . . .  31  
        6.3.2.  Getting all available MIDI input drivers  . . . . . .  31  
        6.3.3.  Getting information about a specific MIDI input  
                driver  . . . . . . . . . . . . . . . . . . . . . . .  32  
        6.3.4.  Getting information about specific MIDI input  
                driver parameter  . . . . . . . . . . . . . . . . . .  33  
        6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35  
        6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36  
        6.3.7.  Getting all created MIDI input device count . . . . .  37  
   
   
   
 Schoenebeck              Expires March 14, 2009                 [Page 2]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
        6.3.8.  Getting all created MIDI input device list  . . . . .  37  
        6.3.9.  Getting current settings of a MIDI input device . . .  38  
        6.3.10. Changing settings of MIDI input devices . . . . . . .  39  
        6.3.11. Getting information about a MIDI port . . . . . . . .  39  
        6.3.12. Getting information about specific MIDI port  
                parameter . . . . . . . . . . . . . . . . . . . . . .  40  
        6.3.13. Changing settings of MIDI input ports . . . . . . . .  42  
      6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43  
        6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43  
        6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44  
        6.4.3.  Getting all created sampler channel count . . . . . .  45  
        6.4.4.  Getting all created sampler channel list  . . . . . .  46  
        6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46  
        6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47  
        6.4.7.  Getting amount of available engines . . . . . . . . .  48  
        6.4.8.  Getting all available engines . . . . . . . . . . . .  48  
        6.4.9.  Getting information about an engine . . . . . . . . .  48  
        6.4.10. Getting sampler channel information . . . . . . . . .  49  
        6.4.11. Current number of active voices . . . . . . . . . . .  52  
        6.4.12. Current number of active disk streams . . . . . . . .  53  
        6.4.13. Current fill state of disk stream buffers . . . . . .  53  
        6.4.14. Setting audio output device . . . . . . . . . . . . .  54  
        6.4.15. Setting audio output type . . . . . . . . . . . . . .  55  
        6.4.16. Setting audio output channel  . . . . . . . . . . . .  56  
        6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56  
        6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57  
        6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58  
        6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58  
        6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59  
        6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60  
        6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  61  
        6.4.24. Assigning a MIDI instrument map to a sampler  
                channel . . . . . . . . . . . . . . . . . . . . . . .  61  
        6.4.25. Adding an effect send to a sampler channel  . . . . .  62  
        6.4.26. Removing an effect send from a sampler channel  . . .  64  
        6.4.27. Getting amount of effect sends on a sampler channel .  64  
        6.4.28. Listing all effect sends on a sampler channel . . . .  65  
        6.4.29. Getting effect send information . . . . . . . . . . .  65  
        6.4.30. Changing effect send's name . . . . . . . . . . . . .  67  
        6.4.31. Altering effect send's audio routing  . . . . . . . .  67  
        6.4.32. Altering effect send's MIDI controller  . . . . . . .  68  
        6.4.33. Altering effect send's send level . . . . . . . . . .  69  
        6.4.34. Sending MIDI messages to sampler channel  . . . . . .  70  
        6.4.35. Resetting a sampler channel . . . . . . . . . . . . .  71  
      6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  72  
        6.5.1.  Register front-end for receiving event messages . . .  72  
        6.5.2.  Unregister front-end for not receiving event  
                messages  . . . . . . . . . . . . . . . . . . . . . .  72  
   
   
   
 Schoenebeck              Expires March 14, 2009                 [Page 3]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
        6.5.3.  Enable or disable echo of commands  . . . . . . . . .  73  
        6.5.4.  Close client connection . . . . . . . . . . . . . . .  74  
      6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  74  
        6.6.1.  Current number of active voices . . . . . . . . . . .  74  
        6.6.2.  Maximum amount of active voices . . . . . . . . . . .  74  
        6.6.3.  Current number of active disk streams . . . . . . . .  74  
        6.6.4.  Reset sampler . . . . . . . . . . . . . . . . . . . .  75  
        6.6.5.  General sampler informations  . . . . . . . . . . . .  75  
        6.6.6.  Getting global volume attenuation . . . . . . . . . .  76  
        6.6.7.  Setting global volume attenuation . . . . . . . . . .  76  
      6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  77  
        6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  77  
        6.7.2.  Delete one particular or all MIDI instrument maps . .  78  
        6.7.3.  Get amount of existing MIDI instrument maps . . . . .  79  
        6.7.4.  Getting all created MIDI instrument maps  . . . . . .  79  
        6.7.5.  Getting MIDI instrument map information . . . . . . .  80  
        6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  81  
        6.7.7.  Create or replace a MIDI instrument map entry . . . .  81  
        6.7.8.  Getting ammount of MIDI instrument map entries  . . .  84  
        6.7.9.  Getting indeces of all entries of a MIDI  
                instrument map  . . . . . . . . . . . . . . . . . . .  85  
        6.7.10. Remove an entry from the MIDI instrument map  . . . .  85  
        6.7.11. Get current settings of MIDI instrument map entry . .  86  
        6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  88  
      6.8.  Managing Instruments Database . . . . . . . . . . . . . .  89  
        6.8.1.  Creating a new instrument directory . . . . . . . . .  89  
        6.8.2.  Deleting an instrument directory  . . . . . . . . . .  89  
        6.8.3.  Getting amount of instrument directories  . . . . . .  90  
        6.8.4.  Listing all directories in specific directory . . . .  91  
        6.8.5.  Getting instrument directory information  . . . . . .  91  
        6.8.6.  Renaming an instrument directory  . . . . . . . . . .  92  
        6.8.7.  Moving an instrument directory  . . . . . . . . . . .  93  
        6.8.8.  Copying instrument directories  . . . . . . . . . . .  94  
        6.8.9.  Changing the description of directory . . . . . . . .  94  
        6.8.10. Finding directories . . . . . . . . . . . . . . . . .  95  
        6.8.11. Adding instruments to the instruments database  . . .  96  
        6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  98  
        6.8.13. Getting amount of instruments . . . . . . . . . . . .  98  
        6.8.14. Listing all instruments in specific directory . . . .  99  
        6.8.15. Getting instrument information  . . . . . . . . . . . 100  
        6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 102  
        6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 103  
        6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 103  
        6.8.19. Changing the description of instrument  . . . . . . . 104  
        6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 104  
        6.8.21. Getting job status information  . . . . . . . . . . . 107  
        6.8.22. Formatting the instruments database . . . . . . . . . 108  
        6.8.23. Checking for lost instrument files  . . . . . . . . . 108  
   
   
   
 Schoenebeck              Expires March 14, 2009                 [Page 4]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
        6.8.24. Replacing an instrument file  . . . . . . . . . . . . 109  
      6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 109  
        6.9.1.  Opening an appropriate instrument editor  
                application . . . . . . . . . . . . . . . . . . . . . 110  
      6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 111  
        6.10.1. Retrieving amount of instruments of a file  . . . . . 111  
        6.10.2. Retrieving all instruments of a file  . . . . . . . . 111  
        6.10.3. Retrieving informations about one instrument in a  
                file  . . . . . . . . . . . . . . . . . . . . . . . . 112  
    7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 115  
      7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 129  
    8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 133  
      8.1.  Number of audio output devices changed  . . . . . . . . . 133  
      8.2.  Audio output device's settings changed  . . . . . . . . . 133  
      8.3.  Number of MIDI input devices changed  . . . . . . . . . . 133  
      8.4.  MIDI input device's settings changed  . . . . . . . . . . 134  
      8.5.  Number of sampler channels changed  . . . . . . . . . . . 134  
      8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 134  
      8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 135  
      8.8.  Number of active voices changed . . . . . . . . . . . . . 135  
      8.9.  Number of active disk streams changed . . . . . . . . . . 136  
      8.10. Disk stream buffer fill state changed . . . . . . . . . . 136  
      8.11. Channel information changed . . . . . . . . . . . . . . . 136  
      8.12. Number of effect sends changed  . . . . . . . . . . . . . 137  
      8.13. Effect send information changed . . . . . . . . . . . . . 137  
      8.14. Total number of active voices changed . . . . . . . . . . 138  
      8.15. Total number of active disk streams changed . . . . . . . 138  
      8.16. Number of MIDI instrument maps changed  . . . . . . . . . 138  
      8.17. MIDI instrument map information changed . . . . . . . . . 138  
      8.18. Number of MIDI instruments changed  . . . . . . . . . . . 139  
      8.19. MIDI instrument information changed . . . . . . . . . . . 139  
      8.20. Global settings changed . . . . . . . . . . . . . . . . . 140  
      8.21. Number of database instrument directories changed . . . . 140  
      8.22. Database instrument directory information changed . . . . 140  
      8.23. Number of database instruments changed  . . . . . . . . . 141  
      8.24. Database instrument information changed . . . . . . . . . 141  
      8.25. Database job status information changed . . . . . . . . . 142  
      8.26. Miscellaneous and debugging events  . . . . . . . . . . . 142  
    9.  Security Considerations . . . . . . . . . . . . . . . . . . . 143  
    10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 144  
    11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 145  
    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 146  
    Intellectual Property and Copyright Statements  . . . . . . . . . 147  
314    
315    
316    
# Line 276  Internet-Draft        LinuxSampler Contr Line 319  Internet-Draft        LinuxSampler Contr
319    
320    
321    
322  Schoenebeck              Expires March 14, 2009                 [Page 5]  
323    
324    
325    
326    
327    
328    
329    
330    
331    
332    
333    
334    
335    Schoenebeck               Expires April 8, 2011                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
338    
339    
340  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck              Expires March 14, 2009                 [Page 6]  Schoenebeck               Expires April 8, 2011                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
394    
395    
396  2.  Versioning of this specification  2.  Versioning of this specification
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck              Expires March 14, 2009                 [Page 7]  Schoenebeck               Expires April 8, 2011                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
450    
451    
452  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck              Expires March 14, 2009                 [Page 8]  Schoenebeck               Expires April 8, 2011                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
506    
507    
508  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck              Expires March 14, 2009                 [Page 9]  Schoenebeck               Expires April 8, 2011                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
562    
563    
564  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck              Expires March 14, 2009                [Page 10]  Schoenebeck               Expires April 8, 2011                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
618    
619    
620  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck              Expires March 14, 2009                [Page 11]  Schoenebeck               Expires April 8, 2011                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
674    
675    
676     set has the following format:     set has the following format:
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck              Expires March 14, 2009                [Page 12]  Schoenebeck               Expires April 8, 2011                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
730    
731    
732     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck              Expires March 14, 2009                [Page 13]  Schoenebeck               Expires April 8, 2011                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
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 780  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck              Expires March 14, 2009                [Page 14]  Schoenebeck               Expires April 8, 2011                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
842    
843    
844  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck              Expires March 14, 2009                [Page 15]  Schoenebeck               Expires April 8, 2011                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
898    
899    
900  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck              Expires March 14, 2009                [Page 16]  Schoenebeck               Expires April 8, 2011                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
954    
955    
956        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck              Expires March 14, 2009                [Page 17]  Schoenebeck               Expires April 8, 2011                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1010    
1011    
1012     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck              Expires March 14, 2009                [Page 18]  Schoenebeck               Expires April 8, 2011                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1066    
1067    
1068        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck              Expires March 14, 2009                [Page 19]  Schoenebeck               Expires April 8, 2011                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1122    
1123    
1124           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck              Expires March 14, 2009                [Page 20]  Schoenebeck               Expires April 8, 2011                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1178    
1179    
1180           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck              Expires March 14, 2009                [Page 21]  Schoenebeck               Expires April 8, 2011                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1234    
1235    
1236           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck              Expires March 14, 2009                [Page 22]  Schoenebeck               Expires April 8, 2011                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1290    
1291    
1292        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck              Expires March 14, 2009                [Page 23]  Schoenebeck               Expires April 8, 2011                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1346    
1347    
1348     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck              Expires March 14, 2009                [Page 24]  Schoenebeck               Expires April 8, 2011                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1402    
1403    
1404           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck              Expires March 14, 2009                [Page 25]  Schoenebeck               Expires April 8, 2011                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1458    
1459    
1460  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck              Expires March 14, 2009                [Page 26]  Schoenebeck               Expires April 8, 2011                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1514    
1515    
1516     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck              Expires March 14, 2009                [Page 27]  Schoenebeck               Expires April 8, 2011                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1570    
1571    
1572     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck              Expires March 14, 2009                [Page 28]  Schoenebeck               Expires April 8, 2011                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1626    
1627    
1628           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck              Expires March 14, 2009                [Page 29]  Schoenebeck               Expires April 8, 2011                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1682    
1683    
1684        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck              Expires March 14, 2009                [Page 30]  Schoenebeck               Expires April 8, 2011                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1738    
1739    
1740     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck              Expires March 14, 2009                [Page 31]  Schoenebeck               Expires April 8, 2011                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
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 1788  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck              Expires March 14, 2009                [Page 32]  Schoenebeck               Expires April 8, 2011                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
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 1844  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck              Expires March 14, 2009                [Page 33]  Schoenebeck               Expires April 8, 2011                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1906    
1907    
1908        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck              Expires March 14, 2009                [Page 34]  Schoenebeck               Expires April 8, 2011                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
1962    
1963    
1964           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck              Expires March 14, 2009                [Page 35]  Schoenebeck               Expires April 8, 2011                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2018    
2019    
2020        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck              Expires March 14, 2009                [Page 36]  Schoenebeck               Expires April 8, 2011                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2074    
2075    
2076           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck              Expires March 14, 2009                [Page 37]  Schoenebeck               Expires April 8, 2011                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
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 2124  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck              Expires March 14, 2009                [Page 38]  Schoenebeck               Expires April 8, 2011                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2186    
2187    
2188           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck              Expires March 14, 2009                [Page 39]  Schoenebeck               Expires April 8, 2011                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
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 2236  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck              Expires March 14, 2009                [Page 40]  Schoenebeck               Expires April 8, 2011                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2298    
2299    
2300        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck              Expires March 14, 2009                [Page 41]  Schoenebeck               Expires April 8, 2011                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2354    
2355    
2356           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck              Expires March 14, 2009                [Page 42]  Schoenebeck               Expires April 8, 2011                [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2410    
2411    
2412        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck              Expires March 14, 2009                [Page 43]  Schoenebeck               Expires April 8, 2011                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
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
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck              Expires March 14, 2009                [Page 44]  Schoenebeck               Expires April 8, 2011                [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
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
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck              Expires March 14, 2009                [Page 45]  Schoenebeck               Expires April 8, 2011                [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2578    
2579    
2580  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck              Expires March 14, 2009                [Page 46]  Schoenebeck               Expires April 8, 2011                [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
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
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck              Expires March 14, 2009                [Page 47]  Schoenebeck               Expires April 8, 2011                [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2690    
2691    
2692  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck              Expires March 14, 2009                [Page 48]  Schoenebeck               Expires April 8, 2011                [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2746    
2747    
2748     Possible Answers:     Possible Answers:
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck              Expires March 14, 2009                [Page 49]  Schoenebeck               Expires April 8, 2011                [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2802    
2803    
2804        following categories are defined:        following categories are defined:
# Line 2759  Internet-Draft        LinuxSampler Contr Line 2815  Internet-Draft        LinuxSampler Contr
2815    
2816              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2817              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2818              signal, "NONE" if there's no device connected to this              signal, "-1" if there's no device connected to this sampler
2819              sampler channel              channel
2820    
2821           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2822    
# Line 2785  Internet-Draft        LinuxSampler Contr Line 2841  Internet-Draft        LinuxSampler Contr
2841    
2842           INSTRUMENT_NR -           INSTRUMENT_NR -
2843    
2844              the instrument index number of the loaded instrument              the instrument index number of the loaded instrument, "-1"
2845                if there's no instrument loaded for this sampler channel
2846    
2847           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2848    
# Line 2795  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855    Schoenebeck               Expires April 8, 2011                [Page 51]
 Schoenebeck              Expires March 14, 2009                [Page 50]  
2856    
2857  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2858    
2859    
2860           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2861    
2862              integer values 0 to 100 indicating loading progress              Integer values 0 to 100 indicating loading progress
2863              percentage for the instrument.  Negative value indicates a              percentage for the instrument.  Negative value indicates a
2864              loading exception.  Value of 100 indicates that the              loading exception (also returns "-1" in case no instrument
2865              instrument is fully loaded.              was yet to be loaded on the sampler channel).  Value of 100
2866                indicates that the instrument is fully loaded.
2867    
2868           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2869    
2870              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
2871              connected to this sampler channel to deliver MIDI input              connected to this sampler channel to deliver MIDI input
2872              commands, "NONE" if there's no device connected to this              commands, "-1" if there's no device connected to this
2873              sampler channel              sampler channel
2874    
2875           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2876    
2877              port number of the MIDI input device              port number of the MIDI input device (in case a MIDI device
2878                was already assigned to the sampler channel)
2879    
2880           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2881    
# Line 2847  Internet-Draft        LinuxSampler Contr Line 2905  Internet-Draft        LinuxSampler Contr
2905    
2906              Determines to which MIDI instrument map this sampler channel              Determines to which MIDI instrument map this sampler channel
2907              is assigned to.  Read chapter "SET CHANNEL              is assigned to.  Read chapter "SET CHANNEL
             MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible  
             values.  
2908    
2909    
2910    
2911  Schoenebeck              Expires March 14, 2009                [Page 51]  Schoenebeck               Expires April 8, 2011                [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2914    
2915    
2916                MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2917                values.
2918    
2919     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2920    
2921     Example:     Example:
# Line 2902  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961     The front-end can ask for the current number of active voices on a     The front-end can ask for the current number of active voices on a
2962     sampler channel by sending the following command:     sampler channel by sending the following command:
2963    
       GET CHANNEL VOICE_COUNT <sampler-channel>  
   
    Where <sampler-channel> is the sampler channel number the front-end  
2964    
2965    
2966    
2967  Schoenebeck              Expires March 14, 2009                [Page 52]  Schoenebeck               Expires April 8, 2011                [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
2970    
2971    
2972          GET CHANNEL VOICE_COUNT <sampler-channel>
2973    
2974       Where <sampler-channel> is the sampler channel number the front-end
2975     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2976     "LIST CHANNELS" (Section 6.4.4) command.     "LIST CHANNELS" (Section 6.4.4) command.
2977    
# Line 2956  Internet-Draft        LinuxSampler Contr Line 3015  Internet-Draft        LinuxSampler Contr
3015    
3016     to get the fill state in bytes or     to get the fill state in bytes or
3017    
       GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>  
3018    
    to get the fill state in percent, where <sampler-channel> is the  
    sampler channel number the front-end is interested in as returned by  
    the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)  
3019    
3020    
3021    
3022  Schoenebeck              Expires March 14, 2009                [Page 53]  
3023    Schoenebeck               Expires April 8, 2011                [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3026    
3027    
3028          GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
3029    
3030       to get the fill state in percent, where <sampler-channel> is the
3031       sampler channel number the front-end is interested in as returned by
3032       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3033     command.     command.
3034    
3035     Possible Answers:     Possible Answers:
# Line 3013  Internet-Draft        LinuxSampler Contr Line 3074  Internet-Draft        LinuxSampler Contr
3074     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
3075     command.     command.
3076    
    Possible Answers:  
   
   
3077    
3078    
3079    Schoenebeck               Expires April 8, 2011                [Page 55]
   
 Schoenebeck              Expires March 14, 2009                [Page 54]  
3080    
3081  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3082    
3083    
3084       Possible Answers:
3085    
3086        "OK" -        "OK" -
3087    
3088           on success           on success
# Line 3069  Internet-Draft        LinuxSampler Contr Line 3127  Internet-Draft        LinuxSampler Contr
3127           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3128           message           message
3129    
       "ERR:<error-code>:<error-message>" -  
3130    
          in case it failed, providing an appropriate error code and  
          error message  
3131    
3132    
3133    
3134  Schoenebeck              Expires March 14, 2009                [Page 55]  
3135    Schoenebeck               Expires April 8, 2011                [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3138    
3139    
3140          "ERR:<error-code>:<error-message>" -
3141    
3142             in case it failed, providing an appropriate error code and
3143             error message
3144    
3145     Examples:     Examples:
3146    
# Line 3121  Internet-Draft        LinuxSampler Contr Line 3182  Internet-Draft        LinuxSampler Contr
3182    
3183    
3184    
 6.4.17.  Setting MIDI input device  
3185    
    The front-end can set the MIDI input device on a specific sampler  
    channel by sending the following command:  
3186    
       SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>  
3187    
    Where <sampler-channel> is the sampler channel number as returned by  
3188    
3189    
3190    
3191  Schoenebeck              Expires March 14, 2009                [Page 56]  Schoenebeck               Expires April 8, 2011                [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3194    
3195    
3196    6.4.17.  Setting MIDI input device
3197    
3198       The front-end can set the MIDI input device on a specific sampler
3199       channel by sending the following command:
3200    
3201          SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3202    
3203       Where <sampler-channel> is the sampler channel number as returned by
3204     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)
3205     command and <midi-device-id> is the numerical ID of the MIDI input     command and <midi-device-id> is the numerical ID of the MIDI input
3206     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)
# Line 3177  Internet-Draft        LinuxSampler Contr Line 3241  Internet-Draft        LinuxSampler Contr
3241    
3242     Possible Answers:     Possible Answers:
3243    
       "OK" -  
3244    
          on success  
3245    
       "WRN:<warning-code>:<warning-message>" -  
3246    
3247           if MIDI input type was set, but there are noteworthy issue(s)  Schoenebeck               Expires April 8, 2011                [Page 58]
3248           related, providing an appropriate warning code and warning  
3249    Internet-Draft        LinuxSampler Control Protocol         October 2010
3250    
3251    
3252          "OK" -
3253    
3254  Schoenebeck              Expires March 14, 2009                [Page 57]           on success
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
3255    
3256          "WRN:<warning-code>:<warning-message>" -
3257    
3258             if MIDI input type was set, but there are noteworthy issue(s)
3259             related, providing an appropriate warning code and warning
3260           message           message
3261    
3262        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3235  Internet-Draft        LinuxSampler Contr Line 3299  Internet-Draft        LinuxSampler Contr
3299    
3300    
3301    
 6.4.20.  Setting MIDI input channel  
   
    The front-end can alter the MIDI channel a sampler channel should  
    listen to by sending the following command:  
3302    
3303    Schoenebeck               Expires April 8, 2011                [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol         October 2010
3306    
3307    
3308    
3309    
3310  Schoenebeck              Expires March 14, 2009                [Page 58]  6.4.20.  Setting MIDI input channel
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
3311    
3312       The front-end can alter the MIDI channel a sampler channel should
3313       listen to by sending the following command:
3314    
3315        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3316    
# Line 3290  Internet-Draft        LinuxSampler Contr Line 3353  Internet-Draft        LinuxSampler Contr
3353    
3354     Possible Answers:     Possible Answers:
3355    
       "OK" -  
3356    
          on success  
   
       "WRN:<warning-code>:<warning-message>" -  
3357    
3358    
3359    Schoenebeck               Expires April 8, 2011                [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol         October 2010
3362    
3363    
3364          "OK" -
3365    
3366  Schoenebeck              Expires March 14, 2009                [Page 59]           on success
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
3367    
3368          "WRN:<warning-code>:<warning-message>" -
3369    
3370           if channel volume was set, but there are noteworthy issue(s)           if channel volume was set, but there are noteworthy issue(s)
3371           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
# Line 3347  Internet-Draft        LinuxSampler Contr Line 3409  Internet-Draft        LinuxSampler Contr
3409           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3410           error message           error message
3411    
    Examples:  
   
   
3412    
3413    
3414    
3415    Schoenebeck               Expires April 8, 2011                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol         October 2010
3418    
3419    
3420       Examples:
3421    
 Schoenebeck              Expires March 14, 2009                [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
3422    
3423    
3424  6.4.23.  Soloing a sampler channel  6.4.23.  Soloing a sampler channel
# Line 3406  Internet-Draft        LinuxSampler Contr Line 3466  Internet-Draft        LinuxSampler Contr
3466     (Section 6.4.4) command and <map> can have the following     (Section 6.4.4) command and <map> can have the following
3467     possibilites:     possibilites:
3468    
       "NONE" -  
   
   
   
3469    
3470    
3471  Schoenebeck              Expires March 14, 2009                [Page 61]  Schoenebeck               Expires April 8, 2011                [Page 62]
3472    
3473  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3474    
3475    
3476          "NONE" -
3477    
3478           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
3479           is not assigned any MIDI instrument map and thus will ignore           is not assigned any MIDI instrument map and thus will ignore
3480           all MIDI program change messages.           all MIDI program change messages.
# Line 3463  Internet-Draft        LinuxSampler Contr Line 3521  Internet-Draft        LinuxSampler Contr
3521     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3522     (Section 6.4.4) command, that is the sampler channel on which the     (Section 6.4.4) command, that is the sampler channel on which the
3523     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
    0..127 defining the MIDI controller which can alter the effect send  
    level and <name> is an optional argument defining a name for the  
3524    
3525    
3526    
3527  Schoenebeck              Expires March 14, 2009                [Page 62]  Schoenebeck               Expires April 8, 2011                [Page 63]
3528    
3529  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3530    
3531    
3532       0..127 defining the MIDI controller which can alter the effect send
3533       level and <name> is an optional argument defining a name for the
3534     effect send entity.  The name does not have to be unique, but MUST be     effect send entity.  The name does not have to be unique, but MUST be
3535     encapsulated into apostrophes and supports escape sequences as     encapsulated into apostrophes and supports escape sequences as
3536     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
# Line 3518  Internet-Draft        LinuxSampler Contr Line 3576  Internet-Draft        LinuxSampler Contr
3576    
3577        C: "CREATE FX_SEND 0 93"        C: "CREATE FX_SEND 0 93"
3578    
       S: "OK[1]"  
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires April 8, 2011                [Page 64]
 Schoenebeck              Expires March 14, 2009                [Page 63]  
3584    
3585  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3586    
3587    
3588          S: "OK[1]"
3589    
3590  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
3591    
# Line 3573  Internet-Draft        LinuxSampler Contr Line 3631  Internet-Draft        LinuxSampler Contr
3631    
3632     Possible Answers:     Possible Answers:
3633    
       The sampler will answer by returning the number of effect sends on  
       the given sampler channel.  
3634    
    Example:  
3635    
3636    
3637    
3638  Schoenebeck              Expires March 14, 2009                [Page 64]  
3639    Schoenebeck               Expires April 8, 2011                [Page 65]
3640    
3641  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3642    
3643    
3644          The sampler will answer by returning the number of effect sends on
3645          the given sampler channel.
3646    
3647       Example:
3648    
3649        C: "GET FX_SENDS 0"        C: "GET FX_SENDS 0"
3650    
# Line 3628  Internet-Draft        LinuxSampler Contr Line 3689  Internet-Draft        LinuxSampler Contr
3689     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.25) or "LIST
3690     FX_SENDS" (Section 6.4.28) command.     FX_SENDS" (Section 6.4.28) command.
3691    
    Possible Answers:  
3692    
       The sampler will answer by sending a <CRLF> separated list.  Each  
       answer line begins with the settings category name followed by a  
       colon and then a space character <SP> and finally the info  
3693    
3694    
3695    Schoenebeck               Expires April 8, 2011                [Page 66]
 Schoenebeck              Expires March 14, 2009                [Page 65]  
3696    
3697  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3698    
3699    
3700       Possible Answers:
3701    
3702          The sampler will answer by sending a <CRLF> separated list.  Each
3703          answer line begins with the settings category name followed by a
3704          colon and then a space character <SP> and finally the info
3705        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
3706        following categories are defined:        following categories are defined:
3707    
# Line 3670  Internet-Draft        LinuxSampler Contr Line 3731  Internet-Draft        LinuxSampler Contr
3731              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
3732              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
3733              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3734              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details),
3735                if an internal send effect is assigned to the effect send,
3736                then this setting defines the audio channel routing to that
3737                effect instance respectively
3738    
3739             SEND_EFFECT -
3740    
3741                destination send effect chain ID and destination effect
3742                chain position, separated by comma in the form "<effect-
3743                chain>,<chain-pos>" or "NONE" if there is no send effect
3744                assigned to the effect send
3745    
3746     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires April 8, 2011                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol         October 2010
3754    
3755    
3756     Example:     Example:
3757    
3758        C: "GET FX_SEND INFO 0 0"        C: "GET FX_SEND INFO 0 0"
# Line 3688  Internet-Draft        LinuxSampler Contr Line 3767  Internet-Draft        LinuxSampler Contr
3767    
3768           "."           "."
3769    
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
3770  6.4.30.  Changing effect send's name  6.4.30.  Changing effect send's name
3771    
3772     The front-end can alter the current name of an effect send entity by     The front-end can alter the current name of an effect send entity by
# Line 3731  Internet-Draft        LinuxSampler Contr Line 3801  Internet-Draft        LinuxSampler Contr
3801    
3802        S: "OK"        S: "OK"
3803    
3804    
3805    
3806    
3807    Schoenebeck               Expires April 8, 2011                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol         October 2010
3810    
3811    
3812  6.4.31.  Altering effect send's audio routing  6.4.31.  Altering effect send's audio routing
3813    
3814     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
# Line 3745  Internet-Draft        LinuxSampler Contr Line 3823  Internet-Draft        LinuxSampler Contr
3823     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3824     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.25) or "LIST
3825     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
3826     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
3827     <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
3828     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.  If an
3829       internal send effect is assigned to the effect send, then this
3830       setting defines the audio channel routing to that effect instance
3831       respectively.
3832    
3833     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
3834     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 3783  Internet-Draft        LinuxSampler Contr Line 3856  Internet-Draft        LinuxSampler Contr
3856    
3857        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3858    
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires April 8, 2011                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol         October 2010
3866    
3867    
3868           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3869           error message           error message
3870    
# Line 3792  Internet-Draft        LinuxSampler Contr Line 3874  Internet-Draft        LinuxSampler Contr
3874    
3875        S: "OK"        S: "OK"
3876    
3877  6.4.32.  Altering effect send's MIDI controller  6.4.32.  Assigning destination effect to an effect send
3878    
3879     The front-end can alter the MIDI controller of an effect send entity     The front-end can (re-)assign a destination effect to an effect send
3880     by sending the following command:     by sending the following command:
3881    
3882        SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-        SET FX_SEND SEND_EFFECT <sampler-chan> <fx-send-id> <effect-chain>
3883        ctrl>        <chain-pos>
3884    
3885     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3886       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3887       command, <fx-send-id> reflects the numerical ID of the effect send
3888       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3889       FX_SENDS" (Section 6.4.28) command, <effect-chain> by the numerical
3890       ID of the destination effect chain as returned by the "ADD
3891       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
3892       (Section 6.11.13) command and <chain-pos> reflects the exact effect
3893       chain position in the effect chain which hosts the actual destination
3894       effect.
3895    
3896       Possible Answers:
3897    
3898          "OK" -
3899    
3900             on success
3901    
3902          "ERR:<error-code>:<error-message>" -
3903    
3904             in case it failed, providing an appropriate error code and
3905             error message
3906    
3907       Example:
3908    
3909  Schoenebeck              Expires March 14, 2009                [Page 68]        C: "SET FX_SEND SEND_EFFECT 0 0 2 5"
3910    
3911          S: "OK"
3912    
3913    
3914    
3915    
3916    
3917    
3918    
3919    Schoenebeck               Expires April 8, 2011                [Page 70]
3920    
3921  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
3922    
3923    
3924    6.4.33.  Removing destination effect from an effect send
3925    
3926       The front-end can (re-)assign a destination effect to an effect send
3927       by sending the following command:
3928    
3929          REMOVE FX_SEND SEND_EFFECT <sampler-chan> <fx-send-id>
3930    
3931       Where <sampler-chan> is the sampler channel number as returned by the
3932       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3933       command, <fx-send-id> reflects the numerical ID of the effect send
3934       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3935       FX_SENDS" (Section 6.4.28) command.
3936    
3937       After the destination effect has been removed from the effect send,
3938       the audio signal of the effect send will be routed directly to the
3939       audio output device, according to the audio channel routing setting
3940       of the effect send.
3941    
3942       Possible Answers:
3943    
3944          "OK" -
3945    
3946             on success
3947    
3948          "ERR:<error-code>:<error-message>" -
3949    
3950             in case it failed, providing an appropriate error code and
3951             error message
3952    
3953       Example:
3954    
3955          C: "REMOVE FX_SEND SEND_EFFECT 0 0"
3956    
3957          S: "OK"
3958    
3959    6.4.34.  Altering effect send's MIDI controller
3960    
3961       The front-end can alter the MIDI controller of an effect send entity
3962       by sending the following command:
3963    
3964          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3965          ctrl>
3966    
3967       Where <sampler-chan> is the sampler channel number as returned by the
3968     "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)
3969     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3970     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.25) or "LIST
3971     FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI     FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3972    
3973    
3974    
3975    Schoenebeck               Expires April 8, 2011                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol         October 2010
3978    
3979    
3980     controller which shall be able to modify the effect send's send     controller which shall be able to modify the effect send's send
3981     level.     level.
3982    
# Line 3839  Internet-Draft        LinuxSampler Contr Line 4003  Internet-Draft        LinuxSampler Contr
4003    
4004        S: "OK"        S: "OK"
4005    
4006  6.4.33.  Altering effect send's send level  6.4.35.  Altering effect send's send level
4007    
4008     The front-end can alter the current send level of an effect send     The front-end can alter the current send level of an effect send
4009     entity by sending the following command:     entity by sending the following command:
# Line 3857  Internet-Draft        LinuxSampler Contr Line 4021  Internet-Draft        LinuxSampler Contr
4021    
4022     Possible Answers:     Possible Answers:
4023    
4024          "OK" -
4025    
4026             on success
4027    
4028    
 Schoenebeck              Expires March 14, 2009                [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
4029    
4030    
4031        "OK" -  Schoenebeck               Expires April 8, 2011                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol         October 2010
4034    
          on success  
4035    
4036        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4037    
# Line 3886  Internet-Draft        LinuxSampler Contr Line 4050  Internet-Draft        LinuxSampler Contr
4050    
4051        S: "OK"        S: "OK"
4052    
4053  6.4.34.  Sending MIDI messages to sampler channel  6.4.36.  Sending MIDI messages to sampler channel
4054    
4055     The front-end can send MIDI events to specific sampler channel by     The front-end can send MIDI events to a specific sampler channel by
4056     sending the following command:     sending the following command:
4057    
4058        SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>        SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>
# Line 3911  Internet-Draft        LinuxSampler Contr Line 4075  Internet-Draft        LinuxSampler Contr
4075           specifies the key number and <arg2> the velocity as described           specifies the key number and <arg2> the velocity as described
4076           in the MIDI specification.           in the MIDI specification.
4077    
4078     CAUTION: This command is provided for implementations of virtual MIDI        "CC" -
4079     keyboards and no realtime guarantee whatsoever will be made!  
4080             For changing a MIDI controller, where <arg1> specifies the
4081             controller number and <arg2> the new value of the controller as
4082             described in the Control Change section of the MIDI
4083             specification.
4084    
4085    
4086    
4087  Schoenebeck              Expires March 14, 2009                [Page 70]  Schoenebeck               Expires April 8, 2011                [Page 73]
4088    
4089  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
4090    
4091    
4092       CAUTION: This command is provided for implementations of virtual MIDI
4093       keyboards and no realtime guarantee whatsoever will be made!
4094    
4095     Possible Answers:     Possible Answers:
4096    
4097        "OK" -        "OK" -
# Line 3938  Internet-Draft        LinuxSampler Contr Line 4109  Internet-Draft        LinuxSampler Contr
4109    
4110        S: "OK"        S: "OK"
4111    
4112  6.4.35.  Resetting a sampler channel  6.4.37.  Resetting a sampler channel
4113    
4114     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
4115     following command:     following command:
# Line 3967  Internet-Draft        LinuxSampler Contr Line 4138  Internet-Draft        LinuxSampler Contr
4138           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4139           error message           error message
4140    
    Examples:  
   
   
4141    
4142    
4143  Schoenebeck              Expires March 14, 2009                [Page 71]  Schoenebeck               Expires April 8, 2011                [Page 74]
4144    
4145  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
4146    
4147    
4148       Examples:
4149    
4150    
4151    
4152  6.5.  Controlling connection  6.5.  Controlling connection
# Line 4023  Internet-Draft        LinuxSampler Contr Line 4193  Internet-Draft        LinuxSampler Contr
4193        UNSUBSCRIBE <event-id>        UNSUBSCRIBE <event-id>
4194    
4195     Where <event-id> will be replaced by the respective event that client     Where <event-id> will be replaced by the respective event that client
    doesn't want to receive anymore.  
   
4196    
4197    
4198    
4199  Schoenebeck              Expires March 14, 2009                [Page 72]  Schoenebeck               Expires April 8, 2011                [Page 75]
4200    
4201  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
4202    
4203    
4204       doesn't want to receive anymore.
4205    
4206     Possible Answers:     Possible Answers:
4207    
4208        "OK" -        "OK" -
# Line 4082  Internet-Draft        LinuxSampler Contr Line 4252  Internet-Draft        LinuxSampler Contr
4252    
4253    
4254    
4255    Schoenebeck               Expires April 8, 2011                [Page 76]
   
 Schoenebeck              Expires March 14, 2009                [Page 73]  
4256    
4257  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
4258    
4259    
4260    
# Line 4140  Internet-Draft        LinuxSampler Contr Line 4308  Internet-Draft        LinuxSampler Contr
4308    
4309    
4310    
4311  Schoenebeck              Expires March 14, 2009                [Page 74]  Schoenebeck               Expires April 8, 2011                [Page 77]
4312    
4313  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
4314    
4315    
4316        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
# Line 4196  Internet-Draft        LinuxSampler Contr Line 4364  Internet-Draft        LinuxSampler Contr
4364    
4365    
4366    
4367  Schoenebeck              Expires March 14, 2009                [Page 75]  Schoenebeck               Expires April 8, 2011                [Page 78]
4368    
4369  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
4370    
4371    
4372           PROTOCOL_VERSION -           PROTOCOL_VERSION -
# Line 4252  Internet-Draft        LinuxSampler Contr Line 4420  Internet-Draft        LinuxSampler Contr
4420    
4421    
4422    
4423  Schoenebeck              Expires March 14, 2009                [Page 76]  Schoenebeck               Expires April 8, 2011                [Page 79]
4424    
4425  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
4426    
4427    
4428        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 4268  Internet-Draft        LinuxSampler Contr Line 4436  Internet-Draft        LinuxSampler Contr
4436           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4437           error message           error message
4438    
4439    6.6.8.  Getting global voice limit
4440    
4441       The client can ask for the current global sampler-wide limit for
4442       maximum voices by sending the following command:
4443    
4444          GET VOICES
4445    
4446       Possible Answers:
4447    
4448          LinuxSampler will answer by returning the number for the current
4449          limit of maximum voices.
4450    
4451       The voice limit setting defines how many voices should maximum be
4452       processed by the sampler at the same time.  If the user triggers new
4453       notes which would exceed that voice limit, the sampler engine will
4454       react by stealing old voices for those newly triggered notes.  Note
4455       that the amount of voices triggered by a new note can be larger than
4456       one and is dependent to the respective instrument and probably
4457       further criterias.
4458    
4459    6.6.9.  Setting global voice limit
4460    
4461       The client can alter the current global sampler-wide limit for
4462       maximum voices by sending the following command:
4463    
4464          SET VOICES <max-voices>
4465    
4466       Where <max-voices> should be replaced by the integer value,
4467       reflecting the new global amount limit of maximum voices.  This value
4468       has to be larger than 0.
4469    
4470       Possible Answers:
4471    
4472          "OK" -
4473    
4474             on success
4475    
4476    
4477    
4478    
4479    Schoenebeck               Expires April 8, 2011                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol         October 2010
4482    
4483    
4484          "WRN:<warning-code>:<warning-message>" -
4485    
4486             if the voice limit was set, but there are noteworthy issue(s)
4487             related, providing an appropriate warning code and warning
4488             message
4489    
4490          "ERR:<error-code>:<error-message>" -
4491    
4492             in case it failed, providing an appropriate error code and
4493             error message
4494    
4495       Note: the given value will be passed to all sampler engine instances.
4496       The total amount of maximum voices on the running system might thus
4497       be as big as the given value multiplied by the current amount of
4498       engine instances.
4499    
4500       Caution: when adjusting the voice limit, you SHOULD also adjust the
4501       disk stream limit respectively and vice versa.
4502    
4503    6.6.10.  Getting global disk stream limit
4504    
4505       The client can ask for the current global sampler-wide limit for
4506       maximum disk streams by sending the following command:
4507    
4508          GET STREAMS
4509    
4510       Possible Answers:
4511    
4512          LinuxSampler will answer by returning the number for the current
4513          limit of maximum disk streams.
4514    
4515       The disk stream limit setting defines how many disk streams should
4516       maximum be processed by a sampler engine at the same time.  The
4517       higher this value, the more memory (RAM) will be occupied, since
4518       every disk streams allocates a certain buffer size for being able to
4519       perform its streaming operations.
4520    
4521    6.6.11.  Setting global disk stream limit
4522    
4523       The client can alter the current global sampler-wide limit for
4524       maximum disk streams by sending the following command:
4525    
4526          SET STREAMS <max-streams>
4527    
4528       Where <max-streams> should be replaced by the integer value,
4529       reflecting the new global amount limit of maximum disk streams.  This
4530       value has to be positive.
4531    
4532    
4533    
4534    
4535    Schoenebeck               Expires April 8, 2011                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol         October 2010
4538    
4539    
4540       Possible Answers:
4541    
4542          "OK" -
4543    
4544             on success
4545    
4546          "WRN:<warning-code>:<warning-message>" -
4547    
4548             if the disk stream limit was set, but there are noteworthy
4549             issue(s) related, providing an appropriate warning code and
4550             warning message
4551    
4552          "ERR:<error-code>:<error-message>" -
4553    
4554             in case it failed, providing an appropriate error code and
4555             error message
4556    
4557       Note: the given value will be passed to all sampler engine instances.
4558       The total amount of maximum disk streams on the running system might
4559       thus be as big as the given value multiplied by the current amount of
4560       engine instances.
4561    
4562       Caution: when adjusting the disk stream limit, you SHOULD also adjust
4563       the voice limit respectively and vice versa.
4564    
4565  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4566    
4567     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 4291  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4586     channel.     channel.
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires April 8, 2011                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol         October 2010
4594    
4595    
4596     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
4597     to switch to another instrument.  Instead when receiving a bank     to switch to another instrument.  Instead when receiving a bank
4598     select message the bank value will be stored and a subsequent program     select message the bank value will be stored and a subsequent program
# Line 4303  Internet-Draft        LinuxSampler Contr Line 4605  Internet-Draft        LinuxSampler Contr
4605     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
4606     following command:     following command:
4607    
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4608        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4609    
4610     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
# Line 4347  Internet-Draft        LinuxSampler Contr Line 4639  Internet-Draft        LinuxSampler Contr
4639    
4640        S: "OK[5]"        S: "OK[5]"
4641    
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires April 8, 2011                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol         October 2010
4650    
4651    
4652  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
4653    
4654     The front-end can delete a particular MIDI instrument map by sending     The front-end can delete a particular MIDI instrument map by sending
# Line 4360  Internet-Draft        LinuxSampler Contr Line 4662  Internet-Draft        LinuxSampler Contr
4662     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4663     following command:     following command:
4664    
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4665        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4666    
4667     Possible Answers:     Possible Answers:
# Line 4405  Internet-Draft        LinuxSampler Contr Line 4698  Internet-Draft        LinuxSampler Contr
4698    
4699     Example:     Example:
4700    
4701    
4702    
4703    Schoenebeck               Expires April 8, 2011                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol         October 2010
4706    
4707    
4708        C: "GET MIDI_INSTRUMENT_MAPS"        C: "GET MIDI_INSTRUMENT_MAPS"
4709    
4710        S: "2"        S: "2"
# Line 4415  Internet-Draft        LinuxSampler Contr Line 4715  Internet-Draft        LinuxSampler Contr
4715     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4716     following command:     following command:
4717    
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4718        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4719    
4720     Possible Answers:     Possible Answers:
# Line 4463  Internet-Draft        LinuxSampler Contr Line 4753  Internet-Draft        LinuxSampler Contr
4753    
4754              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
4755              unique (note that this character string may contain escape              unique (note that this character string may contain escape
4756    
4757    
4758    
4759    Schoenebeck               Expires April 8, 2011                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol         October 2010
4762    
4763    
4764              sequences (Section 7.1))              sequences (Section 7.1))
4765    
4766           DEFAULT -           DEFAULT -
# Line 4474  Internet-Draft        LinuxSampler Contr Line 4772  Internet-Draft        LinuxSampler Contr
4772    
4773     Example:     Example:
4774    
   
   
 Schoenebeck              Expires March 14, 2009                [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4775        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4776    
4777        S: "NAME: Standard Map"        S: "NAME: Standard Map"
# Line 4518  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809    
4810        S: "OK"        S: "OK"
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires April 8, 2011                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol         October 2010
4818    
4819    
4820  6.7.7.  Create or replace a MIDI instrument map entry  6.7.7.  Create or replace a MIDI instrument map entry
4821    
4822     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
# Line 4529  Internet-Draft        LinuxSampler Contr Line 4828  Internet-Draft        LinuxSampler Contr
4828    
4829     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
4830     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4831     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4832     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4833     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
# Line 4573  Internet-Draft        LinuxSampler Contr Line 4864  Internet-Draft        LinuxSampler Contr
4864    
4865        "PERSISTENT" -        "PERSISTENT" -
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires April 8, 2011                [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol         October 2010
4874    
4875    
4876           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
4877           mapping command is sent and the instrument is kept all the           mapping command is sent and the instrument is kept all the
4878           time.  Instruments with this mode are only freed when the           time.  Instruments with this mode are only freed when the
# Line 4585  Internet-Draft        LinuxSampler Contr Line 4885  Internet-Draft        LinuxSampler Contr
4885           In case there is no <instr_load_mode> argument given, it will           In case there is no <instr_load_mode> argument given, it will
4886           be up to the InstrumentManager to decide which mode to use.           be up to the InstrumentManager to decide which mode to use.
4887           Usually it will use "ON_DEMAND" if an entry for the given           Usually it will use "ON_DEMAND" if an entry for the given
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4888           instrument does not exist in the InstrumentManager's list yet,           instrument does not exist in the InstrumentManager's list yet,
4889           otherwise if an entry already exists, it will simply stick with           otherwise if an entry already exists, it will simply stick with
4890           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
# Line 4629  Internet-Draft        LinuxSampler Contr Line 4921  Internet-Draft        LinuxSampler Contr
4921     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4922     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4923     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
4924    
4925    
4926    
4927    Schoenebeck               Expires April 8, 2011                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol         October 2010
4930    
4931    
4932     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4933     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4934     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4640  Internet-Draft        LinuxSampler Contr Line 4940  Internet-Draft        LinuxSampler Contr
4940    
4941           usually           usually
4942    
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4943        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4944    
4945           when the given map or engine does not exist or a value is out           when the given map or engine does not exist or a value is out
# Line 4686  Internet-Draft        LinuxSampler Contr Line 4977  Internet-Draft        LinuxSampler Contr
4977     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
4978     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4979    
       GET MIDI_INSTRUMENTS <map>  
4980    
    The front-end can query the amount of currently existing entries in  
    all MIDI instrument maps by sending the following command:  
   
       GET MIDI_INSTRUMENTS ALL  
   
    Possible Answers:  
4981    
4982    
4983    Schoenebeck               Expires April 8, 2011                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol         October 2010
4986    
4987    
4988          GET MIDI_INSTRUMENTS <map>
4989    
4990       The front-end can query the amount of currently existing entries in
4991       all MIDI instrument maps by sending the following command:
4992    
4993  Schoenebeck              Expires March 14, 2009                [Page 84]        GET MIDI_INSTRUMENTS ALL
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
4994    
4995       Possible Answers:
4996    
4997        The sampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
4998        in the MIDI instrument map(s).        in the MIDI instrument map(s).
# Line 4744  Internet-Draft        LinuxSampler Contr Line 5033  Internet-Draft        LinuxSampler Contr
5033    
5034     Example:     Example:
5035    
       C: "LIST MIDI_INSTRUMENTS 0"  
5036    
       S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"  
5037    
 6.7.10.  Remove an entry from the MIDI instrument map  
5038    
5039     The front-end can delete an entry from a MIDI instrument map by  Schoenebeck               Expires April 8, 2011                [Page 90]
5040     sending the following command:  
5041    Internet-Draft        LinuxSampler Control Protocol         October 2010
5042    
5043    
5044          C: "LIST MIDI_INSTRUMENTS 0"
5045    
5046          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
5047    
5048  Schoenebeck              Expires March 14, 2009                [Page 85]  6.7.10.  Remove an entry from the MIDI instrument map
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
5049    
5050       The front-end can delete an entry from a MIDI instrument map by
5051       sending the following command:
5052    
5053        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
5054    
# Line 4799  Internet-Draft        LinuxSampler Contr Line 5088  Internet-Draft        LinuxSampler Contr
5088    
5089     Possible Answers:     Possible Answers:
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires April 8, 2011                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol         October 2010
5098    
5099    
5100        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5101        answer line begins with the information category name followed by        answer line begins with the information category name followed by
5102        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 4809  Internet-Draft        LinuxSampler Contr Line 5107  Internet-Draft        LinuxSampler Contr
5107    
5108           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
5109           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5110           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
5111           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
5112           be unique. (note that this character string may contain escape           be unique. (note that this character string may contain escape
# Line 4853  Internet-Draft        LinuxSampler Contr Line 5143  Internet-Draft        LinuxSampler Contr
5143           (where a value < 1.0 means attenuation and a value > 1.0 means           (where a value < 1.0 means attenuation and a value > 1.0 means
5144           amplification)           amplification)
5145    
5146    
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires April 8, 2011                [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol         October 2010
5154    
5155    
5156        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
5157    
5158     Example:     Example:
# Line 4865  Internet-Draft        LinuxSampler Contr Line 5165  Internet-Draft        LinuxSampler Contr
5165    
5166           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
5167    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5168           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
5169    
5170           "INSTRUMENT_NAME: Joe's Drumkit"           "INSTRUMENT_NAME: Joe's Drumkit"
# Line 4909  Internet-Draft        LinuxSampler Contr Line 5201  Internet-Draft        LinuxSampler Contr
5201    
5202     Examples:     Examples:
5203    
       C: "CLEAR MIDI_INSTRUMENTS 0"  
   
       S: "OK"  
   
       C: "CLEAR MIDI_INSTRUMENTS ALL"  
   
       S: "OK"  
   
5204    
5205    
5206    
5207    Schoenebeck               Expires April 8, 2011                [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol         October 2010
5210    
5211    
5212          C: "CLEAR MIDI_INSTRUMENTS 0"
5213    
5214          S: "OK"
5215    
5216  Schoenebeck              Expires March 14, 2009                [Page 88]        C: "CLEAR MIDI_INSTRUMENTS ALL"
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
5217    
5218          S: "OK"
5219    
5220  6.8.  Managing Instruments Database  6.8.  Managing Instruments Database
5221    
# Line 4968  Internet-Draft        LinuxSampler Contr Line 5256  Internet-Draft        LinuxSampler Contr
5256    
5257     Examples:     Examples:
5258    
       C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"  
5259    
       S: "OK"  
5260    
 6.8.2.  Deleting an instrument directory  
5261    
    The front-end can delete a particular instrument directory from the  
    instruments database by sending the following command:  
5262    
5263    Schoenebeck               Expires April 8, 2011                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol         October 2010
5266    
5267    
5268          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
5269    
5270  Schoenebeck              Expires March 14, 2009                [Page 89]        S: "OK"
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
5271    
5272    6.8.2.  Deleting an instrument directory
5273    
5274       The front-end can delete a particular instrument directory from the
5275       instruments database by sending the following command:
5276    
5277        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
5278    
# Line 5022  Internet-Draft        LinuxSampler Contr Line 5311  Internet-Draft        LinuxSampler Contr
5311    
5312     Possible Answers:     Possible Answers:
5313    
       The current number of instrument directories in the specified  
       directory.  
5314    
       "ERR:<error-code>:<error-message>" -  
5315    
          if the given directory does not exist.  
5316    
    Example:  
5317    
5318    
5319    Schoenebeck               Expires April 8, 2011                [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol         October 2010
5322    
5323    
5324          The current number of instrument directories in the specified
5325          directory.
5326    
5327          "ERR:<error-code>:<error-message>" -
5328    
5329  Schoenebeck              Expires March 14, 2009                [Page 90]           if the given directory does not exist.
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
5330    
5331       Example:
5332    
5333        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
5334    
# Line 5077  Internet-Draft        LinuxSampler Contr Line 5366  Internet-Draft        LinuxSampler Contr
5366        S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano        S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
5367        Collection/Acoustic/New','/Percussion Collection'"        Collection/Acoustic/New','/Percussion Collection'"
5368    
5369    
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires April 8, 2011                [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol         October 2010
5378    
5379    
5380  6.8.5.  Getting instrument directory information  6.8.5.  Getting instrument directory information
5381    
5382     The front-end can ask for the current settings of an instrument     The front-end can ask for the current settings of an instrument
# Line 5089  Internet-Draft        LinuxSampler Contr Line 5389  Internet-Draft        LinuxSampler Contr
5389    
5390     Possible Answers:     Possible Answers:
5391    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5392        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5393        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5394        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
# Line 5133  Internet-Draft        LinuxSampler Contr Line 5425  Internet-Draft        LinuxSampler Contr
5425    
5426           "MODIFIED: 2007-04-07 12:50:21"           "MODIFIED: 2007-04-07 12:50:21"
5427    
5428    
5429    
5430    
5431    Schoenebeck               Expires April 8, 2011                [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol         October 2010
5434    
5435    
5436           "."           "."
5437    
5438  6.8.6.  Renaming an instrument directory  6.8.6.  Renaming an instrument directory
# Line 5145  Internet-Draft        LinuxSampler Contr Line 5445  Internet-Draft        LinuxSampler Contr
5445     Where <dir> is the absolute path name of the directory and <name> is     Where <dir> is the absolute path name of the directory and <name> is
5446     the new name for that directory.     the new name for that directory.
5447    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5448     Possible Answers:     Possible Answers:
5449    
5450        "OK" -        "OK" -
# Line 5187  Internet-Draft        LinuxSampler Contr Line 5479  Internet-Draft        LinuxSampler Contr
5479    
5480           on success           on success
5481    
5482    
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires April 8, 2011                [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol         October 2010
5490    
5491    
5492        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5493    
5494           in case a given directory does not exists, or if a directory           in case a given directory does not exists, or if a directory
# Line 5201  Internet-Draft        LinuxSampler Contr Line 5503  Internet-Draft        LinuxSampler Contr
5503    
5504        S: "OK"        S: "OK"
5505    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5506  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
5507    
5508     The front-end can copy a specific instrument directory by sending the     The front-end can copy a specific instrument directory by sending the
# Line 5239  Internet-Draft        LinuxSampler Contr Line 5533  Internet-Draft        LinuxSampler Contr
5533    
5534        S: "OK"        S: "OK"
5535    
5536    
5537    
5538    
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires April 8, 2011                [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol         October 2010
5546    
5547    
5548  6.8.9.  Changing the description of directory  6.8.9.  Changing the description of directory
5549    
5550     The front-end can alter the description of a specific instrument     The front-end can alter the description of a specific instrument
# Line 5257  Internet-Draft        LinuxSampler Contr Line 5563  Internet-Draft        LinuxSampler Contr
5563    
5564           on success           on success
5565    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5566        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5567    
5568           in case the given directory does not exists.           in case the given directory does not exists.
# Line 5295  Internet-Draft        LinuxSampler Contr Line 5593  Internet-Draft        LinuxSampler Contr
5593    
5594        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5595        supplied search string (encapsulated into apostrophes, supporting        supplied search string (encapsulated into apostrophes, supporting
5596    
5597    
5598    
5599    Schoenebeck               Expires April 8, 2011               [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol         October 2010
5602    
5603    
5604        escape sequences as described in chapter "Character Set and Escape        escape sequences as described in chapter "Character Set and Escape
5605        Sequences (Section 7.1)").        Sequences (Section 7.1)").
5606    
# Line 5313  Internet-Draft        LinuxSampler Contr Line 5619  Internet-Draft        LinuxSampler Contr
5619        modification satisfies the specified period, where <date-after>        modification satisfies the specified period, where <date-after>
5620        and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-        and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5621        after> is omitted the search is restricted to directories, which        after> is omitted the search is restricted to directories, which
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 95]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5622        are last modified before <date-before>.  If <date-before> is        are last modified before <date-before>.  If <date-before> is
5623        omitted, the search is restricted to directories, which are last        omitted, the search is restricted to directories, which are last
5624        modified after <date-after>.        modified after <date-after>.
# Line 5351  Internet-Draft        LinuxSampler Contr Line 5649  Internet-Draft        LinuxSampler Contr
5649    
5650        S: "'/Piano Collection'"        S: "'/Piano Collection'"
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires April 8, 2011               [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol         October 2010
5658    
5659    
5660        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5661        30:13'"        30:13'"
5662    
# Line 5361  Internet-Draft        LinuxSampler Contr Line 5667  Internet-Draft        LinuxSampler Contr
5667     The front-end can add one or more instruments to the instruments     The front-end can add one or more instruments to the instruments
5668     database by sending the following command:     database by sending the following command:
5669    
5670        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir>
5671        [<instr_index>]        <file_path> [<instr_index>]
5672    
5673     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5674     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
5675     instruments (that are not already in the database) will be added,     instruments (that are not already in the database) will be added,
5676     <file_path> is the absolute path name of a file or directory in the     <file_path> is the absolute path name of a file or directory in the
5677     file system (encapsulated into apostrophes).  In case an instrument     file system (encapsulated into apostrophes).  In case an instrument
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 96]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5678     file is supplied, only the instruments in the specified file will be     file is supplied, only the instruments in the specified file will be
5679     added to the instruments database.  If the optional <instr_index>     added to the instruments database.  If the optional <instr_index>
5680     (the index of the instrument within the given file) is supplied too,     (the index of the instrument within the given file) is supplied too,
# Line 5404  Internet-Draft        LinuxSampler Contr Line 5702  Internet-Draft        LinuxSampler Contr
5702           not be recreated in the instruments database.  All instruments           not be recreated in the instruments database.  All instruments
5703           will be added directly in the specified database directory.           will be added directly in the specified database directory.
5704    
5705       If FILE_AS_DIR argument is supplied, all instruments in an instrument
5706       file will be added to a separate directory in the instruments
5707       database, which name will be the name of the instrument file with the
5708    
5709    
5710    
5711    Schoenebeck               Expires April 8, 2011               [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol         October 2010
5714    
5715    
5716       file extension stripped off.
5717    
5718     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
5719     is that the regular command returns when the scanning is finished     is that the regular command returns when the scanning is finished
5720     while NON_MODAL version returns immediately and a background process     while NON_MODAL version returns immediately and a background process
# Line 5424  Internet-Draft        LinuxSampler Contr Line 5735  Internet-Draft        LinuxSampler Contr
5735    
5736        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5737    
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5738           if an invalid path is specified.           if an invalid path is specified.
5739    
5740     Examples:     Examples:
# Line 5458  Internet-Draft        LinuxSampler Contr Line 5760  Internet-Draft        LinuxSampler Contr
5760    
5761           if the instrument is removed successfully           if the instrument is removed successfully
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck               Expires April 8, 2011               [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol         October 2010
5770    
5771    
5772        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5773    
5774           if the given path does not exist or is a directory.           if the given path does not exist or is a directory.
# Line 5482  Internet-Draft        LinuxSampler Contr Line 5793  Internet-Draft        LinuxSampler Contr
5793    
5794     Possible Answers:     Possible Answers:
5795    
   
   
 Schoenebeck              Expires March 14, 2009                [Page 98]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5796        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5797    
5798        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5513  Internet-Draft        LinuxSampler Contr Line 5817  Internet-Draft        LinuxSampler Contr
5817     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5818     specified directory, will be returned.     specified directory, will be returned.
5819    
5820    
5821    
5822    
5823    Schoenebeck               Expires April 8, 2011               [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol         October 2010
5826    
5827    
5828     Possible Answers:     Possible Answers:
5829    
5830        A comma separated list of all instruments (encapsulated into        A comma separated list of all instruments (encapsulated into
# Line 5533  Internet-Draft        LinuxSampler Contr Line 5845  Internet-Draft        LinuxSampler Contr
5845        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5846        Steinway D','/Piano Collection/Lite/Free Piano'"        Steinway D','/Piano Collection/Lite/Free Piano'"
5847    
   
   
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 99]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5848  6.8.15.  Getting instrument information  6.8.15.  Getting instrument information
5849    
5850     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
# Line 5572  Internet-Draft        LinuxSampler Contr Line 5872  Internet-Draft        LinuxSampler Contr
5872    
5873           INSTRUMENT_NR -           INSTRUMENT_NR -
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires April 8, 2011               [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol         October 2010
5882    
5883    
5884              Index of the instrument within the file.              Index of the instrument within the file.
5885    
5886           FORMAT_FAMILY -           FORMAT_FAMILY -
# Line 5592  Internet-Draft        LinuxSampler Contr Line 5901  Internet-Draft        LinuxSampler Contr
5901              instruments database, represented in "YYYY-MM-DD HH:MM:SS"              instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5902              format              format
5903    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5904           MODIFIED -           MODIFIED -
5905    
5906              The date and time of the last modification of the              The date and time of the last modification of the
# Line 5627  Internet-Draft        LinuxSampler Contr Line 5927  Internet-Draft        LinuxSampler Contr
5927              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5928              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5929    
5930    
5931    
5932    
5933    
5934    
5935    Schoenebeck               Expires April 8, 2011               [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol         October 2010
5938    
5939    
5940           KEYWORDS -           KEYWORDS -
5941    
5942              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
# Line 5648  Internet-Draft        LinuxSampler Contr Line 5958  Internet-Draft        LinuxSampler Contr
5958    
5959           "FORMAT_VERSION: 2"           "FORMAT_VERSION: 2"
5960    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 101]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5961           "SIZE: 2050871870"           "SIZE: 2050871870"
5962    
5963           "CREATED: 2007-02-05 10:23:12"           "CREATED: 2007-02-05 10:23:12"
# Line 5685  Internet-Draft        LinuxSampler Contr Line 5986  Internet-Draft        LinuxSampler Contr
5986     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
5987     is the new name for that instrument.     is the new name for that instrument.
5988    
5989    
5990    
5991    Schoenebeck               Expires April 8, 2011               [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol         October 2010
5994    
5995    
5996     Possible Answers:     Possible Answers:
5997    
5998        "OK" -        "OK" -
# Line 5703  Internet-Draft        LinuxSampler Contr Line 6011  Internet-Draft        LinuxSampler Contr
6011    
6012        S: "OK"        S: "OK"
6013    
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6014  6.8.17.  Moving an instrument  6.8.17.  Moving an instrument
6015    
6016     The front-end can move a specific instrument to another directory by     The front-end can move a specific instrument to another directory by
# Line 5742  Internet-Draft        LinuxSampler Contr Line 6040  Internet-Draft        LinuxSampler Contr
6040    
6041        S: "OK"        S: "OK"
6042    
6043    
6044    
6045    
6046    
6047    Schoenebeck               Expires April 8, 2011               [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol         October 2010
6050    
6051    
6052  6.8.18.  Copying instruments  6.8.18.  Copying instruments
6053    
6054     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 5760  Internet-Draft        LinuxSampler Contr Line 6067  Internet-Draft        LinuxSampler Contr
6067    
6068        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6069    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 103]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6070           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
6071           instrument with name equal to the name of the specified           instrument with name equal to the name of the specified
6072           instrument already exists in the destination directory.           instrument already exists in the destination directory.
# Line 5798  Internet-Draft        LinuxSampler Contr Line 6096  Internet-Draft        LinuxSampler Contr
6096    
6097           on success           on success
6098    
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires April 8, 2011               [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol         October 2010
6106    
6107    
6108        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6109    
6110           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5817  Internet-Draft        LinuxSampler Contr Line 6124  Internet-Draft        LinuxSampler Contr
6124        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
6125    
6126     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 104]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6127     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
6128     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
6129     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
# Line 5855  Internet-Draft        LinuxSampler Contr Line 6154  Internet-Draft        LinuxSampler Contr
6154        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
6155        instruments created after <date-after>.        instruments created after <date-after>.
6156    
6157    
6158    
6159    Schoenebeck               Expires April 8, 2011               [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol         October 2010
6162    
6163    
6164     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
6165    
6166        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 5874  Internet-Draft        LinuxSampler Contr Line 6180  Internet-Draft        LinuxSampler Contr
6180    
6181     PRODUCT='<search-string>'     PRODUCT='<search-string>'
6182    
   
   
 Schoenebeck              Expires March 14, 2009               [Page 105]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6183        Restricts the search to instruments with product info that        Restricts the search to instruments with product info that
6184        satisfies the supplied search string (encapsulated into        satisfies the supplied search string (encapsulated into
6185        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 5911  Internet-Draft        LinuxSampler Contr Line 6210  Internet-Draft        LinuxSampler Contr
6210        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
6211        families.        families.
6212    
6213    
6214    
6215    Schoenebeck               Expires April 8, 2011               [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol         October 2010
6218    
6219    
6220     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
6221     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
6222    
# Line 5929  Internet-Draft        LinuxSampler Contr Line 6235  Internet-Draft        LinuxSampler Contr
6235        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
6236        290'"        290'"
6237    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 106]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6238        S: "'/Piano Collection/Bosendorfer 290'"        S: "'/Piano Collection/Bosendorfer 290'"
6239    
6240        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
# Line 5967  Internet-Draft        LinuxSampler Contr Line 6265  Internet-Draft        LinuxSampler Contr
6265    
6266           FILES_TOTAL -           FILES_TOTAL -
6267    
6268    
6269    
6270    
6271    Schoenebeck               Expires April 8, 2011               [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol         October 2010
6274    
6275    
6276              The total number of files scheduled for scanning              The total number of files scheduled for scanning
6277    
6278           FILES_SCANNED -           FILES_SCANNED -
# Line 5986  Internet-Draft        LinuxSampler Contr Line 6292  Internet-Draft        LinuxSampler Contr
6292    
6293     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
6294    
   
   
 Schoenebeck              Expires March 14, 2009               [Page 107]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6295     Example:     Example:
6296    
6297        C: "GET DB_INSTRUMENTS_JOB INFO 2"        C: "GET DB_INSTRUMENTS_JOB INFO 2"
# Line 6021  Internet-Draft        LinuxSampler Contr Line 6320  Internet-Draft        LinuxSampler Contr
6320    
6321           on success           on success
6322    
6323    
6324    
6325    
6326    
6327    Schoenebeck               Expires April 8, 2011               [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol         October 2010
6330    
6331    
6332        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6333    
6334           If the formatting of the instruments database failed.           If the formatting of the instruments database failed.
# Line 6040  Internet-Draft        LinuxSampler Contr Line 6348  Internet-Draft        LinuxSampler Contr
6348    
6349        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6350    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 108]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6351           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
6352           error message.           error message.
6353    
# Line 6076  Internet-Draft        LinuxSampler Contr Line 6375  Internet-Draft        LinuxSampler Contr
6375    
6376           on success           on success
6377    
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck               Expires April 8, 2011               [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol         October 2010
6386    
6387    
6388        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6389    
6390           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 6097  Internet-Draft        LinuxSampler Contr Line 6406  Internet-Draft        LinuxSampler Contr
6406     directory.  The sampler will automatically try to load all plugin     directory.  The sampler will automatically try to load all plugin
6407     DLLs in that directory on startup and only on startup!     DLLs in that directory on startup and only on startup!
6408    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 109]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6409     At the moment there is only one command for this feature set, but     At the moment there is only one command for this feature set, but
6410     this will most probably change in future.     this will most probably change in future.
6411    
# Line 6133  Internet-Draft        LinuxSampler Contr Line 6434  Internet-Draft        LinuxSampler Contr
6434     Note: consequently instrument editors are always spawned locally on     Note: consequently instrument editors are always spawned locally on
6435     the same machine where the sampler is running on!     the same machine where the sampler is running on!
6436    
6437    
6438    
6439    Schoenebeck               Expires April 8, 2011               [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol         October 2010
6442    
6443    
6444     Possible Answers:     Possible Answers:
6445    
6446        "OK" -        "OK" -
# Line 6152  Internet-Draft        LinuxSampler Contr Line 6460  Internet-Draft        LinuxSampler Contr
6460    
6461        C: "EDIT CHANNEL INSTRUMENT 0"        C: "EDIT CHANNEL INSTRUMENT 0"
6462    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 110]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6463        S: "OK"        S: "OK"
6464    
6465  6.10.  Managing Files  6.10.  Managing Files
# Line 6190  Internet-Draft        LinuxSampler Contr Line 6489  Internet-Draft        LinuxSampler Contr
6489        On success, the sampler will answer by returning the amount of        On success, the sampler will answer by returning the amount of
6490        instruments.        instruments.
6491    
6492    
6493    
6494    
6495    Schoenebeck               Expires April 8, 2011               [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol         October 2010
6498    
6499    
6500        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6501    
6502           if the file could not be handled           if the file could not be handled
# Line 6209  Internet-Draft        LinuxSampler Contr Line 6516  Internet-Draft        LinuxSampler Contr
6516    
6517     Where <filename> is the name of the instrument file (encapsulated     Where <filename> is the name of the instrument file (encapsulated
6518     into apostrophes, supporting escape sequences as described in chapter     into apostrophes, supporting escape sequences as described in chapter
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 111]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6519     "Character Set and Escape Sequences (Section 7.1)").     "Character Set and Escape Sequences (Section 7.1)").
6520    
6521     The sampler will try to ask all sampler engines, whether they support     The sampler will try to ask all sampler engines, whether they support
# Line 6244  Internet-Draft        LinuxSampler Contr Line 6543  Internet-Draft        LinuxSampler Contr
6543     instrument within a given instrument file by sending the following     instrument within a given instrument file by sending the following
6544     command:     command:
6545    
6546    
6547    
6548    
6549    
6550    
6551    Schoenebeck               Expires April 8, 2011               [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol         October 2010
6554    
6555    
6556        GET FILE INSTRUMENT INFO <filename> <instr-id>        GET FILE INSTRUMENT INFO <filename> <instr-id>
6557    
6558     Where <filename> is the name of the instrument file (encapsulated     Where <filename> is the name of the instrument file (encapsulated
# Line 6266  Internet-Draft        LinuxSampler Contr Line 6575  Internet-Draft        LinuxSampler Contr
6575    
6576    
6577    
   
   
 Schoenebeck              Expires March 14, 2009               [Page 112]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
   
   
6578           NAME -           NAME -
6579    
6580              name of the instrument as stored in the instrument file              name of the instrument as stored in the instrument file
# Line 6302  Internet-Draft        LinuxSampler Contr Line 6602  Internet-Draft        LinuxSampler Contr
6602              instrument's key mapping in the range between 0 .. 127,              instrument's key mapping in the range between 0 .. 127,
6603              reflecting the analog meaning of the MIDI specification.              reflecting the analog meaning of the MIDI specification.
6604    
6605    
6606    
6607    Schoenebeck               Expires April 8, 2011               [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol         October 2010
6610    
6611    
6612           KEYSWITCH_BINDINGS -           KEYSWITCH_BINDINGS -
6613    
6614              comma separated list of integer values representing the              comma separated list of integer values representing the
# Line 6321  Internet-Draft        LinuxSampler Contr Line 6628  Internet-Draft        LinuxSampler Contr
6628    
6629           "FORMAT_VERSION: 3"           "FORMAT_VERSION: 3"
6630    
6631             "PRODUCT: The Backbone Bongo Beats"
6632    
6633             "ARTISTS: Jimmy the Fish"
6634    
6635             "."
6636    
6637    6.11.  Managing Effects
6638    
6639       Audio effects (e.g. reverb, delay, compression) can be applied to the
6640       audio signals generated by the sampler.  The sampler usually provides
6641       a set of internal audio effects for this task.  The exact set of
6642       effects depends on the availability of third party effect plugins
6643       installed on the system where the sampler runs on.
6644    
6645       At the moment only "send effects" are supported.  Support for "insert
6646       effects" and "master effects" is planned to be added at a later
6647       point.
6648    
6649       The following commands allow to retrieve the set of internal effects
6650       available to the sampler, detailed informations about those effects
6651       and to create and destroy instances of such effects.  After an
6652       instance of an effect is created, the effect instance can be inserted
6653       into the audio signal path of the sampler, e.g. as send effect.
6654    
6655       The sampler allows to create an arbitrary amount of so called send
6656       effect chains.  Each effect chain can host an arbitrary amount of
6657       effect instances.  The output of the first effect instance in an
6658       effect chain is fed to the input of the second effect instance of the
6659       chain and so on.  So effects in one chain are processed sequentially.
6660    
6661    
6662  Schoenebeck              Expires March 14, 2009               [Page 113]  
6663    Schoenebeck               Expires April 8, 2011               [Page 119]
6664    
6665  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
6666    
6667    
6668           "PRODUCT: The Backbone Bongo Beats"     Send effect chains however are processed in parallel to other send
6669       effect chains.  Audio signals of sampler channels are fed to send
6670       effects by creating FX sends to the respective sampler channel and
6671       assigning a destination send effect to that FX by using the "SET
6672       FX_SEND SEND_EFFECT" (Section 6.4.32) command.  The latter allows to
6673       route the FX send to the beginning of a send effect chain, as well as
6674       directly to any other position of the send effect chain.
6675    
6676           "ARTISTS: Jimmy the Fish"  6.11.1.  Retrieve amount of available effects
6677    
6678       The front-end can retrieve the amount of internal effects, available
6679       to the sampler by sending the following command:
6680    
6681          GET AVAILABLE_EFFECTS
6682    
6683       Possible Answers:
6684    
6685          The sampler will answer by returning the current number of effects
6686          available to the sampler.
6687    
6688       Examples:
6689    
6690          C: "GET AVAILABLE_EFFECTS"
6691    
6692          S: "129"
6693    
6694    6.11.2.  Get list of available effects
6695    
6696       The set of available internal effects can change at runtime.  The
6697       front-end can retrieve the list of internal effects, available to the
6698       sampler by sending the following command:
6699    
6700          LIST AVAILABLE_EFFECTS
6701    
6702       Possible Answers:
6703    
6704          The sampler will answer by returning a comma separated list with
6705          numerical IDs of effects.  Note: the numercial ID of an effect is
6706          generated by the sampler for the current moment.  The numerical ID
6707          of the same effect can change at runtime, e.g. when the user
6708          requests a rescan of available effect plugins.
6709    
6710       Example:
6711    
6712          C: "LIST AVAILABLE_EFFECTS"
6713    
6714          S: "5,6,7,120,121,122,123,124"
6715    
6716    
6717    
6718    
6719    Schoenebeck               Expires April 8, 2011               [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol         October 2010
6722    
6723    
6724    6.11.3.  Retrieving general information about an effect
6725    
6726       The front-end can ask for general informations about an effect by
6727       sending the following command:
6728    
6729          GET EFFECT INFO <effect-index>
6730    
6731       Where <effect-index> is the numerical ID of an effect as returned by
6732       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
6733    
6734       Possible Answers:
6735    
6736          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6737          answer line begins with the effect information category name,
6738          followed by a colon and then a space character <SP> and finally
6739          the info character string to that effect information category.  At
6740          the moment the following categories are defined:
6741    
6742    
6743    
6744             SYSTEM -
6745    
6746                name of the effect plugin system the effect is based on
6747                (e.g.  "LADSPA")
6748    
6749             MODULE -
6750    
6751                module of the effect plugin system that contains this
6752                effect, the module is usually the dynamic-linked library
6753                (DLL) filename of the effect plugin, including full path
6754                (note that this filename may contain escape sequences
6755                (Section 7.1))
6756    
6757             NAME -
6758    
6759                character string defining the unique name of the effect
6760                within its module (note that the character string may
6761                contain escape sequences (Section 7.1))
6762    
6763             DESCRIPTION -
6764    
6765                human readable name of the effect, intended to be displayed
6766                in user interfaces (note that the character string may
6767                contain escape sequences (Section 7.1))
6768    
6769       The mentioned fields above don't have to be in particular order.
6770    
6771       Example:
6772    
6773    
6774    
6775    Schoenebeck               Expires April 8, 2011               [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol         October 2010
6778    
6779    
6780          C: "GET EFFECT INFO 121"
6781    
6782          S: "SYSTEM: LADSPA"
6783    
6784             "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"
6785    
6786             "NAME: lowpass_iir"
6787    
6788             "DESCRIPTION: Glame Lowpass Filter"
6789    
6790           "."           "."
6791    
6792    6.11.4.  Creating an instance of an effect by its portable ID
6793    
6794       The front-end can spawn an instance of the desired effect by sending
6795       the following command:
6796    
6797          CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name>
6798    
6799       Where <effect-system> is the "SYSTEM" field, <module> the "MODULE"
6800       field and <effect-name> the "NAME" field as returned by the "GET
6801       EFFECT INFO" (Section 6.11.3) command.  The filename of argument
6802       <module> and the character string of argument <effect-name> may
6803       contain escape sequences (Section 7.1).
6804    
6805       The sampler will try to load the requested effect and to create an
6806       instance of it.  To allow loading the same effect on a different
6807       machine, probably even running a completely different operating
6808       system (e.g.  Linux vs. Windows), the sampler tries to match <module>
6809       "softly".  That means it first tries to find an effect that exactly
6810       matches the given <module> argument.  If there is no exact match, the
6811       sampler will try to lower the restrictions on matching the <module>
6812       argument more and more, e.g. by ignoring upper / lower case
6813       differences and by ignoring the path of the DLL filename and file
6814       extension.  If there is still no match at the end, the sampler will
6815       try to ignore the <module> argument completely and as a last resort
6816       search for an effect that only matches the given <effect-system> and
6817       <effect-name> arguments.
6818    
6819       Possible Answers:
6820    
6821          "OK[<effect-instance>]" -
6822    
6823             in case the effect instance was successfully created, where
6824             <effect-instance> is the numerical ID of the new effect
6825             instance
6826    
6827    
6828    
6829    
6830    
6831    Schoenebeck               Expires April 8, 2011               [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol         October 2010
6834    
6835    
6836          "WRN:<warning-code>:<warning-message>" -
6837    
6838             in case the effect instance was spawned successfully, but there
6839             are noteworthy issue(s) related, providing an appropriate
6840             warning code and warning message
6841    
6842          "ERR:<error-code>:<error-message>" -
6843    
6844             if the effect could not be instantiated
6845    
6846       Examples:
6847    
6848          C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/
6849          mod_delay_1419.so' 'modDelay'"
6850    
6851          S: "OK[0]"
6852    
6853    6.11.5.  Creating an instance of an effect by its numerical ID
6854    
6855       The front-end can spawn an instance of the desired effect by sending
6856       the following command:
6857    
6858          CREATE EFFECT_INSTANCE <effect-index>
6859    
6860       Where <effect-index> is the numerical ID of the effect as returned by
6861       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
6862    
6863       The sampler will try to load the requested effect and to create an
6864       instance of it.
6865    
6866       Note: Since the numerical ID of a certain effect can change at any
6867       time, you should not use this command in LSCP files to restore a
6868       certain effect at a later time!  To store a sampler session including
6869       all its effects, use the portable text-based version of "CREATE
6870       EFFECT_INSTANCE" (Section 6.11.4) instead!  This allows to restore a
6871       sampler session with all its effects also on other machines, possibly
6872       even running a completely different operating system (e.g.  Linux vs.
6873       Windows), with different plugin directories or plugin DLL names.
6874    
6875       Possible Answers:
6876    
6877          "OK[<effect-instance>]" -
6878    
6879             in case the effect instance was successfully created, where
6880             <effect-instance> is the numerical ID of the new effect
6881             instance
6882    
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires April 8, 2011               [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol         October 2010
6890    
6891    
6892          "WRN:<warning-code>:<warning-message>" -
6893    
6894             in case the effect instance was spawned successfully, but there
6895             are noteworthy issue(s) related, providing an appropriate
6896             warning code and warning message
6897    
6898          "ERR:<error-code>:<error-message>" -
6899    
6900             if the effect could not be instantiated
6901    
6902       Examples:
6903    
6904          C: "CREATE EFFECT_INSTANCE 72"
6905    
6906          S: "OK[5]"
6907    
6908    6.11.6.  Destroy an effect instance
6909    
6910       The front-end can destroy an unusued effect instance and thus freeing
6911       it from memory by sending the following command:
6912    
6913          DESTROY EFFECT_INSTANCE <effect-instance>
6914    
6915       Where <effect-instance> is the numerical ID of the effect instance as
6916       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
6917       EFFECT_INSTANCES" (Section 6.11.8) command.
6918    
6919       The effect instance can only be destroyed if it's not used in any
6920       part of the sampler's audio signal path anymore.  If the effect
6921       instance is still in use somewhere, trying to destroy the effect
6922       instance will result in an error message.
6923    
6924       Possible Answers:
6925    
6926          "OK" -
6927    
6928             in case the effect instance was successfully destroyed
6929    
6930          "ERR:<error-code>:<error-message>" -
6931    
6932             in case it failed, providing an appropriate error code and
6933             error message
6934    
6935       Examples:
6936    
6937          C: "DESTROY EFFECT_INSTANCE 5"
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck               Expires April 8, 2011               [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol         October 2010
6946    
6947    
6948          S: "OK"
6949    
6950    6.11.7.  Retrieve amount of effect instances
6951    
6952       The front-end can retrieve the current amount of effect instances by
6953       sending the following command:
6954    
6955          GET EFFECT_INSTANCES
6956    
6957       Possible Answers:
6958    
6959          The sampler will answer by returning the current number of effect
6960          instances created and not yet destroyed in the current sampler
6961          session.
6962    
6963       Examples:
6964    
6965          C: "GET EFFECT_INSTANCES"
6966    
6967          S: "14"
6968    
6969    6.11.8.  Get list of effect instances
6970    
6971       The front-end can retrieve the current list of effect instances by
6972       sending the following command:
6973    
6974          LIST EFFECT_INSTANCES
6975    
6976       Possible Answers:
6977    
6978          The sampler will answer by returning a comma separated list with
6979          numerical IDs of effects instances.
6980    
6981       Example:
6982    
6983          C: "LIST EFFECT_INSTANCES"
6984    
6985          S: "9,11,14,15,16,17,25"
6986    
6987    6.11.9.  Retrieving current information about an effect instance
6988    
6989       The front-end can ask for the current informations about a particular
6990       effect instance by sending the following command:
6991    
6992          GET EFFECT_INSTANCE INFO <effect-instance>
6993    
6994       Where <effect-instance> is the numerical ID of an effect instance as
6995       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
6996    
6997    
6998    
6999    Schoenebeck               Expires April 8, 2011               [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol         October 2010
7002    
7003    
7004       EFFECT_INSTANCES" (Section 6.11.8) command.
7005    
7006       Possible Answers:
7007    
7008          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7009          answer line begins with the information category name, followed by
7010          a colon and then a space character <SP> and finally the info
7011          character string to that information category.  At the moment the
7012          following categories are defined:
7013    
7014    
7015    
7016             SYSTEM -
7017    
7018                name of the effect plugin system the effect is based on
7019                (e.g.  "LADSPA")
7020    
7021             MODULE -
7022    
7023                module of the effect plugin system that contains this
7024                effect, the module is usually the dynamic-linked library
7025                (DLL) filename of the effect plugin, including full path
7026                (note that this filename may contain escape sequences
7027                (Section 7.1))
7028    
7029             NAME -
7030    
7031                character string defining the unique name of the effect
7032                within its module (note that the character string may
7033                contain escape sequences (Section 7.1))
7034    
7035             DESCRIPTION -
7036    
7037                human readable name of the effect, intended to be displayed
7038                in user interfaces (note that the character string may
7039                contain escape sequences (Section 7.1))
7040    
7041             INPUT_CONTROLS -
7042    
7043                amount of input controls the effect instance provides, to
7044                allow controlling the effect parameters in realtime
7045    
7046       The mentioned fields above don't have to be in particular order.
7047    
7048       Example:
7049    
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck               Expires April 8, 2011               [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol         October 2010
7058    
7059    
7060          C: "GET EFFECT_INSTANCE INFO 3"
7061    
7062          S: "SYSTEM: LADSPA"
7063    
7064             "MODULE: /usr/lib/ladspa/mod_delay_1419.so"
7065    
7066             "NAME: modDelay"
7067    
7068             "DESCRIPTION: Modulatable delay"
7069    
7070             "INPUT_CONTROLS: 1"
7071    
7072             "."
7073    
7074    6.11.10.  Retrieving information about an effect parameter
7075    
7076       Effects typically provide a certain set of effect parameters which
7077       can be altered by the user in realtime (e.g. depth of a reverb
7078       effect, duration of a delay effect, dry / wet signal ratio).  Those
7079       controllable effect parameters are called "input controls".  The
7080       front-end can ask for the current informations of an effect
7081       instance's input control by sending the following command:
7082    
7083          GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-
7084          control>
7085    
7086       Where <effect-instance> is the numerical ID of an effect instance as
7087       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7088       EFFECT_INSTANCES" (Section 6.11.8) command and <input-control> is the
7089       index of the input control within the numerical bounds as returned by
7090       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7091       (Section 6.11.9) command.
7092    
7093       Possible Answers:
7094    
7095          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7096          answer line begins with the information category name, followed by
7097          a colon and then a space character <SP> and finally the info
7098          character string to that information category.  There are
7099          information categories which are always returned, independent of
7100          the respective effect parameter and there are optional information
7101          categories which are only shown for certain effect parameters.  At
7102          the moment the following categories are defined:
7103    
7104    
7105    
7106             DESCRIPTION -
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires April 8, 2011               [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol         October 2010
7114    
7115    
7116                (always returned) human readable name of the effect
7117                parameter, intended to be displayed in user interfaces (note
7118                that the character string may contain escape sequences
7119                (Section 7.1))
7120    
7121             VALUE -
7122    
7123                (always returned) current (optional dotted) floating point
7124                value of this effect parameter
7125    
7126             RANGE_MIN -
7127    
7128                (optionally returned) minimum allowed value for this effect
7129                parameter
7130    
7131             RANGE_MAX -
7132    
7133                (optionally returned) maximum allowed value for this effect
7134                parameter
7135    
7136             POSSIBILITIES -
7137    
7138                (optionally returned) comma separated list of (optional
7139                dotted) floating point numbers, reflecting the exact set of
7140                possible values for this effect parameter
7141    
7142             DEFAULT -
7143    
7144                (optionally returned) default value of this effect parameter
7145    
7146       The mentioned fields above don't have to be in particular order.
7147    
7148       Example:
7149    
7150          C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"
7151    
7152          S: "SYSTEM: LADSPA"
7153    
7154             "DESCRIPTION: Base delay (s)"
7155    
7156             "VALUE: 0.500"
7157    
7158             "RANGE_MIN: 0.000"
7159    
7160             "."
7161    
7162    
7163    
7164    
7165    
7166    
7167    Schoenebeck               Expires April 8, 2011               [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol         October 2010
7170    
7171    
7172    6.11.11.  Altering an effect parameter
7173    
7174       The front-end can alter the current value of an effect parameter by
7175       sending the following command:
7176    
7177          SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-
7178          control> <value>
7179    
7180       Where <effect-instance> is the numerical ID of the effect instance as
7181       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7182       EFFECT_INSTANCES" (Section 6.11.8) command, <input-control> is the
7183       index of the input control within the numerical bounds as returned by
7184       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7185       (Section 6.11.9) command and <value> is the new (optional dotted)
7186       floating point value for this effect parameter.
7187    
7188       Possible Answers:
7189    
7190          "OK" -
7191    
7192             in case the effect was altered successfully
7193    
7194          "ERR:<error-code>:<error-message>" -
7195    
7196             in case it failed, providing an appropriate error code and
7197             error message
7198    
7199       Examples:
7200    
7201          C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"
7202    
7203          S: "OK"
7204    
7205    6.11.12.  Retrieve amount of send effect chains
7206    
7207       The front-end can retrieve the current amount of send effect chains
7208       of an audio output device by sending the following command:
7209    
7210          GET SEND_EFFECT_CHAINS <audio-device>
7211    
7212       Where <audio-device> should be replaced by the numerical ID of the
7213       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7214       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7215       command.
7216    
7217       Possible Answers:
7218    
7219    
7220    
7221    
7222    
7223    Schoenebeck               Expires April 8, 2011               [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol         October 2010
7226    
7227    
7228          The sampler will answer by returning the current number of send
7229          effect chains of the supplied audio output device.
7230    
7231       Examples:
7232    
7233          C: "GET SEND_EFFECT_CHAINS 0"
7234    
7235          S: "4"
7236    
7237    6.11.13.  Retrieve list of send effect chains
7238    
7239       The front-end can retrieve the current list of send effect chains of
7240       an audio output device by sending the following command:
7241    
7242          LIST SEND_EFFECT_CHAINS <audio-device>
7243    
7244       Where <audio-device> should be replaced by the numerical ID of the
7245       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7246       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7247       command.
7248    
7249       Possible Answers:
7250    
7251          The sampler will answer by returning a comma separated list with
7252          numerical IDs of send effect chains of the supplied audio output
7253          device.
7254    
7255       Examples:
7256    
7257          C: "LIST SEND_EFFECT_CHAINS 0"
7258    
7259          S: "3,4,7"
7260    
7261    6.11.14.  Add send effect chain
7262    
7263       The front-end can add a send effect chain by sending the following
7264       command:
7265    
7266          ADD SEND_EFFECT_CHAIN <audio-device>
7267    
7268       Where <audio-device> should be replaced by the numerical ID of the
7269       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7270       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7271       command.
7272    
7273       Possible Answers:
7274    
7275    
7276    
7277    
7278    
7279    Schoenebeck               Expires April 8, 2011               [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol         October 2010
7282    
7283    
7284          "OK[<effect-chain>]" -
7285    
7286             in case the send effect chain was added successfully, where
7287             <effect-chain> is the numerical ID of the new send effect chain
7288    
7289          "ERR:<error-code>:<error-message>" -
7290    
7291             if the send effect chain could not be added
7292    
7293       Examples:
7294    
7295          C: "ADD SEND_EFFECT_CHAIN 0"
7296    
7297          S: "OK[2]"
7298    
7299    6.11.15.  Remove send effect chain
7300    
7301       The front-end can remove a send effect chain by sending the following
7302       command:
7303    
7304          REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain>
7305    
7306       Where <audio-device> should be replaced by the numerical ID of the
7307       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7308       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7309       command and <effect-chain> by the numerical ID as returned by the
7310       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7311       SEND_EFFECT_CHAINS" (Section 6.11.13) command.
7312    
7313       Possible Answers:
7314    
7315          "OK" -
7316    
7317             in case the send effect chain was removed successfully
7318    
7319          "ERR:<error-code>:<error-message>" -
7320    
7321             if the send effect chain could not be removed
7322    
7323       Examples:
7324    
7325          C: "REMOVE SEND_EFFECT_CHAIN 0 2"
7326    
7327          S: "OK"
7328    
7329    
7330    
7331    
7332    
7333    
7334    
7335    Schoenebeck               Expires April 8, 2011               [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol         October 2010
7338    
7339    
7340    6.11.16.  Retrieving information about a send effect chain
7341    
7342       The front-end can ask for informations of a send effect chain by
7343       sending the following command:
7344    
7345          GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain>
7346    
7347       Where <audio-device> should be replaced by the numerical ID of the
7348       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7349       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7350       command and <effect-chain> by the numerical ID as returned by the
7351       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7352       SEND_EFFECT_CHAINS" (Section 6.11.13) command.
7353    
7354       Possible Answers:
7355    
7356          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7357          answer line begins with the information category name, followed by
7358          a colon and then a space character <SP> and finally the info
7359          character string to that information category.  At the moment the
7360          following categories are defined:
7361    
7362    
7363    
7364             EFFECT_COUNT -
7365    
7366                amount of effects in this send effect chain
7367    
7368             EFFECT_SEQUENCE -
7369    
7370                comma separated list of the numerical IDs of the effect
7371                instances in this send effect chain, in the order as they
7372                are procssed in the effect chain
7373    
7374       The mentioned fields above don't have to be in particular order.
7375    
7376       Example:
7377    
7378          C: "GET SEND_EFFECT_CHAIN INFO 0 2"
7379    
7380          S: "EFFECT_COUNT: 3"
7381    
7382             "EFFECT_SEQUENCE: 31,4,7"
7383    
7384             "."
7385    
7386    
7387    
7388    
7389    
7390    
7391    Schoenebeck               Expires April 8, 2011               [Page 132]
7392    
7393    Internet-Draft        LinuxSampler Control Protocol         October 2010
7394    
7395    
7396    6.11.17.  Append effect instance to a send effect chain
7397    
7398       The front-end can add an unused effect instance to the end of a send
7399       effect chain by sending the following command:
7400    
7401          APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7402          <effect-instance>
7403    
7404       Where <audio-device> should be replaced by the numerical ID of the
7405       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7406       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7407       command and <effect-chain> by the numerical ID as returned by the
7408       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7409       SEND_EFFECT_CHAINS" (Section 6.11.13) command and <effect-instance>
7410       as returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7411       EFFECT_INSTANCES" (Section 6.11.8) command.
7412    
7413       Only unused effect instances can be added to the effect chain.
7414       Trying to add an effect instance which is already in use somewhere in
7415       the audio signal path of the sampler will result in an error.
7416    
7417       Possible Answers:
7418    
7419          "OK" -
7420    
7421             in case the effect instance was added successfully to the chain
7422    
7423          "ERR:<error-code>:<error-message>" -
7424    
7425             if the effect instance could not be added
7426    
7427       Examples:
7428    
7429          C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"
7430    
7431          S: "OK"
7432    
7433    6.11.18.  Insert effect instance to a send effect chain
7434    
7435       The front-end can add an unused effect instance to a certain position
7436       of a send effect chain by sending the following command:
7437    
7438          INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7439          <chain-pos> <effect-instance>
7440    
7441       Where <audio-device> should be replaced by the numerical ID of the
7442       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7443       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7444    
7445    
7446    
7447    Schoenebeck               Expires April 8, 2011               [Page 133]
7448    
7449    Internet-Draft        LinuxSampler Control Protocol         October 2010
7450    
7451    
7452       command, <effect-chain> by the numerical ID as returned by the "ADD
7453       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7454       (Section 6.11.13) command, <effect-instance> as returned by the
7455       "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST EFFECT_INSTANCES"
7456       (Section 6.11.8) command and <chain-pos> the exact position of the
7457       effect chain where the supplied effect shall be inserted to.
7458    
7459       Only unused effect instances can be added to the effect chain.
7460       Trying to add an effect instance which is already in use somewhere in
7461       the audio signal path of the sampler will result in an error.
7462    
7463       Possible Answers:
7464    
7465          "OK" -
7466    
7467             in case the effect instance was added successfully to the chain
7468    
7469          "ERR:<error-code>:<error-message>" -
7470    
7471             if the effect instance could not be added
7472    
7473       Examples:
7474    
7475          C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"
7476    
7477          S: "OK"
7478    
7479    6.11.19.  Remove effect instance from send effect chain
7480    
7481       The front-end can remove an effect instance from a certain position
7482       of a send effect chain by sending the following command:
7483    
7484          REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7485          <chain-pos>
7486    
7487       Where <audio-device> should be replaced by the numerical ID of the
7488       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7489       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7490       command, <effect-chain> by the numerical ID as returned by the "ADD
7491       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7492       (Section 6.11.13) command and <chain-pos> the exact position of the
7493       effect instance to be removed from the effect chain.
7494    
7495       Possible Answers:
7496    
7497          "OK" -
7498    
7499    
7500    
7501    
7502    
7503  Schoenebeck              Expires March 14, 2009               [Page 114]  Schoenebeck               Expires April 8, 2011               [Page 134]
7504    
7505  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
7506    
7507    
7508             in case the effect instance was removed successfully
7509    
7510          "ERR:<error-code>:<error-message>" -
7511    
7512             if the effect instance could not be removed
7513    
7514       Examples:
7515    
7516          C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"
7517    
7518          S: "OK"
7519    
7520    
7521    
7522    
7523    
7524    
7525    
7526    
7527    
7528    
7529    
7530    
7531    
7532    
7533    
7534    
7535    
7536    
7537    
7538    
7539    
7540    
7541    
7542    
7543    
7544    
7545    
7546    
7547    
7548    
7549    
7550    
7551    
7552    
7553    
7554    
7555    
7556    
7557    
7558    
7559    Schoenebeck               Expires April 8, 2011               [Page 135]
7560    
7561    Internet-Draft        LinuxSampler Control Protocol         October 2010
7562    
7563    
7564  7.  Command Syntax  7.  Command Syntax
# Line 6436  Internet-Draft        LinuxSampler Contr Line 7612  Internet-Draft        LinuxSampler Contr
7612    
7613    
7614    
7615  Schoenebeck              Expires March 14, 2009               [Page 115]  Schoenebeck               Expires April 8, 2011               [Page 136]
7616    
7617  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
7618    
7619    
7620        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6467  Internet-Draft        LinuxSampler Contr Line 7643  Internet-Draft        LinuxSampler Contr
7643    
7644        / FORMAT SP format_instruction        / FORMAT SP format_instruction
7645    
7646        SEND SP send_instruction        / SEND SP send_instruction
7647    
7648          / APPEND SP append_instruction
7649    
7650          / INSERT SP insert_instruction
7651    
7652        / RESET        / RESET
7653    
# Line 6481  Internet-Draft        LinuxSampler Contr Line 7661  Internet-Draft        LinuxSampler Contr
7661    
7662        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
7663    
7664        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP
7665          db_path SP filename
7666    
7667    
       / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename  
7668    
       / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP  
       instrument_index  
7669    
7670    
7671    Schoenebeck               Expires April 8, 2011               [Page 137]
7672    
7673    Internet-Draft        LinuxSampler Control Protocol         October 2010
7674    
7675    
7676          / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
7677    
7678  Schoenebeck              Expires March 14, 2009               [Page 116]        / DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP
7679          filename
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
7680    
7681          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
7682    
7683          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
7684          instrument_index
7685    
7686        / DB_INSTRUMENTS SP db_path SP filename        / DB_INSTRUMENTS SP db_path SP filename
7687    
# Line 6505  Internet-Draft        LinuxSampler Contr Line 7691  Internet-Draft        LinuxSampler Contr
7691    
7692        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
7693    
7694          / SEND_EFFECT_CHAIN SP device_index
7695    
7696     subscribe_event =     subscribe_event =
7697    
7698        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
# Line 6533  Internet-Draft        LinuxSampler Contr Line 7721  Internet-Draft        LinuxSampler Contr
7721    
7722        / FX_SEND_INFO        / FX_SEND_INFO
7723    
7724    
7725    
7726    
7727    Schoenebeck               Expires April 8, 2011               [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol         October 2010
7730    
7731    
7732        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
7733    
7734        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
# Line 6545  Internet-Draft        LinuxSampler Contr Line 7741  Internet-Draft        LinuxSampler Contr
7741    
7742        / DB_INSTRUMENT_DIRECTORY_INFO        / DB_INSTRUMENT_DIRECTORY_INFO
7743    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 117]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7744        / DB_INSTRUMENT_COUNT        / DB_INSTRUMENT_COUNT
7745    
7746        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
# Line 6589  Internet-Draft        LinuxSampler Contr Line 7777  Internet-Draft        LinuxSampler Contr
7777    
7778        / BUFFER_FILL        / BUFFER_FILL
7779    
7780    
7781    
7782    
7783    Schoenebeck               Expires April 8, 2011               [Page 139]
7784    
7785    Internet-Draft        LinuxSampler Control Protocol         October 2010
7786    
7787    
7788        / CHANNEL_INFO        / CHANNEL_INFO
7789    
7790        / FX_SEND_COUNT        / FX_SEND_COUNT
# Line 6601  Internet-Draft        LinuxSampler Contr Line 7797  Internet-Draft        LinuxSampler Contr
7797    
7798        / MIDI_INSTRUMENT_COUNT        / MIDI_INSTRUMENT_COUNT
7799    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 118]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7800        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
7801    
7802        / DB_INSTRUMENT_DIRECTORY_COUNT        / DB_INSTRUMENT_DIRECTORY_COUNT
# Line 6646  Internet-Draft        LinuxSampler Contr Line 7834  Internet-Draft        LinuxSampler Contr
7834        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
7835        instr_load_mode SP entry_name        instr_load_mode SP entry_name
7836    
7837    
7838    
7839    Schoenebeck               Expires April 8, 2011               [Page 140]
7840    
7841    Internet-Draft        LinuxSampler Control Protocol         October 2010
7842    
7843    
7844     unmap_instruction =     unmap_instruction =
7845    
7846        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
# Line 6656  Internet-Draft        LinuxSampler Contr Line 7851  Internet-Draft        LinuxSampler Contr
7851    
7852        / MIDI_INSTRUMENT_MAP SP midi_map        / MIDI_INSTRUMENT_MAP SP midi_map
7853    
7854          / MIDI_INSTRUMENT_MAP SP ALL
7855    
7856          / SEND_EFFECT_CHAIN SP device_index SP effect_chain
7857    
7858          / SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
7859          chain_pos
7860    
7861          / FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id
 Schoenebeck              Expires March 14, 2009               [Page 119]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
       / MIDI_INSTRUMENT_MAP SP ALL  
7862    
7863        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
7864    
# Line 6677  Internet-Draft        LinuxSampler Contr Line 7870  Internet-Draft        LinuxSampler Contr
7870    
7871        AVAILABLE_ENGINES        AVAILABLE_ENGINES
7872    
7873          / AVAILABLE_EFFECTS
7874    
7875          / EFFECT_INSTANCES
7876    
7877          / EFFECT SP INFO SP effect_index
7878    
7879          / EFFECT_INSTANCE SP INFO SP effect_instance
7880    
7881          / EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP
7882          input_control
7883    
7884          / SEND_EFFECT_CHAINS SP device_index
7885    
7886          / SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
7887    
7888        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
7889    
7890        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
7891    
7892    
7893    
7894    
7895    Schoenebeck               Expires April 8, 2011               [Page 141]
7896    
7897    Internet-Draft        LinuxSampler Control Protocol         October 2010
7898    
7899    
7900        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
7901    
7902        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
# Line 6712  Internet-Draft        LinuxSampler Contr Line 7928  Internet-Draft        LinuxSampler Contr
7928        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
7929        string        string
7930    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 120]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7931        / CHANNELS        / CHANNELS
7932    
7933        / CHANNEL SP INFO SP sampler_channel        / CHANNEL SP INFO SP sampler_channel
# Line 6737  Internet-Draft        LinuxSampler Contr Line 7944  Internet-Draft        LinuxSampler Contr
7944    
7945        / TOTAL_STREAM_COUNT        / TOTAL_STREAM_COUNT
7946    
7947    
7948    
7949    
7950    
7951    Schoenebeck               Expires April 8, 2011               [Page 142]
7952    
7953    Internet-Draft        LinuxSampler Control Protocol         October 2010
7954    
7955    
7956        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
7957    
7958        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
# Line 6769  Internet-Draft        LinuxSampler Contr Line 7985  Internet-Draft        LinuxSampler Contr
7985    
7986        / DB_INSTRUMENTS_JOB SP INFO SP number        / DB_INSTRUMENTS_JOB SP INFO SP number
7987    
7988          / VOLUME
7989    
7990          / VOICES
7991    
7992          / STREAMS
 Schoenebeck              Expires March 14, 2009               [Page 121]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
       / VOLUME  
7993    
7994        / FILE SP INSTRUMENTS SP filename        / FILE SP INSTRUMENTS SP filename
7995    
# Line 6788  Internet-Draft        LinuxSampler Contr Line 8000  Internet-Draft        LinuxSampler Contr
8000        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
8001        param_val_list        param_val_list
8002    
8003    
8004    
8005    
8006    
8007    Schoenebeck               Expires April 8, 2011               [Page 143]
8008    
8009    Internet-Draft        LinuxSampler Control Protocol         October 2010
8010    
8011    
8012        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='
8013        param_val_list        param_val_list
8014    
# Line 6799  Internet-Draft        LinuxSampler Contr Line 8020  Internet-Draft        LinuxSampler Contr
8020        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
8021        param_val_list        param_val_list
8022    
8023          / EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP
8024          input_control SP control_value
8025    
8026        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
8027    
8028        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
# Line 6814  Internet-Draft        LinuxSampler Contr Line 8038  Internet-Draft        LinuxSampler Contr
8038        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
8039        volume_value        volume_value
8040    
8041          / FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP
8042          effect_chain SP chain_pos
8043    
8044        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
8045    
8046        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
# Line 6825  Internet-Draft        LinuxSampler Contr Line 8052  Internet-Draft        LinuxSampler Contr
8052    
8053        / DB_INSTRUMENT SP FILE_PATH SP filename SP filename        / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
8054    
8055          / ECHO SP boolean
8056    
8057          / VOLUME SP volume_value
8058    
8059    
8060    
8061    
8062  Schoenebeck              Expires March 14, 2009               [Page 122]  
8063    Schoenebeck               Expires April 8, 2011               [Page 144]
8064    
8065  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
8066    
8067    
8068        / ECHO SP boolean        / VOICES SP number
8069    
8070        / VOLUME SP volume_value        / STREAMS SP number
8071    
8072     create_instruction =     create_instruction =
8073    
# Line 6851  Internet-Draft        LinuxSampler Contr Line 8083  Internet-Draft        LinuxSampler Contr
8083    
8084        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
8085    
8086          / EFFECT_INSTANCE SP effect_index
8087    
8088          / EFFECT_INSTANCE SP effect_system SP module SP effect_name
8089    
8090     reset_instruction =     reset_instruction =
8091    
8092        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
# Line 6876  Internet-Draft        LinuxSampler Contr Line 8112  Internet-Draft        LinuxSampler Contr
8112    
8113     move_instruction =     move_instruction =
8114    
       DB_INSTRUMENT_DIRECTORY SP db_path SP db_path  
   
       / DB_INSTRUMENT SP db_path SP db_path  
8115    
    copy_instruction =  
8116    
8117    
8118    
8119  Schoenebeck              Expires March 14, 2009               [Page 123]  Schoenebeck               Expires April 8, 2011               [Page 145]
8120    
8121  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
8122    
8123    
8124        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8125    
8126        / DB_INSTRUMENT SP db_path SP db_path        / DB_INSTRUMENT SP db_path SP db_path
8127    
8128       copy_instruction =
8129    
8130          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8131    
8132          / DB_INSTRUMENT SP db_path SP db_path
8133    
8134     destroy_instruction =     destroy_instruction =
8135    
8136        AUDIO_OUTPUT_DEVICE SP number        AUDIO_OUTPUT_DEVICE SP number
# Line 6901  Internet-Draft        LinuxSampler Contr Line 8139  Internet-Draft        LinuxSampler Contr
8139    
8140        / FX_SEND SP sampler_channel SP fx_send_id        / FX_SEND SP sampler_channel SP fx_send_id
8141    
8142          / EFFECT_INSTANCE SP number
8143    
8144     load_instruction =     load_instruction =
8145    
8146        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
8147    
8148        / ENGINE SP load_engine_args        / ENGINE SP load_engine_args
8149    
8150       append_instruction =
8151    
8152          SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8153          effect_instance
8154    
8155       insert_instruction =
8156    
8157          SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8158          chain_pos SP effect_instance
8159    
8160     set_chan_instruction =     set_chan_instruction =
8161    
8162        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
# Line 6919  Internet-Draft        LinuxSampler Contr Line 8169  Internet-Draft        LinuxSampler Contr
8169        / MIDI_INPUT SP sampler_channel SP device_index SP        / MIDI_INPUT SP sampler_channel SP device_index SP
8170        midi_input_port_index SP midi_input_channel_index        midi_input_port_index SP midi_input_channel_index
8171    
8172    
8173    
8174    
8175    Schoenebeck               Expires April 8, 2011               [Page 146]
8176    
8177    Internet-Draft        LinuxSampler Control Protocol         October 2010
8178    
8179    
8180        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
8181    
8182        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
# Line 6936  Internet-Draft        LinuxSampler Contr Line 8194  Internet-Draft        LinuxSampler Contr
8194    
8195        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
8196    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 124]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8197        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
8198    
8199        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
# Line 6977  Internet-Draft        LinuxSampler Contr Line 8226  Internet-Draft        LinuxSampler Contr
8226    
8227     list_instruction =     list_instruction =
8228    
8229    
8230    
8231    Schoenebeck               Expires April 8, 2011               [Page 147]
8232    
8233    Internet-Draft        LinuxSampler Control Protocol         October 2010
8234    
8235    
8236        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
8237    
8238        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 6985  Internet-Draft        LinuxSampler Contr Line 8241  Internet-Draft        LinuxSampler Contr
8241    
8242        / AVAILABLE_ENGINES        / AVAILABLE_ENGINES
8243    
8244          / AVAILABLE_EFFECTS
8245    
8246          / EFFECT_INSTANCES
8247    
8248          / SEND_EFFECT_CHAINS SP number
8249    
8250        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
8251    
8252        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 6993  Internet-Draft        LinuxSampler Contr Line 8255  Internet-Draft        LinuxSampler Contr
8255    
8256        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
8257    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 125]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8258        / MIDI_INSTRUMENT_MAPS        / MIDI_INSTRUMENT_MAPS
8259    
8260        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
# Line 7028  Internet-Draft        LinuxSampler Contr Line 8282  Internet-Draft        LinuxSampler Contr
8282    
8283     load_engine_args =     load_engine_args =
8284    
8285    
8286    
8287    Schoenebeck               Expires April 8, 2011               [Page 148]
8288    
8289    Internet-Draft        LinuxSampler Control Protocol         October 2010
8290    
8291    
8292        engine_name SP sampler_channel        engine_name SP sampler_channel
8293    
8294     instr_load_mode =     instr_load_mode =
# Line 7038  Internet-Draft        LinuxSampler Contr Line 8299  Internet-Draft        LinuxSampler Contr
8299    
8300        / PERSISTENT        / PERSISTENT
8301    
8302       effect_instance =
8303    
8304          number
8305    
8306     device_index =     device_index =
8307    
8308        number        number
# Line 7048  Internet-Draft        LinuxSampler Contr Line 8313  Internet-Draft        LinuxSampler Contr
8313    
8314     audio_output_type_name =     audio_output_type_name =
8315    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 126]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8316        string        string
8317    
8318     midi_input_port_index =     midi_input_port_index =
# Line 7081  Internet-Draft        LinuxSampler Contr Line 8337  Internet-Draft        LinuxSampler Contr
8337    
8338        number        number
8339    
8340    
8341    
8342    
8343    Schoenebeck               Expires April 8, 2011               [Page 149]
8344    
8345    Internet-Draft        LinuxSampler Control Protocol         October 2010
8346    
8347    
8348     midi_prog =     midi_prog =
8349    
8350        number        number
# Line 7095  Internet-Draft        LinuxSampler Contr Line 8359  Internet-Draft        LinuxSampler Contr
8359    
8360        / number        / number
8361    
8362       control_value =
8363    
8364          real
8365    
8366     sampler_channel =     sampler_channel =
8367    
8368        number        number
# Line 7105  Internet-Draft        LinuxSampler Contr Line 8373  Internet-Draft        LinuxSampler Contr
8373    
8374     fx_send_id =     fx_send_id =
8375    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 127]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8376        number        number
8377    
8378     engine_name =     engine_name =
# Line 7133  Internet-Draft        LinuxSampler Contr Line 8393  Internet-Draft        LinuxSampler Contr
8393    
8394     entry_name =     entry_name =
8395    
8396    
8397    
8398    
8399    Schoenebeck               Expires April 8, 2011               [Page 150]
8400    
8401    Internet-Draft        LinuxSampler Control Protocol         October 2010
8402    
8403    
8404        stringval_escaped        stringval_escaped
8405    
8406     fx_send_name =     fx_send_name =
8407    
8408        stringval_escaped        stringval_escaped
8409    
8410       effect_name =
8411    
8412          stringval_escaped
8413    
8414       effect_index =
8415    
8416          number
8417    
8418       effect_chain =
8419    
8420          number
8421    
8422       chain_pos =
8423    
8424          number
8425    
8426       input_control =
8427    
8428          number
8429    
8430     param_val_list =     param_val_list =
8431    
8432        param_val        param_val
# Line 7164  Internet-Draft        LinuxSampler Contr Line 8452  Internet-Draft        LinuxSampler Contr
8452    
8453    
8454    
8455  Schoenebeck              Expires March 14, 2009               [Page 128]  Schoenebeck               Expires April 8, 2011               [Page 151]
8456    
8457  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
8458    
8459    
8460     query_val =     query_val =
# Line 7183  Internet-Draft        LinuxSampler Contr Line 8471  Internet-Draft        LinuxSampler Contr
8471    
8472        / FLAT        / FLAT
8473    
8474       effect_system =
8475    
8476          string
8477    
8478       module =
8479    
8480          filename
8481    
8482  7.1.  Character Set and Escape Sequences  7.1.  Character Set and Escape Sequences
8483    
8484     Older versions of this protocol up to and including v1.1 only     Older versions of this protocol up to and including v1.1 only
# Line 7193  Internet-Draft        LinuxSampler Contr Line 8489  Internet-Draft        LinuxSampler Contr
8489     certain, explicitly declared parts of the protocol.  The supported     certain, explicitly declared parts of the protocol.  The supported
8490     escape sequences are defined as follows:     escape sequences are defined as follows:
8491    
8492    
8493    
8494    
8495    
8496    
8497    
8498    
8499    
8500    
8501    
8502    
8503    
8504    
8505    
8506    
8507    
8508    
8509    
8510    
8511    Schoenebeck               Expires April 8, 2011               [Page 152]
8512    
8513    Internet-Draft        LinuxSampler Control Protocol         October 2010
8514    
8515    
8516     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
8517     | ASCII Character        | Translated into (Name)                   |     | ASCII Character        | Translated into (Name)                   |
8518     | Sequence               |                                          |     | Sequence               |                                          |
# Line 7216  Internet-Draft        LinuxSampler Contr Line 8536  Internet-Draft        LinuxSampler Contr
8536     | \OOO                   | three digit octal ASCII code of the      |     | \OOO                   | three digit octal ASCII code of the      |
8537     |                        | character                                |     |                        | character                                |
8538     |                        |                                          |     |                        |                                          |
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 129]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8539     | \xHH                   | two digit hex ASCII code of the          |     | \xHH                   | two digit hex ASCII code of the          |
8540     |                        | character                                |     |                        | character                                |
8541     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 7249  Internet-Draft        LinuxSampler Contr Line 8560  Internet-Draft        LinuxSampler Contr
8560    
8561        "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)        "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
8562    
8563    
8564    
8565    
8566    
8567    Schoenebeck               Expires April 8, 2011               [Page 153]
8568    
8569    Internet-Draft        LinuxSampler Control Protocol         October 2010
8570    
8571    
8572        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
8573    
8574        "ADD DB_INSTRUMENTS" (Section 6.8.11)        "ADD DB_INSTRUMENTS" (Section 6.8.11)
# Line 7273  Internet-Draft        LinuxSampler Contr Line 8593  Internet-Draft        LinuxSampler Contr
8593    
8594        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
8595    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 130]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8596        "SET DB_INSTRUMENT NAME" (Section 6.8.16)        "SET DB_INSTRUMENT NAME" (Section 6.8.16)
8597    
8598        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
# Line 7305  Internet-Draft        LinuxSampler Contr Line 8617  Internet-Draft        LinuxSampler Contr
8617    
8618        "LIST FILE INSTRUMENTS" (Section 6.10.2)        "LIST FILE INSTRUMENTS" (Section 6.10.2)
8619    
8620    
8621    
8622    
8623    Schoenebeck               Expires April 8, 2011               [Page 154]
8624    
8625    Internet-Draft        LinuxSampler Control Protocol         October 2010
8626    
8627    
8628        "GET FILE INSTRUMENT INFO" (Section 6.10.3)        "GET FILE INSTRUMENT INFO" (Section 6.10.3)
8629    
8630          "GET EFFECT INFO" (Section 6.11.3)
8631    
8632          "GET EFFECT_INSTANCE INFO" (Section 6.11.9)
8633    
8634          "CREATE EFFECT_INSTANCE" (Section 6.11.4)
8635    
8636     Note that the forward slash character ('/') has a special meaning in     Note that the forward slash character ('/') has a special meaning in
8637     filename / path based arguments: it acts as separator of the nodes in     filename / path based arguments: it acts as separator of the nodes in
8638     the path, thus if a directory- or filename includes a forward slash     the path, thus if a directory- or filename includes a forward slash
# Line 7328  Internet-Draft        LinuxSampler Contr Line 8654  Internet-Draft        LinuxSampler Contr
8654    
8655        "GET SERVER INFO" (Section 6.6.5)        "GET SERVER INFO" (Section 6.6.5)
8656    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 131]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8657        "GET ENGINE INFO" (Section 6.4.9)        "GET ENGINE INFO" (Section 6.4.9)
8658    
8659        "GET CHANNEL INFO" (Section 6.4.10)        "GET CHANNEL INFO" (Section 6.4.10)
# Line 7355  Internet-Draft        LinuxSampler Contr Line 8672  Internet-Draft        LinuxSampler Contr
8672    
8673        "MAP MIDI_INSTRUMENT" (Section 6.7.7)        "MAP MIDI_INSTRUMENT" (Section 6.7.7)
8674    
8675    
8676    
8677    
8678    
8679    Schoenebeck               Expires April 8, 2011               [Page 155]
8680    
8681    Internet-Draft        LinuxSampler Control Protocol         October 2010
8682    
8683    
8684        "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)        "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
8685    
8686        "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)        "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
# Line 7373  Internet-Draft        LinuxSampler Contr Line 8699  Internet-Draft        LinuxSampler Contr
8699    
8700        "FIND DB_INSTRUMENTS" (Section 6.8.20)        "FIND DB_INSTRUMENTS" (Section 6.8.20)
8701    
8702          "GET EFFECT INFO" (Section 6.11.3)
8703    
8704          "GET EFFECT_INSTANCE INFO" (Section 6.11.9)
8705    
8706          "CREATE EFFECT_INSTANCE" (Section 6.11.4)
8707    
8708     Please note that these lists are manually maintained.  If you find a     Please note that these lists are manually maintained.  If you find a
8709     command that also supports escape sequences we forgot to mention     command that also supports escape sequences we forgot to mention
8710     here, please report it!     here, please report it!
# Line 7388  Internet-Draft        LinuxSampler Contr Line 8720  Internet-Draft        LinuxSampler Contr
8720    
8721    
8722    
8723  Schoenebeck              Expires March 14, 2009               [Page 132]  
8724    
8725    
8726    
8727    
8728    
8729    
8730    
8731    
8732    
8733    
8734    
8735    Schoenebeck               Expires April 8, 2011               [Page 156]
8736    
8737  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
8738    
8739    
8740  8.  Events  8.  Events
# Line 7444  Internet-Draft        LinuxSampler Contr Line 8788  Internet-Draft        LinuxSampler Contr
8788    
8789    
8790    
8791  Schoenebeck              Expires March 14, 2009               [Page 133]  Schoenebeck               Expires April 8, 2011               [Page 157]
8792    
8793  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
8794    
8795    
8796        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 7500  Internet-Draft        LinuxSampler Contr Line 8844  Internet-Draft        LinuxSampler Contr
8844    
8845    
8846    
8847  Schoenebeck              Expires March 14, 2009               [Page 134]  Schoenebeck               Expires April 8, 2011               [Page 158]
8848    
8849  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
8850    
8851    
8852        "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"        "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"
# Line 7556  Internet-Draft        LinuxSampler Contr Line 8900  Internet-Draft        LinuxSampler Contr
8900    
8901    
8902    
8903  Schoenebeck              Expires March 14, 2009               [Page 135]  Schoenebeck               Expires April 8, 2011               [Page 159]
8904    
8905  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
8906    
8907    
8908        SUBSCRIBE VOICE_COUNT        SUBSCRIBE VOICE_COUNT
# Line 7612  Internet-Draft        LinuxSampler Contr Line 8956  Internet-Draft        LinuxSampler Contr
8956    
8957    
8958    
8959  Schoenebeck              Expires March 14, 2009               [Page 136]  Schoenebeck               Expires April 8, 2011               [Page 160]
8960    
8961  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
8962    
8963    
8964        SUBSCRIBE CHANNEL_INFO        SUBSCRIBE CHANNEL_INFO
# Line 7668  Internet-Draft        LinuxSampler Contr Line 9012  Internet-Draft        LinuxSampler Contr
9012    
9013    
9014    
9015  Schoenebeck              Expires March 14, 2009               [Page 137]  Schoenebeck               Expires April 8, 2011               [Page 161]
9016    
9017  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
9018    
9019    
9020  8.14.  Total number of active voices changed  8.14.  Total number of active voices changed
# Line 7724  Internet-Draft        LinuxSampler Contr Line 9068  Internet-Draft        LinuxSampler Contr
9068    
9069    
9070    
9071  Schoenebeck              Expires March 14, 2009               [Page 138]  Schoenebeck               Expires April 8, 2011               [Page 162]
9072    
9073  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
9074    
9075    
9076        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
# Line 7780  Internet-Draft        LinuxSampler Contr Line 9124  Internet-Draft        LinuxSampler Contr
9124    
9125    
9126    
9127  Schoenebeck              Expires March 14, 2009               [Page 139]  Schoenebeck               Expires April 8, 2011               [Page 163]
9128    
9129  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
9130    
9131    
9132  8.20.  Global settings changed  8.20.  Global settings changed
# Line 7800  Internet-Draft        LinuxSampler Contr Line 9144  Internet-Draft        LinuxSampler Contr
9144        by the optional dotted floating point value, reflecting the new        by the optional dotted floating point value, reflecting the new
9145        global volume parameter.        global volume parameter.
9146    
9147          "NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the
9148          golbal limit of the sampler for maximum voices is changed, where
9149          <max-voices> will be an integer value, reflecting the new global
9150          voice limit parameter.
9151    
9152          "NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the
9153          golbal limit of the sampler for maximum disk streams is changed,
9154          where <max-streams> will be an integer value, reflecting the new
9155          global disk streams limit parameter.
9156    
9157  8.21.  Number of database instrument directories changed  8.21.  Number of database instrument directories changed
9158    
9159     Client may want to be notified when the number of instrument     Client may want to be notified when the number of instrument
# Line 7824  Internet-Draft        LinuxSampler Contr Line 9178  Internet-Draft        LinuxSampler Contr
9178     Client may want to be notified when changes were made to directories     Client may want to be notified when changes were made to directories
9179     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
9180    
9181    
9182    
9183    Schoenebeck               Expires April 8, 2011               [Page 164]
9184    
9185    Internet-Draft        LinuxSampler Control Protocol         October 2010
9186    
9187    
9188        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
9189    
9190     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7833  Internet-Draft        LinuxSampler Contr Line 9194  Internet-Draft        LinuxSampler Contr
9194     where <dir-path> will be replaced by the absolute path name of the     where <dir-path> will be replaced by the absolute path name of the
9195     directory, for which information changes occurred.  The front-end     directory, for which information changes occurred.  The front-end
9196     will have to send the respective command to actually get the updated     will have to send the respective command to actually get the updated
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 140]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
9197     directory info.  Because these messages will be triggered by LSCP     directory info.  Because these messages will be triggered by LSCP
9198     commands issued by other clients rather than real time events     commands issued by other clients rather than real time events
9199     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
# Line 7881  Internet-Draft        LinuxSampler Contr Line 9234  Internet-Draft        LinuxSampler Contr
9234    
9235     Server will start sending the following notification messages:     Server will start sending the following notification messages:
9236    
9237    
9238    
9239    Schoenebeck               Expires April 8, 2011               [Page 165]
9240    
9241    Internet-Draft        LinuxSampler Control Protocol         October 2010
9242    
9243    
9244        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
9245    
9246     where <instr-path> will be replaced by the absolute path name of the     where <instr-path> will be replaced by the absolute path name of the
# Line 7889  Internet-Draft        LinuxSampler Contr Line 9249  Internet-Draft        LinuxSampler Contr
9249     info.  Because these messages will be triggered by LSCP commands     info.  Because these messages will be triggered by LSCP commands
9250     issued by other clients rather than real time events happening on the     issued by other clients rather than real time events happening on the
9251     server, it is believed that an empty notification message is     server, it is believed that an empty notification message is
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 141]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
9252     sufficient here.     sufficient here.
9253    
9254        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
# Line 7937  Internet-Draft        LinuxSampler Contr Line 9289  Internet-Draft        LinuxSampler Contr
9289    
9290     where <string> will be replaced by whatever data server wants to send     where <string> will be replaced by whatever data server wants to send
9291     to the client.  Client MAY display this data to the user AS IS to     to the client.  Client MAY display this data to the user AS IS to
9292    
9293    
9294    
9295    Schoenebeck               Expires April 8, 2011               [Page 166]
9296    
9297    Internet-Draft        LinuxSampler Control Protocol         October 2010
9298    
9299    
9300     facilitate debugging.     facilitate debugging.
9301    
9302    
# Line 7948  Internet-Draft        LinuxSampler Contr Line 9308  Internet-Draft        LinuxSampler Contr
9308    
9309    
9310    
9311  Schoenebeck              Expires March 14, 2009               [Page 142]  
9312    
9313    
9314    
9315    
9316    
9317    
9318    
9319    
9320    
9321    
9322    
9323    
9324    
9325    
9326    
9327    
9328    
9329    
9330    
9331    
9332    
9333    
9334    
9335    
9336    
9337    
9338    
9339    
9340    
9341    
9342    
9343    
9344    
9345    
9346    
9347    
9348    
9349    
9350    
9351    Schoenebeck               Expires April 8, 2011               [Page 167]
9352    
9353  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
9354    
9355    
9356  9.  Security Considerations  9.  Security Considerations
# Line 8004  Internet-Draft        LinuxSampler Contr Line 9404  Internet-Draft        LinuxSampler Contr
9404    
9405    
9406    
9407  Schoenebeck              Expires March 14, 2009               [Page 143]  Schoenebeck               Expires April 8, 2011               [Page 168]
9408    
9409  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
9410    
9411    
9412  10.  Acknowledgments  10.  Acknowledgments
# Line 8060  Internet-Draft        LinuxSampler Contr Line 9460  Internet-Draft        LinuxSampler Contr
9460    
9461    
9462    
9463  Schoenebeck              Expires March 14, 2009               [Page 144]  Schoenebeck               Expires April 8, 2011               [Page 169]
9464    
9465  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
9466    
9467    
9468  11.  References  11.  References
# Line 8116  Internet-Draft        LinuxSampler Contr Line 9516  Internet-Draft        LinuxSampler Contr
9516    
9517    
9518    
9519  Schoenebeck              Expires March 14, 2009               [Page 145]  Schoenebeck               Expires April 8, 2011               [Page 170]
9520    
9521  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
9522    
9523    
9524  Author's Address  Author's Address
# Line 8172  Author's Address Line 9572  Author's Address
9572    
9573    
9574    
9575  Schoenebeck              Expires March 14, 2009               [Page 146]  Schoenebeck               Expires April 8, 2011               [Page 171]
9576    
9577  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol         October 2010
9578    
9579    
9580  Full Copyright Statement  Full Copyright Statement
9581    
9582     Copyright (C) The IETF Trust (2008).     Copyright (C) The IETF Trust (2010).
9583    
9584     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
9585     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 8219  Intellectual Property Line 9619  Intellectual Property
9619     ietf-ipr@ietf.org.     ietf-ipr@ietf.org.
9620    
9621    
 Acknowledgment  
9622    
    Funding for the RFC Editor function is provided by the IETF  
    Administrative Support Activity (IASA).  
9623    
9624    
9625    
9626    
9627    
9628  Schoenebeck              Expires March 14, 2009               [Page 147]  
9629    
9630    
9631    Schoenebeck               Expires April 8, 2011               [Page 172]
9632    
Legend:
Removed from v.1773  
changed lines
  Added in v.2139
  ViewVC Help
Powered by ViewVC