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: August 17, 2008 February 14, 2008 |
Expires: May 5, 2010 November 1, 2009 |
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 |
|
|
41 |
The list of Internet-Draft Shadow Directories can be accessed at |
The list of Internet-Draft Shadow Directories can be accessed at |
42 |
http://www.ietf.org/shadow.html. |
http://www.ietf.org/shadow.html. |
43 |
|
|
44 |
This Internet-Draft will expire on August 17, 2008. |
This Internet-Draft will expire on May 5, 2010. |
|
|
|
|
Copyright Notice |
|
|
|
|
|
Copyright (C) The IETF Trust (2008). |
|
45 |
|
|
46 |
|
|
47 |
|
|
52 |
|
|
53 |
|
|
54 |
|
|
55 |
|
Schoenebeck Expires May 5, 2010 [Page 1] |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 1] |
|
56 |
|
|
57 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
|
|
|
|
|
|
|
Abstract |
|
|
|
|
|
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. |
|
58 |
|
|
59 |
|
|
60 |
Table of Contents |
Table of Contents |
96 |
6.3.5. Creating a MIDI input device . . . . . . . . . . . . 35 |
6.3.5. Creating a MIDI input device . . . . . . . . . . . . 35 |
97 |
6.3.6. Destroying a MIDI input device . . . . . . . . . . . 36 |
6.3.6. Destroying a MIDI input device . . . . . . . . . . . 36 |
98 |
6.3.7. Getting all created MIDI input device count . . . . . 37 |
6.3.7. Getting all created MIDI input device count . . . . . 37 |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 2] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
99 |
6.3.8. Getting all created MIDI input device list . . . . . 37 |
6.3.8. Getting all created MIDI input device list . . . . . 37 |
100 |
6.3.9. Getting current settings of a MIDI input device . . . 38 |
6.3.9. Getting current settings of a MIDI input device . . . 38 |
101 |
6.3.10. Changing settings of MIDI input devices . . . . . . . 39 |
6.3.10. Changing settings of MIDI input devices . . . . . . . 39 |
105 |
6.3.13. Changing settings of MIDI input ports . . . . . . . . 42 |
6.3.13. Changing settings of MIDI input ports . . . . . . . . 42 |
106 |
6.4. Configuring sampler channels . . . . . . . . . . . . . . 43 |
6.4. Configuring sampler channels . . . . . . . . . . . . . . 43 |
107 |
6.4.1. Loading an instrument . . . . . . . . . . . . . . . . 43 |
6.4.1. Loading an instrument . . . . . . . . . . . . . . . . 43 |
108 |
|
|
109 |
|
|
110 |
|
|
111 |
|
Schoenebeck Expires May 5, 2010 [Page 2] |
112 |
|
|
113 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
114 |
|
|
115 |
|
|
116 |
6.4.2. Loading a sampler engine . . . . . . . . . . . . . . 44 |
6.4.2. Loading a sampler engine . . . . . . . . . . . . . . 44 |
117 |
6.4.3. Getting all created sampler channel count . . . . . . 45 |
6.4.3. Getting all created sampler channel count . . . . . . 45 |
118 |
6.4.4. Getting all created sampler channel list . . . . . . 46 |
6.4.4. Getting all created sampler channel list . . . . . . 46 |
128 |
6.4.14. Setting audio output device . . . . . . . . . . . . . 54 |
6.4.14. Setting audio output device . . . . . . . . . . . . . 54 |
129 |
6.4.15. Setting audio output type . . . . . . . . . . . . . . 55 |
6.4.15. Setting audio output type . . . . . . . . . . . . . . 55 |
130 |
6.4.16. Setting audio output channel . . . . . . . . . . . . 56 |
6.4.16. Setting audio output channel . . . . . . . . . . . . 56 |
131 |
6.4.17. Setting MIDI input device . . . . . . . . . . . . . . 56 |
6.4.17. Setting MIDI input device . . . . . . . . . . . . . . 57 |
132 |
6.4.18. Setting MIDI input type . . . . . . . . . . . . . . . 57 |
6.4.18. Setting MIDI input type . . . . . . . . . . . . . . . 57 |
133 |
6.4.19. Setting MIDI input port . . . . . . . . . . . . . . . 58 |
6.4.19. Setting MIDI input port . . . . . . . . . . . . . . . 58 |
134 |
6.4.20. Setting MIDI input channel . . . . . . . . . . . . . 58 |
6.4.20. Setting MIDI input channel . . . . . . . . . . . . . 59 |
135 |
6.4.21. Setting channel volume . . . . . . . . . . . . . . . 59 |
6.4.21. Setting channel volume . . . . . . . . . . . . . . . 59 |
136 |
6.4.22. Muting a sampler channel . . . . . . . . . . . . . . 60 |
6.4.22. Muting a sampler channel . . . . . . . . . . . . . . 60 |
137 |
6.4.23. Soloing a sampler channel . . . . . . . . . . . . . . 61 |
6.4.23. Soloing a sampler channel . . . . . . . . . . . . . . 61 |
146 |
6.4.31. Altering effect send's audio routing . . . . . . . . 67 |
6.4.31. Altering effect send's audio routing . . . . . . . . 67 |
147 |
6.4.32. Altering effect send's MIDI controller . . . . . . . 68 |
6.4.32. Altering effect send's MIDI controller . . . . . . . 68 |
148 |
6.4.33. Altering effect send's send level . . . . . . . . . . 69 |
6.4.33. Altering effect send's send level . . . . . . . . . . 69 |
149 |
6.4.34. Resetting a sampler channel . . . . . . . . . . . . . 70 |
6.4.34. Sending MIDI messages to sampler channel . . . . . . 70 |
150 |
6.5. Controlling connection . . . . . . . . . . . . . . . . . 71 |
6.4.35. Resetting a sampler channel . . . . . . . . . . . . . 71 |
151 |
6.5.1. Register front-end for receiving event messages . . . 71 |
6.5. Controlling connection . . . . . . . . . . . . . . . . . 72 |
152 |
|
6.5.1. Register front-end for receiving event messages . . . 72 |
153 |
6.5.2. Unregister front-end for not receiving event |
6.5.2. Unregister front-end for not receiving event |
154 |
messages . . . . . . . . . . . . . . . . . . . . . . 71 |
messages . . . . . . . . . . . . . . . . . . . . . . 73 |
155 |
6.5.3. Enable or disable echo of commands . . . . . . . . . 72 |
6.5.3. Enable or disable echo of commands . . . . . . . . . 73 |
156 |
|
6.5.4. Close client connection . . . . . . . . . . . . . . . 74 |
157 |
|
6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 74 |
158 |
|
6.6.1. Current number of active voices . . . . . . . . . . . 74 |
159 |
|
6.6.2. Maximum amount of active voices . . . . . . . . . . . 74 |
160 |
|
6.6.3. Current number of active disk streams . . . . . . . . 75 |
161 |
|
6.6.4. Reset sampler . . . . . . . . . . . . . . . . . . . . 75 |
162 |
|
6.6.5. General sampler informations . . . . . . . . . . . . 75 |
163 |
|
6.6.6. Getting global volume attenuation . . . . . . . . . . 76 |
164 |
|
|
165 |
|
|
166 |
|
|
167 |
Schoenebeck Expires August 17, 2008 [Page 3] |
Schoenebeck Expires May 5, 2010 [Page 3] |
168 |
|
|
169 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
170 |
|
|
171 |
|
|
172 |
6.5.4. Close client connection . . . . . . . . . . . . . . . 73 |
6.6.7. Setting global volume attenuation . . . . . . . . . . 76 |
173 |
6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 73 |
6.6.8. Getting global voice limit . . . . . . . . . . . . . 77 |
174 |
6.6.1. Current number of active voices . . . . . . . . . . . 73 |
6.6.9. Setting global voice limit . . . . . . . . . . . . . 77 |
175 |
6.6.2. Maximum amount of active voices . . . . . . . . . . . 73 |
6.6.10. Getting global disk stream limit . . . . . . . . . . 78 |
176 |
6.6.3. Current number of active disk streams . . . . . . . . 74 |
6.6.11. Setting global disk stream limit . . . . . . . . . . 79 |
177 |
6.6.4. Reset sampler . . . . . . . . . . . . . . . . . . . . 74 |
6.7. MIDI Instrument Mapping . . . . . . . . . . . . . . . . . 79 |
178 |
6.6.5. General sampler informations . . . . . . . . . . . . 74 |
6.7.1. Create a new MIDI instrument map . . . . . . . . . . 80 |
179 |
6.6.6. Getting global volume attenuation . . . . . . . . . . 75 |
6.7.2. Delete one particular or all MIDI instrument maps . . 81 |
180 |
6.6.7. Setting global volume attenuation . . . . . . . . . . 75 |
6.7.3. Get amount of existing MIDI instrument maps . . . . . 82 |
181 |
6.7. MIDI Instrument Mapping . . . . . . . . . . . . . . . . . 76 |
6.7.4. Getting all created MIDI instrument maps . . . . . . 82 |
182 |
6.7.1. Create a new MIDI instrument map . . . . . . . . . . 77 |
6.7.5. Getting MIDI instrument map information . . . . . . . 82 |
183 |
6.7.2. Delete one particular or all MIDI instrument maps . . 77 |
6.7.6. Renaming a MIDI instrument map . . . . . . . . . . . 83 |
184 |
6.7.3. Get amount of existing MIDI instrument maps . . . . . 78 |
6.7.7. Create or replace a MIDI instrument map entry . . . . 84 |
185 |
6.7.4. Getting all created MIDI instrument maps . . . . . . 78 |
6.7.8. Getting ammount of MIDI instrument map entries . . . 87 |
|
6.7.5. Getting MIDI instrument map information . . . . . . . 79 |
|
|
6.7.6. Renaming a MIDI instrument map . . . . . . . . . . . 80 |
|
|
6.7.7. Create or replace a MIDI instrument map entry . . . . 80 |
|
|
6.7.8. Getting ammount of MIDI instrument map entries . . . 83 |
|
186 |
6.7.9. Getting indeces of all entries of a MIDI |
6.7.9. Getting indeces of all entries of a MIDI |
187 |
instrument map . . . . . . . . . . . . . . . . . . . 84 |
instrument map . . . . . . . . . . . . . . . . . . . 87 |
188 |
6.7.10. Remove an entry from the MIDI instrument map . . . . 84 |
6.7.10. Remove an entry from the MIDI instrument map . . . . 88 |
189 |
6.7.11. Get current settings of MIDI instrument map entry . . 85 |
6.7.11. Get current settings of MIDI instrument map entry . . 89 |
190 |
6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . . 87 |
6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . . 90 |
191 |
6.8. Managing Instruments Database . . . . . . . . . . . . . . 88 |
6.8. Managing Instruments Database . . . . . . . . . . . . . . 91 |
192 |
6.8.1. Creating a new instrument directory . . . . . . . . . 88 |
6.8.1. Creating a new instrument directory . . . . . . . . . 91 |
193 |
6.8.2. Deleting an instrument directory . . . . . . . . . . 88 |
6.8.2. Deleting an instrument directory . . . . . . . . . . 92 |
194 |
6.8.3. Getting amount of instrument directories . . . . . . 89 |
6.8.3. Getting amount of instrument directories . . . . . . 93 |
195 |
6.8.4. Listing all directories in specific directory . . . . 90 |
6.8.4. Listing all directories in specific directory . . . . 93 |
196 |
6.8.5. Getting instrument directory information . . . . . . 90 |
6.8.5. Getting instrument directory information . . . . . . 94 |
197 |
6.8.6. Renaming an instrument directory . . . . . . . . . . 91 |
6.8.6. Renaming an instrument directory . . . . . . . . . . 95 |
198 |
6.8.7. Moving an instrument directory . . . . . . . . . . . 92 |
6.8.7. Moving an instrument directory . . . . . . . . . . . 95 |
199 |
6.8.8. Copying instrument directories . . . . . . . . . . . 93 |
6.8.8. Copying instrument directories . . . . . . . . . . . 96 |
200 |
6.8.9. Changing the description of directory . . . . . . . . 93 |
6.8.9. Changing the description of directory . . . . . . . . 97 |
201 |
6.8.10. Finding directories . . . . . . . . . . . . . . . . . 94 |
6.8.10. Finding directories . . . . . . . . . . . . . . . . . 97 |
202 |
6.8.11. Adding instruments to the instruments database . . . 95 |
6.8.11. Adding instruments to the instruments database . . . 99 |
203 |
6.8.12. Removing an instrument . . . . . . . . . . . . . . . 97 |
6.8.12. Removing an instrument . . . . . . . . . . . . . . . 100 |
204 |
6.8.13. Getting amount of instruments . . . . . . . . . . . . 97 |
6.8.13. Getting amount of instruments . . . . . . . . . . . . 101 |
205 |
6.8.14. Listing all instruments in specific directory . . . . 98 |
6.8.14. Listing all instruments in specific directory . . . . 102 |
206 |
6.8.15. Getting instrument information . . . . . . . . . . . 99 |
6.8.15. Getting instrument information . . . . . . . . . . . 102 |
207 |
6.8.16. Renaming an instrument . . . . . . . . . . . . . . . 101 |
6.8.16. Renaming an instrument . . . . . . . . . . . . . . . 105 |
208 |
6.8.17. Moving an instrument . . . . . . . . . . . . . . . . 102 |
6.8.17. Moving an instrument . . . . . . . . . . . . . . . . 105 |
209 |
6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102 |
6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 106 |
210 |
6.8.19. Changing the description of instrument . . . . . . . 103 |
6.8.19. Changing the description of instrument . . . . . . . 106 |
211 |
6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103 |
6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 107 |
212 |
6.8.21. Getting job status information . . . . . . . . . . . 106 |
6.8.21. Getting job status information . . . . . . . . . . . 109 |
213 |
6.8.22. Formatting the instruments database . . . . . . . . . 107 |
6.8.22. Formatting the instruments database . . . . . . . . . 111 |
214 |
6.9. Editing Instruments . . . . . . . . . . . . . . . . . . . 107 |
6.8.23. Checking for lost instrument files . . . . . . . . . 111 |
215 |
|
6.8.24. Replacing an instrument file . . . . . . . . . . . . 112 |
216 |
|
6.9. Editing Instruments . . . . . . . . . . . . . . . . . . . 112 |
217 |
6.9.1. Opening an appropriate instrument editor |
6.9.1. Opening an appropriate instrument editor |
218 |
|
application . . . . . . . . . . . . . . . . . . . . . 112 |
219 |
|
6.10. Managing Files . . . . . . . . . . . . . . . . . . . . . 113 |
220 |
|
|
221 |
|
|
222 |
|
|
223 |
Schoenebeck Expires August 17, 2008 [Page 4] |
Schoenebeck Expires May 5, 2010 [Page 4] |
224 |
|
|
225 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
226 |
|
|
227 |
|
|
228 |
application . . . . . . . . . . . . . . . . . . . . . 107 |
6.10.1. Retrieving amount of instruments of a file . . . . . 114 |
229 |
6.10. Managing Files . . . . . . . . . . . . . . . . . . . . . 108 |
6.10.2. Retrieving all instruments of a file . . . . . . . . 114 |
|
6.10.1. Retrieving amount of instruments of a file . . . . . 109 |
|
|
6.10.2. Retrieving all instruments of a file . . . . . . . . 109 |
|
230 |
6.10.3. Retrieving informations about one instrument in a |
6.10.3. Retrieving informations about one instrument in a |
231 |
file . . . . . . . . . . . . . . . . . . . . . . . . 110 |
file . . . . . . . . . . . . . . . . . . . . . . . . 115 |
232 |
7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . 112 |
7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . 117 |
233 |
7.1. Character Set and Escape Sequences . . . . . . . . . . . 126 |
7.1. Character Set and Escape Sequences . . . . . . . . . . . 131 |
234 |
8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 |
8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 |
235 |
8.1. Number of audio output devices changed . . . . . . . . . 130 |
8.1. Number of audio output devices changed . . . . . . . . . 136 |
236 |
8.2. Audio output device's settings changed . . . . . . . . . 130 |
8.2. Audio output device's settings changed . . . . . . . . . 136 |
237 |
8.3. Number of MIDI input devices changed . . . . . . . . . . 130 |
8.3. Number of MIDI input devices changed . . . . . . . . . . 136 |
238 |
8.4. MIDI input device's settings changed . . . . . . . . . . 131 |
8.4. MIDI input device's settings changed . . . . . . . . . . 137 |
239 |
8.5. Number of sampler channels changed . . . . . . . . . . . 131 |
8.5. Number of sampler channels changed . . . . . . . . . . . 137 |
240 |
8.6. MIDI data on a sampler channel arrived . . . . . . . . . 131 |
8.6. MIDI data on a sampler channel arrived . . . . . . . . . 137 |
241 |
8.7. Number of active voices changed . . . . . . . . . . . . . 132 |
8.7. MIDI data on a MIDI input device arrived . . . . . . . . 138 |
242 |
8.8. Number of active disk streams changed . . . . . . . . . . 132 |
8.8. Number of active voices changed . . . . . . . . . . . . . 138 |
243 |
8.9. Disk stream buffer fill state changed . . . . . . . . . . 133 |
8.9. Number of active disk streams changed . . . . . . . . . . 139 |
244 |
8.10. Channel information changed . . . . . . . . . . . . . . . 133 |
8.10. Disk stream buffer fill state changed . . . . . . . . . . 139 |
245 |
8.11. Number of effect sends changed . . . . . . . . . . . . . 133 |
8.11. Channel information changed . . . . . . . . . . . . . . . 139 |
246 |
8.12. Effect send information changed . . . . . . . . . . . . . 134 |
8.12. Number of effect sends changed . . . . . . . . . . . . . 140 |
247 |
8.13. Total number of active voices changed . . . . . . . . . . 134 |
8.13. Effect send information changed . . . . . . . . . . . . . 140 |
248 |
8.14. Total number of active disk streams changed . . . . . . . 134 |
8.14. Total number of active voices changed . . . . . . . . . . 141 |
249 |
8.15. Number of MIDI instrument maps changed . . . . . . . . . 135 |
8.15. Total number of active disk streams changed . . . . . . . 141 |
250 |
8.16. MIDI instrument map information changed . . . . . . . . . 135 |
8.16. Number of MIDI instrument maps changed . . . . . . . . . 141 |
251 |
8.17. Number of MIDI instruments changed . . . . . . . . . . . 135 |
8.17. MIDI instrument map information changed . . . . . . . . . 141 |
252 |
8.18. MIDI instrument information changed . . . . . . . . . . . 136 |
8.18. Number of MIDI instruments changed . . . . . . . . . . . 142 |
253 |
8.19. Global settings changed . . . . . . . . . . . . . . . . . 136 |
8.19. MIDI instrument information changed . . . . . . . . . . . 142 |
254 |
8.20. Number of database instrument directories changed . . . . 136 |
8.20. Global settings changed . . . . . . . . . . . . . . . . . 143 |
255 |
8.21. Database instrument directory information changed . . . . 137 |
8.21. Number of database instrument directories changed . . . . 143 |
256 |
8.22. Number of database instruments changed . . . . . . . . . 137 |
8.22. Database instrument directory information changed . . . . 143 |
257 |
8.23. Database instrument information changed . . . . . . . . . 138 |
8.23. Number of database instruments changed . . . . . . . . . 144 |
258 |
8.24. Database job status information changed . . . . . . . . . 138 |
8.24. Database instrument information changed . . . . . . . . . 144 |
259 |
8.25. Miscellaneous and debugging events . . . . . . . . . . . 139 |
8.25. Database job status information changed . . . . . . . . . 145 |
260 |
9. Security Considerations . . . . . . . . . . . . . . . . . . . 140 |
8.26. Miscellaneous and debugging events . . . . . . . . . . . 145 |
261 |
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 141 |
9. Security Considerations . . . . . . . . . . . . . . . . . . . 147 |
262 |
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 142 |
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 148 |
263 |
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 143 |
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 149 |
264 |
Intellectual Property and Copyright Statements . . . . . . . . . 144 |
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 150 |
265 |
|
Intellectual Property and Copyright Statements . . . . . . . . . 151 |
266 |
|
|
267 |
|
|
268 |
|
|
269 |
|
|
276 |
|
|
277 |
|
|
278 |
|
|
279 |
Schoenebeck Expires August 17, 2008 [Page 5] |
Schoenebeck Expires May 5, 2010 [Page 5] |
280 |
|
|
281 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
282 |
|
|
283 |
|
|
284 |
1. Requirements notation |
1. Requirements notation |
332 |
|
|
333 |
|
|
334 |
|
|
335 |
Schoenebeck Expires August 17, 2008 [Page 6] |
Schoenebeck Expires May 5, 2010 [Page 6] |
336 |
|
|
337 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
338 |
|
|
339 |
|
|
340 |
2. Versioning of this specification |
2. Versioning of this specification |
388 |
|
|
389 |
|
|
390 |
|
|
391 |
Schoenebeck Expires August 17, 2008 [Page 7] |
Schoenebeck Expires May 5, 2010 [Page 7] |
392 |
|
|
393 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
394 |
|
|
395 |
|
|
396 |
3. Introduction |
3. Introduction |
444 |
|
|
445 |
|
|
446 |
|
|
447 |
Schoenebeck Expires August 17, 2008 [Page 8] |
Schoenebeck Expires May 5, 2010 [Page 8] |
448 |
|
|
449 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
450 |
|
|
451 |
|
|
452 |
4. Focus of this protocol |
4. Focus of this protocol |
500 |
|
|
501 |
|
|
502 |
|
|
503 |
Schoenebeck Expires August 17, 2008 [Page 9] |
Schoenebeck Expires May 5, 2010 [Page 9] |
504 |
|
|
505 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
506 |
|
|
507 |
|
|
508 |
5. Communication Overview |
5. Communication Overview |
556 |
|
|
557 |
|
|
558 |
|
|
559 |
Schoenebeck Expires August 17, 2008 [Page 10] |
Schoenebeck Expires May 5, 2010 [Page 10] |
560 |
|
|
561 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
562 |
|
|
563 |
|
|
564 |
5.1.1. Result format |
5.1.1. Result format |
612 |
|
|
613 |
|
|
614 |
|
|
615 |
Schoenebeck Expires August 17, 2008 [Page 11] |
Schoenebeck Expires May 5, 2010 [Page 11] |
616 |
|
|
617 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
618 |
|
|
619 |
|
|
620 |
set has the following format: |
set has the following format: |
668 |
|
|
669 |
|
|
670 |
|
|
671 |
Schoenebeck Expires August 17, 2008 [Page 12] |
Schoenebeck Expires May 5, 2010 [Page 12] |
672 |
|
|
673 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
674 |
|
|
675 |
|
|
676 |
Each line of the result set MUST end with <CRLF>. |
Each line of the result set MUST end with <CRLF>. |
724 |
|
|
725 |
|
|
726 |
|
|
727 |
Schoenebeck Expires August 17, 2008 [Page 13] |
Schoenebeck Expires May 5, 2010 [Page 13] |
728 |
|
|
729 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
730 |
|
|
731 |
|
|
732 |
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 |
780 |
|
|
781 |
|
|
782 |
|
|
783 |
Schoenebeck Expires August 17, 2008 [Page 14] |
Schoenebeck Expires May 5, 2010 [Page 14] |
784 |
|
|
785 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
786 |
|
|
787 |
|
|
788 |
6. Description for control commands |
6. Description for control commands |
836 |
|
|
837 |
|
|
838 |
|
|
839 |
Schoenebeck Expires August 17, 2008 [Page 15] |
Schoenebeck Expires May 5, 2010 [Page 15] |
840 |
|
|
841 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
842 |
|
|
843 |
|
|
844 |
6.2.1. Getting amount of available audio output drivers |
6.2.1. Getting amount of available audio output drivers |
892 |
|
|
893 |
|
|
894 |
|
|
895 |
Schoenebeck Expires August 17, 2008 [Page 16] |
Schoenebeck Expires May 5, 2010 [Page 16] |
896 |
|
|
897 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
898 |
|
|
899 |
|
|
900 |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
948 |
|
|
949 |
|
|
950 |
|
|
951 |
Schoenebeck Expires August 17, 2008 [Page 17] |
Schoenebeck Expires May 5, 2010 [Page 17] |
952 |
|
|
953 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
954 |
|
|
955 |
|
|
956 |
obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" |
obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" |
1004 |
|
|
1005 |
|
|
1006 |
|
|
1007 |
Schoenebeck Expires August 17, 2008 [Page 18] |
Schoenebeck Expires May 5, 2010 [Page 18] |
1008 |
|
|
1009 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1010 |
|
|
1011 |
|
|
1012 |
MULTIPLICITY - |
MULTIPLICITY - |
1060 |
|
|
1061 |
|
|
1062 |
|
|
1063 |
Schoenebeck Expires August 17, 2008 [Page 19] |
Schoenebeck Expires May 5, 2010 [Page 19] |
1064 |
|
|
1065 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1066 |
|
|
1067 |
|
|
1068 |
returned, dependent to driver parameter) |
returned, dependent to driver parameter) |
1116 |
|
|
1117 |
|
|
1118 |
|
|
1119 |
Schoenebeck Expires August 17, 2008 [Page 20] |
Schoenebeck Expires May 5, 2010 [Page 20] |
1120 |
|
|
1121 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1122 |
|
|
1123 |
|
|
1124 |
"TYPE: INT" |
"TYPE: INT" |
1172 |
|
|
1173 |
|
|
1174 |
|
|
1175 |
Schoenebeck Expires August 17, 2008 [Page 21] |
Schoenebeck Expires May 5, 2010 [Page 21] |
1176 |
|
|
1177 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1178 |
|
|
1179 |
|
|
1180 |
providing an appropriate warning code and warning message |
providing an appropriate warning code and warning message |
1228 |
|
|
1229 |
|
|
1230 |
|
|
1231 |
Schoenebeck Expires August 17, 2008 [Page 22] |
Schoenebeck Expires May 5, 2010 [Page 22] |
1232 |
|
|
1233 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1234 |
|
|
1235 |
|
|
1236 |
C: "DESTROY AUDIO_OUTPUT_DEVICE 0" |
C: "DESTROY AUDIO_OUTPUT_DEVICE 0" |
1284 |
|
|
1285 |
|
|
1286 |
|
|
1287 |
Schoenebeck Expires August 17, 2008 [Page 23] |
Schoenebeck Expires May 5, 2010 [Page 23] |
1288 |
|
|
1289 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1290 |
|
|
1291 |
|
|
1292 |
Possible Answers: |
Possible Answers: |
1340 |
|
|
1341 |
|
|
1342 |
|
|
1343 |
Schoenebeck Expires August 17, 2008 [Page 24] |
Schoenebeck Expires May 5, 2010 [Page 24] |
1344 |
|
|
1345 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1346 |
|
|
1347 |
|
|
1348 |
"FRAGMENTS: 2" |
"FRAGMENTS: 2" |
1396 |
|
|
1397 |
|
|
1398 |
|
|
1399 |
Schoenebeck Expires August 17, 2008 [Page 25] |
Schoenebeck Expires May 5, 2010 [Page 25] |
1400 |
|
|
1401 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1402 |
|
|
1403 |
|
|
1404 |
6.2.11. Getting information about an audio channel |
6.2.11. Getting information about an audio channel |
1452 |
|
|
1453 |
|
|
1454 |
|
|
1455 |
Schoenebeck Expires August 17, 2008 [Page 26] |
Schoenebeck Expires May 5, 2010 [Page 26] |
1456 |
|
|
1457 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1458 |
|
|
1459 |
|
|
1460 |
Examples: |
Examples: |
1508 |
|
|
1509 |
|
|
1510 |
|
|
1511 |
Schoenebeck Expires August 17, 2008 [Page 27] |
Schoenebeck Expires May 5, 2010 [Page 27] |
1512 |
|
|
1513 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1514 |
|
|
1515 |
|
|
1516 |
channel number and <param> a specific channel parameter name for |
channel number and <param> a specific channel parameter name for |
1564 |
|
|
1565 |
|
|
1566 |
|
|
1567 |
Schoenebeck Expires August 17, 2008 [Page 28] |
Schoenebeck Expires May 5, 2010 [Page 28] |
1568 |
|
|
1569 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1570 |
|
|
1571 |
|
|
1572 |
RANGE_MAX - |
RANGE_MAX - |
1620 |
|
|
1621 |
|
|
1622 |
|
|
1623 |
Schoenebeck Expires August 17, 2008 [Page 29] |
Schoenebeck Expires May 5, 2010 [Page 29] |
1624 |
|
|
1625 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1626 |
|
|
1627 |
|
|
1628 |
"OK" - |
"OK" - |
1676 |
|
|
1677 |
|
|
1678 |
|
|
1679 |
Schoenebeck Expires August 17, 2008 [Page 30] |
Schoenebeck Expires May 5, 2010 [Page 30] |
1680 |
|
|
1681 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1682 |
|
|
1683 |
|
|
1684 |
Note: examples in this chapter showing particular parameters of |
Note: examples in this chapter showing particular parameters of |
1732 |
|
|
1733 |
|
|
1734 |
|
|
1735 |
Schoenebeck Expires August 17, 2008 [Page 31] |
Schoenebeck Expires May 5, 2010 [Page 31] |
1736 |
|
|
1737 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1738 |
|
|
1739 |
|
|
1740 |
6.3.3. Getting information about a specific MIDI input driver |
6.3.3. Getting information about a specific MIDI input driver |
1788 |
|
|
1789 |
|
|
1790 |
|
|
1791 |
Schoenebeck Expires August 17, 2008 [Page 32] |
Schoenebeck Expires May 5, 2010 [Page 32] |
1792 |
|
|
1793 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1794 |
|
|
1795 |
|
|
1796 |
6.3.4. Getting information about specific MIDI input driver parameter |
6.3.4. Getting information about specific MIDI input driver parameter |
1844 |
|
|
1845 |
|
|
1846 |
|
|
1847 |
Schoenebeck Expires August 17, 2008 [Page 33] |
Schoenebeck Expires May 5, 2010 [Page 33] |
1848 |
|
|
1849 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1850 |
|
|
1851 |
|
|
1852 |
FIX - |
FIX - |
1900 |
|
|
1901 |
|
|
1902 |
|
|
1903 |
Schoenebeck Expires August 17, 2008 [Page 34] |
Schoenebeck Expires May 5, 2010 [Page 34] |
1904 |
|
|
1905 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1906 |
|
|
1907 |
|
|
1908 |
may also appear without (optionally returned, dependent to |
may also appear without (optionally returned, dependent to |
1956 |
|
|
1957 |
|
|
1958 |
|
|
1959 |
Schoenebeck Expires August 17, 2008 [Page 35] |
Schoenebeck Expires May 5, 2010 [Page 35] |
1960 |
|
|
1961 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
1962 |
|
|
1963 |
|
|
1964 |
"OK[<device-id>]" - |
"OK[<device-id>]" - |
2012 |
|
|
2013 |
|
|
2014 |
|
|
2015 |
Schoenebeck Expires August 17, 2008 [Page 36] |
Schoenebeck Expires May 5, 2010 [Page 36] |
2016 |
|
|
2017 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2018 |
|
|
2019 |
|
|
2020 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
2068 |
|
|
2069 |
|
|
2070 |
|
|
2071 |
Schoenebeck Expires August 17, 2008 [Page 37] |
Schoenebeck Expires May 5, 2010 [Page 37] |
2072 |
|
|
2073 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2074 |
|
|
2075 |
|
|
2076 |
6.3.9. Getting current settings of a MIDI input device |
6.3.9. Getting current settings of a MIDI input device |
2124 |
|
|
2125 |
|
|
2126 |
|
|
2127 |
Schoenebeck Expires August 17, 2008 [Page 38] |
Schoenebeck Expires May 5, 2010 [Page 38] |
2128 |
|
|
2129 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2130 |
|
|
2131 |
|
|
2132 |
"ACTIVE: true" |
"ACTIVE: true" |
2180 |
|
|
2181 |
|
|
2182 |
|
|
2183 |
Schoenebeck Expires August 17, 2008 [Page 39] |
Schoenebeck Expires May 5, 2010 [Page 39] |
2184 |
|
|
2185 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2186 |
|
|
2187 |
|
|
2188 |
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 |
2236 |
|
|
2237 |
|
|
2238 |
|
|
2239 |
Schoenebeck Expires August 17, 2008 [Page 40] |
Schoenebeck Expires May 5, 2010 [Page 40] |
2240 |
|
|
2241 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2242 |
|
|
2243 |
|
|
2244 |
character string to that info category. There is information |
character string to that info category. There is information |
2292 |
|
|
2293 |
|
|
2294 |
|
|
2295 |
Schoenebeck Expires August 17, 2008 [Page 41] |
Schoenebeck Expires May 5, 2010 [Page 41] |
2296 |
|
|
2297 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2298 |
|
|
2299 |
|
|
2300 |
returned, dependent to device and port parameter) |
returned, dependent to device and port parameter) |
2348 |
|
|
2349 |
|
|
2350 |
|
|
2351 |
Schoenebeck Expires August 17, 2008 [Page 42] |
Schoenebeck Expires May 5, 2010 [Page 42] |
2352 |
|
|
2353 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2354 |
|
|
2355 |
|
|
2356 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
2404 |
|
|
2405 |
|
|
2406 |
|
|
2407 |
Schoenebeck Expires August 17, 2008 [Page 43] |
Schoenebeck Expires May 5, 2010 [Page 43] |
2408 |
|
|
2409 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2410 |
|
|
2411 |
|
|
2412 |
format and SHOULD return ERR and SHOULD not launch the background |
format and SHOULD return ERR and SHOULD not launch the background |
2460 |
|
|
2461 |
|
|
2462 |
|
|
2463 |
Schoenebeck Expires August 17, 2008 [Page 44] |
Schoenebeck Expires May 5, 2010 [Page 44] |
2464 |
|
|
2465 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2466 |
|
|
2467 |
|
|
2468 |
sampler channel. This command has (currently) no way to define or |
sampler channel. This command has (currently) no way to define or |
2516 |
|
|
2517 |
|
|
2518 |
|
|
2519 |
Schoenebeck Expires August 17, 2008 [Page 45] |
Schoenebeck Expires May 5, 2010 [Page 45] |
2520 |
|
|
2521 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2522 |
|
|
2523 |
|
|
2524 |
6.4.4. Getting all created sampler channel list |
6.4.4. Getting all created sampler channel list |
2572 |
|
|
2573 |
|
|
2574 |
|
|
2575 |
Schoenebeck Expires August 17, 2008 [Page 46] |
Schoenebeck Expires May 5, 2010 [Page 46] |
2576 |
|
|
2577 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2578 |
|
|
2579 |
|
|
2580 |
in case a new channel was added successfully, but there are |
in case a new channel was added successfully, but there are |
2628 |
|
|
2629 |
|
|
2630 |
|
|
2631 |
Schoenebeck Expires August 17, 2008 [Page 47] |
Schoenebeck Expires May 5, 2010 [Page 47] |
2632 |
|
|
2633 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2634 |
|
|
2635 |
|
|
2636 |
6.4.7. Getting amount of available engines |
6.4.7. Getting amount of available engines |
2684 |
|
|
2685 |
|
|
2686 |
|
|
2687 |
Schoenebeck Expires August 17, 2008 [Page 48] |
Schoenebeck Expires May 5, 2010 [Page 48] |
2688 |
|
|
2689 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2690 |
|
|
2691 |
|
|
2692 |
Possible Answers: |
Possible Answers: |
2740 |
|
|
2741 |
|
|
2742 |
|
|
2743 |
Schoenebeck Expires August 17, 2008 [Page 49] |
Schoenebeck Expires May 5, 2010 [Page 49] |
2744 |
|
|
2745 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2746 |
|
|
2747 |
|
|
2748 |
following categories are defined: |
following categories are defined: |
2759 |
|
|
2760 |
numerical ID of the audio output device which is currently |
numerical ID of the audio output device which is currently |
2761 |
connected to this sampler channel to output the audio |
connected to this sampler channel to output the audio |
2762 |
signal, "NONE" if there's no device connected to this |
signal, "-1" if there's no device connected to this sampler |
2763 |
sampler channel |
channel |
2764 |
|
|
2765 |
AUDIO_OUTPUT_CHANNELS - |
AUDIO_OUTPUT_CHANNELS - |
2766 |
|
|
2785 |
|
|
2786 |
INSTRUMENT_NR - |
INSTRUMENT_NR - |
2787 |
|
|
2788 |
the instrument index number of the loaded instrument |
the instrument index number of the loaded instrument, "-1" |
2789 |
|
if there's no instrument loaded for this sampler channel |
2790 |
|
|
2791 |
INSTRUMENT_NAME - |
INSTRUMENT_NAME - |
2792 |
|
|
2796 |
|
|
2797 |
|
|
2798 |
|
|
2799 |
|
Schoenebeck Expires May 5, 2010 [Page 50] |
|
Schoenebeck Expires August 17, 2008 [Page 50] |
|
2800 |
|
|
2801 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2802 |
|
|
2803 |
|
|
2804 |
INSTRUMENT_STATUS - |
INSTRUMENT_STATUS - |
2805 |
|
|
2806 |
integer values 0 to 100 indicating loading progress |
Integer values 0 to 100 indicating loading progress |
2807 |
percentage for the instrument. Negative value indicates a |
percentage for the instrument. Negative value indicates a |
2808 |
loading exception. Value of 100 indicates that the |
loading exception (also returns "-1" in case no instrument |
2809 |
instrument is fully loaded. |
was yet to be loaded on the sampler channel). Value of 100 |
2810 |
|
indicates that the instrument is fully loaded. |
2811 |
|
|
2812 |
MIDI_INPUT_DEVICE - |
MIDI_INPUT_DEVICE - |
2813 |
|
|
2814 |
numerical ID of the MIDI input device which is currently |
numerical ID of the MIDI input device which is currently |
2815 |
connected to this sampler channel to deliver MIDI input |
connected to this sampler channel to deliver MIDI input |
2816 |
commands, "NONE" if there's no device connected to this |
commands, "-1" if there's no device connected to this |
2817 |
sampler channel |
sampler channel |
2818 |
|
|
2819 |
MIDI_INPUT_PORT - |
MIDI_INPUT_PORT - |
2820 |
|
|
2821 |
port number of the MIDI input device |
port number of the MIDI input device (in case a MIDI device |
2822 |
|
was already assigned to the sampler channel) |
2823 |
|
|
2824 |
MIDI_INPUT_CHANNEL - |
MIDI_INPUT_CHANNEL - |
2825 |
|
|
2849 |
|
|
2850 |
Determines to which MIDI instrument map this sampler channel |
Determines to which MIDI instrument map this sampler channel |
2851 |
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. |
|
2852 |
|
|
2853 |
|
|
2854 |
|
|
2855 |
Schoenebeck Expires August 17, 2008 [Page 51] |
Schoenebeck Expires May 5, 2010 [Page 51] |
2856 |
|
|
2857 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2858 |
|
|
2859 |
|
|
2860 |
|
MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible |
2861 |
|
values. |
2862 |
|
|
2863 |
The mentioned fields above don't have to be in particular order. |
The mentioned fields above don't have to be in particular order. |
2864 |
|
|
2905 |
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 |
2906 |
sampler channel by sending the following command: |
sampler channel by sending the following command: |
2907 |
|
|
|
GET CHANNEL VOICE_COUNT <sampler-channel> |
|
|
|
|
|
Where <sampler-channel> is the sampler channel number the front-end |
|
2908 |
|
|
2909 |
|
|
2910 |
|
|
2911 |
Schoenebeck Expires August 17, 2008 [Page 52] |
Schoenebeck Expires May 5, 2010 [Page 52] |
2912 |
|
|
2913 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2914 |
|
|
2915 |
|
|
2916 |
|
GET CHANNEL VOICE_COUNT <sampler-channel> |
2917 |
|
|
2918 |
|
Where <sampler-channel> is the sampler channel number the front-end |
2919 |
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 |
2920 |
"LIST CHANNELS" (Section 6.4.4) command. |
"LIST CHANNELS" (Section 6.4.4) command. |
2921 |
|
|
2959 |
|
|
2960 |
to get the fill state in bytes or |
to get the fill state in bytes or |
2961 |
|
|
|
GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel> |
|
2962 |
|
|
|
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) |
|
2963 |
|
|
2964 |
|
|
2965 |
|
|
2966 |
Schoenebeck Expires August 17, 2008 [Page 53] |
|
2967 |
|
Schoenebeck Expires May 5, 2010 [Page 53] |
2968 |
|
|
2969 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
2970 |
|
|
2971 |
|
|
2972 |
|
GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel> |
2973 |
|
|
2974 |
|
to get the fill state in percent, where <sampler-channel> is the |
2975 |
|
sampler channel number the front-end is interested in as returned by |
2976 |
|
the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
2977 |
command. |
command. |
2978 |
|
|
2979 |
Possible Answers: |
Possible Answers: |
3018 |
(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) |
3019 |
command. |
command. |
3020 |
|
|
|
Possible Answers: |
|
|
|
|
3021 |
|
|
3022 |
|
|
3023 |
|
Schoenebeck Expires May 5, 2010 [Page 54] |
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 54] |
|
3024 |
|
|
3025 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3026 |
|
|
3027 |
|
|
3028 |
|
Possible Answers: |
3029 |
|
|
3030 |
"OK" - |
"OK" - |
3031 |
|
|
3032 |
on success |
on success |
3071 |
related, providing an appropriate warning code and warning |
related, providing an appropriate warning code and warning |
3072 |
message |
message |
3073 |
|
|
|
"ERR:<error-code>:<error-message>" - |
|
3074 |
|
|
|
in case it failed, providing an appropriate error code and |
|
|
error message |
|
3075 |
|
|
3076 |
|
|
3077 |
|
|
3078 |
Schoenebeck Expires August 17, 2008 [Page 55] |
|
3079 |
|
Schoenebeck Expires May 5, 2010 [Page 55] |
3080 |
|
|
3081 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3082 |
|
|
3083 |
|
|
3084 |
|
"ERR:<error-code>:<error-message>" - |
3085 |
|
|
3086 |
|
in case it failed, providing an appropriate error code and |
3087 |
|
error message |
3088 |
|
|
3089 |
Examples: |
Examples: |
3090 |
|
|
3091 |
|
|
3126 |
|
|
3127 |
|
|
3128 |
|
|
|
6.4.17. Setting MIDI input device |
|
3129 |
|
|
|
The front-end can set the MIDI input device on a specific sampler |
|
|
channel by sending the following command: |
|
3130 |
|
|
|
SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id> |
|
3131 |
|
|
|
Where <sampler-channel> is the sampler channel number as returned by |
|
3132 |
|
|
3133 |
|
|
3134 |
|
|
3135 |
Schoenebeck Expires August 17, 2008 [Page 56] |
Schoenebeck Expires May 5, 2010 [Page 56] |
3136 |
|
|
3137 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3138 |
|
|
3139 |
|
|
3140 |
|
6.4.17. Setting MIDI input device |
3141 |
|
|
3142 |
|
The front-end can set the MIDI input device on a specific sampler |
3143 |
|
channel by sending the following command: |
3144 |
|
|
3145 |
|
SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id> |
3146 |
|
|
3147 |
|
Where <sampler-channel> is the sampler channel number as returned by |
3148 |
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) |
3149 |
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 |
3150 |
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) |
3185 |
|
|
3186 |
Possible Answers: |
Possible Answers: |
3187 |
|
|
|
"OK" - |
|
3188 |
|
|
|
on success |
|
3189 |
|
|
|
"WRN:<warning-code>:<warning-message>" - |
|
3190 |
|
|
3191 |
if MIDI input type was set, but there are noteworthy issue(s) |
Schoenebeck Expires May 5, 2010 [Page 57] |
3192 |
related, providing an appropriate warning code and warning |
|
3193 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
3194 |
|
|
3195 |
|
|
3196 |
|
"OK" - |
3197 |
|
|
3198 |
Schoenebeck Expires August 17, 2008 [Page 57] |
on success |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
3199 |
|
|
3200 |
|
"WRN:<warning-code>:<warning-message>" - |
3201 |
|
|
3202 |
|
if MIDI input type was set, but there are noteworthy issue(s) |
3203 |
|
related, providing an appropriate warning code and warning |
3204 |
message |
message |
3205 |
|
|
3206 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
3243 |
|
|
3244 |
|
|
3245 |
|
|
|
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: |
|
3246 |
|
|
3247 |
|
Schoenebeck Expires May 5, 2010 [Page 58] |
3248 |
|
|
3249 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
3250 |
|
|
3251 |
|
|
3252 |
|
|
3253 |
|
|
3254 |
Schoenebeck Expires August 17, 2008 [Page 58] |
6.4.20. Setting MIDI input channel |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
3255 |
|
|
3256 |
|
The front-end can alter the MIDI channel a sampler channel should |
3257 |
|
listen to by sending the following command: |
3258 |
|
|
3259 |
SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan> |
SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan> |
3260 |
|
|
3297 |
|
|
3298 |
Possible Answers: |
Possible Answers: |
3299 |
|
|
|
"OK" - |
|
3300 |
|
|
|
on success |
|
|
|
|
|
"WRN:<warning-code>:<warning-message>" - |
|
3301 |
|
|
3302 |
|
|
3303 |
|
Schoenebeck Expires May 5, 2010 [Page 59] |
3304 |
|
|
3305 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
3306 |
|
|
3307 |
|
|
3308 |
|
"OK" - |
3309 |
|
|
3310 |
Schoenebeck Expires August 17, 2008 [Page 59] |
on success |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
3311 |
|
|
3312 |
|
"WRN:<warning-code>:<warning-message>" - |
3313 |
|
|
3314 |
if channel volume was set, but there are noteworthy issue(s) |
if channel volume was set, but there are noteworthy issue(s) |
3315 |
related, providing an appropriate warning code and warning |
related, providing an appropriate warning code and warning |
3353 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3354 |
error message |
error message |
3355 |
|
|
|
Examples: |
|
|
|
|
|
|
|
3356 |
|
|
3357 |
|
|
3358 |
|
|
3359 |
|
Schoenebeck Expires May 5, 2010 [Page 60] |
3360 |
|
|
3361 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
3362 |
|
|
3363 |
|
|
3364 |
|
Examples: |
3365 |
|
|
|
Schoenebeck Expires August 17, 2008 [Page 60] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
3366 |
|
|
3367 |
|
|
3368 |
6.4.23. Soloing a sampler channel |
6.4.23. Soloing a sampler channel |
3410 |
(Section 6.4.4) command and <map> can have the following |
(Section 6.4.4) command and <map> can have the following |
3411 |
possibilites: |
possibilites: |
3412 |
|
|
|
"NONE" - |
|
|
|
|
|
|
|
|
|
|
3413 |
|
|
3414 |
|
|
3415 |
Schoenebeck Expires August 17, 2008 [Page 61] |
Schoenebeck Expires May 5, 2010 [Page 61] |
3416 |
|
|
3417 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3418 |
|
|
3419 |
|
|
3420 |
|
"NONE" - |
3421 |
|
|
3422 |
This is the default setting. In this case the sampler channel |
This is the default setting. In this case the sampler channel |
3423 |
is not assigned any MIDI instrument map and thus will ignore |
is not assigned any MIDI instrument map and thus will ignore |
3424 |
all MIDI program change messages. |
all MIDI program change messages. |
3465 |
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3466 |
(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 |
3467 |
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 |
|
3468 |
|
|
3469 |
|
|
3470 |
|
|
3471 |
Schoenebeck Expires August 17, 2008 [Page 62] |
Schoenebeck Expires May 5, 2010 [Page 62] |
3472 |
|
|
3473 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3474 |
|
|
3475 |
|
|
3476 |
|
0..127 defining the MIDI controller which can alter the effect send |
3477 |
|
level and <name> is an optional argument defining a name for the |
3478 |
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 |
3479 |
encapsulated into apostrophes and supports escape sequences as |
encapsulated into apostrophes and supports escape sequences as |
3480 |
described in chapter "Character Set and Escape Sequences |
described in chapter "Character Set and Escape Sequences |
3520 |
|
|
3521 |
C: "CREATE FX_SEND 0 93" |
C: "CREATE FX_SEND 0 93" |
3522 |
|
|
|
S: "OK[1]" |
|
|
|
|
3523 |
|
|
3524 |
|
|
3525 |
|
|
3526 |
|
|
3527 |
Schoenebeck Expires August 17, 2008 [Page 63] |
Schoenebeck Expires May 5, 2010 [Page 63] |
3528 |
|
|
3529 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3530 |
|
|
3531 |
|
|
3532 |
|
S: "OK[1]" |
3533 |
|
|
3534 |
6.4.26. Removing an effect send from a sampler channel |
6.4.26. Removing an effect send from a sampler channel |
3535 |
|
|
3536 |
The front-end can remove an existing effect send on a specific |
The front-end can remove an existing effect send on a specific |
3575 |
|
|
3576 |
Possible Answers: |
Possible Answers: |
3577 |
|
|
|
The sampler will answer by returning the number of effect sends on |
|
|
the given sampler channel. |
|
3578 |
|
|
|
Example: |
|
3579 |
|
|
3580 |
|
|
3581 |
|
|
3582 |
Schoenebeck Expires August 17, 2008 [Page 64] |
|
3583 |
|
Schoenebeck Expires May 5, 2010 [Page 64] |
3584 |
|
|
3585 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3586 |
|
|
3587 |
|
|
3588 |
|
The sampler will answer by returning the number of effect sends on |
3589 |
|
the given sampler channel. |
3590 |
|
|
3591 |
|
Example: |
3592 |
|
|
3593 |
C: "GET FX_SENDS 0" |
C: "GET FX_SENDS 0" |
3594 |
|
|
3633 |
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 |
3634 |
FX_SENDS" (Section 6.4.28) command. |
FX_SENDS" (Section 6.4.28) command. |
3635 |
|
|
|
Possible Answers: |
|
|
|
|
|
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 |
|
3636 |
|
|
3637 |
|
|
3638 |
|
|
3639 |
Schoenebeck Expires August 17, 2008 [Page 65] |
Schoenebeck Expires May 5, 2010 [Page 65] |
3640 |
|
|
3641 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3642 |
|
|
3643 |
|
|
3644 |
|
Possible Answers: |
3645 |
|
|
3646 |
|
The sampler will answer by sending a <CRLF> separated list. Each |
3647 |
|
answer line begins with the settings category name followed by a |
3648 |
|
colon and then a space character <SP> and finally the info |
3649 |
character string to that setting category. At the moment the |
character string to that setting category. At the moment the |
3650 |
following categories are defined: |
following categories are defined: |
3651 |
|
|
3689 |
|
|
3690 |
"LEVEL: 0.3" |
"LEVEL: 0.3" |
3691 |
|
|
|
"AUDIO_OUTPUT_ROUTING: 2,3" |
|
|
|
|
|
"." |
|
3692 |
|
|
3693 |
|
|
3694 |
|
|
3695 |
|
Schoenebeck Expires May 5, 2010 [Page 66] |
3696 |
|
|
3697 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
3698 |
|
|
3699 |
|
|
3700 |
Schoenebeck Expires August 17, 2008 [Page 66] |
"AUDIO_OUTPUT_ROUTING: 2,3" |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
3701 |
|
|
3702 |
|
"." |
3703 |
|
|
3704 |
6.4.30. Changing effect send's name |
6.4.30. Changing effect send's name |
3705 |
|
|
3745 |
<audio-src> <audio-dst> |
<audio-src> <audio-dst> |
3746 |
|
|
3747 |
Where <sampler-chan> is the sampler channel number as returned by the |
Where <sampler-chan> is the sampler channel number as returned by the |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
|
|
command, <fx-send-id> reflects the numerical ID of the effect send |
|
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
|
|
FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID |
|
3748 |
|
|
3749 |
|
|
3750 |
|
|
3751 |
Schoenebeck Expires August 17, 2008 [Page 67] |
Schoenebeck Expires May 5, 2010 [Page 67] |
3752 |
|
|
3753 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3754 |
|
|
3755 |
|
|
3756 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3757 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3758 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3759 |
|
FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID |
3760 |
of the effect send's audio channel which should be rerouted and |
of the effect send's audio channel which should be rerouted and |
3761 |
<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 |
3762 |
audio output device where <audio-src> should be routed to. |
audio output device where <audio-src> should be routed to. |
3801 |
The front-end can alter the MIDI controller of an effect send entity |
The front-end can alter the MIDI controller of an effect send entity |
3802 |
by sending the following command: |
by sending the following command: |
3803 |
|
|
|
SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi- |
|
|
ctrl> |
|
|
|
|
|
Where <sampler-chan> is the sampler channel number as returned by the |
|
3804 |
|
|
3805 |
|
|
3806 |
|
|
3807 |
Schoenebeck Expires August 17, 2008 [Page 68] |
Schoenebeck Expires May 5, 2010 [Page 68] |
3808 |
|
|
3809 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
3810 |
|
|
3811 |
|
|
3812 |
|
SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi- |
3813 |
|
ctrl> |
3814 |
|
|
3815 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3816 |
"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) |
3817 |
command, <fx-send-id> reflects the numerical ID of the effect send |
command, <fx-send-id> reflects the numerical ID of the effect send |
3818 |
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 |
3857 |
FX_SENDS" (Section 6.4.28) command and <volume> is an optionally |
FX_SENDS" (Section 6.4.28) command and <volume> is an optionally |
3858 |
dotted positive number (a value smaller than 1.0 means attenuation, |
dotted positive number (a value smaller than 1.0 means attenuation, |
3859 |
whereas a value greater than 1.0 means amplification) reflecting the |
whereas a value greater than 1.0 means amplification) reflecting the |
|
new send level. |
|
3860 |
|
|
|
Possible Answers: |
|
3861 |
|
|
3862 |
|
|
3863 |
|
Schoenebeck Expires May 5, 2010 [Page 69] |
3864 |
|
|
3865 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
3866 |
|
|
3867 |
|
|
3868 |
Schoenebeck Expires August 17, 2008 [Page 69] |
new send level. |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
3869 |
|
|
3870 |
|
Possible Answers: |
3871 |
|
|
3872 |
"OK" - |
"OK" - |
3873 |
|
|
3890 |
|
|
3891 |
S: "OK" |
S: "OK" |
3892 |
|
|
3893 |
6.4.34. Resetting a sampler channel |
6.4.34. Sending MIDI messages to sampler channel |
3894 |
|
|
3895 |
|
The front-end can send MIDI events to a specific sampler channel by |
3896 |
|
sending the following command: |
3897 |
|
|
3898 |
|
SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2> |
3899 |
|
|
3900 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3901 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3902 |
|
command, <arg1> and <arg2> arguments depend on the <midi-msg> |
3903 |
|
argument, which specifies the MIDI message type. Currently, the |
3904 |
|
following MIDI messages are supported: |
3905 |
|
|
3906 |
|
"NOTE_ON" - |
3907 |
|
|
3908 |
|
For turning on MIDI notes, where <arg1> specifies the key |
3909 |
|
number and <arg2> the velocity as described in the MIDI |
3910 |
|
specification. |
3911 |
|
|
3912 |
|
"NOTE_OFF" - |
3913 |
|
|
3914 |
|
For turning a currently playing MIDI note off, where <arg1> |
3915 |
|
specifies the key number and <arg2> the velocity as described |
3916 |
|
|
3917 |
|
|
3918 |
|
|
3919 |
|
Schoenebeck Expires May 5, 2010 [Page 70] |
3920 |
|
|
3921 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
3922 |
|
|
3923 |
|
|
3924 |
|
in the MIDI specification. |
3925 |
|
|
3926 |
|
"CC" - |
3927 |
|
|
3928 |
|
For changing a MIDI controller, where <arg1> specifies the |
3929 |
|
controller number and <arg2> the new value of the controller as |
3930 |
|
described in the Control Change section of the MIDI |
3931 |
|
specification. |
3932 |
|
|
3933 |
|
CAUTION: This command is provided for implementations of virtual MIDI |
3934 |
|
keyboards and no realtime guarantee whatsoever will be made! |
3935 |
|
|
3936 |
|
Possible Answers: |
3937 |
|
|
3938 |
|
"OK" - |
3939 |
|
|
3940 |
|
on success |
3941 |
|
|
3942 |
|
"ERR:<error-code>:<error-message>" - |
3943 |
|
|
3944 |
|
in case it failed, providing an appropriate error code and |
3945 |
|
error message |
3946 |
|
|
3947 |
|
Example: |
3948 |
|
|
3949 |
|
C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112" |
3950 |
|
|
3951 |
|
S: "OK" |
3952 |
|
|
3953 |
|
6.4.35. Resetting a sampler channel |
3954 |
|
|
3955 |
The front-end can reset a particular sampler channel by sending the |
The front-end can reset a particular sampler channel by sending the |
3956 |
following command: |
following command: |
3968 |
|
|
3969 |
on success |
on success |
3970 |
|
|
|
"WRN:<warning-code>:<warning-message>" - |
|
3971 |
|
|
|
if channel was reset, but there are noteworthy issue(s) |
|
|
related, providing an appropriate warning code and warning |
|
|
message |
|
3972 |
|
|
|
"ERR:<error-code>:<error-message>" - |
|
3973 |
|
|
3974 |
|
|
3975 |
|
Schoenebeck Expires May 5, 2010 [Page 71] |
3976 |
|
|
3977 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
3978 |
|
|
3979 |
|
|
3980 |
|
"WRN:<warning-code>:<warning-message>" - |
3981 |
|
|
3982 |
Schoenebeck Expires August 17, 2008 [Page 70] |
if channel was reset, but there are noteworthy issue(s) |
3983 |
|
related, providing an appropriate warning code and warning |
3984 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
message |
3985 |
|
|
3986 |
|
"ERR:<error-code>:<error-message>" - |
3987 |
|
|
3988 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3989 |
error message |
error message |
4028 |
|
|
4029 |
|
|
4030 |
|
|
4031 |
6.5.2. Unregister front-end for not receiving event messages |
Schoenebeck Expires May 5, 2010 [Page 72] |
4032 |
|
|
4033 |
The front-end can unregister itself if it doesn't want to receive |
Internet-Draft LinuxSampler Control Protocol November 2009 |
|
event messages anymore by sending the following command: |
|
4034 |
|
|
4035 |
|
|
4036 |
|
|
4037 |
|
|
4038 |
Schoenebeck Expires August 17, 2008 [Page 71] |
6.5.2. Unregister front-end for not receiving event messages |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
4039 |
|
|
4040 |
|
The front-end can unregister itself if it doesn't want to receive |
4041 |
|
event messages anymore by sending the following command: |
4042 |
|
|
4043 |
UNSUBSCRIBE <event-id> |
UNSUBSCRIBE <event-id> |
4044 |
|
|
4082 |
|
|
4083 |
Possible Answers: |
Possible Answers: |
4084 |
|
|
|
"OK" - |
|
|
|
|
|
usually |
|
|
|
|
|
|
|
4085 |
|
|
4086 |
|
|
4087 |
|
Schoenebeck Expires May 5, 2010 [Page 73] |
4088 |
|
|
4089 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4090 |
|
|
4091 |
|
|
4092 |
Schoenebeck Expires August 17, 2008 [Page 72] |
"OK" - |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
4093 |
|
|
4094 |
|
usually |
4095 |
|
|
4096 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
4097 |
|
|
4136 |
|
|
4137 |
Possible Answers: |
Possible Answers: |
4138 |
|
|
|
LinuxSampler will answer by returning the maximum number of active |
|
|
voices. |
|
|
|
|
|
|
|
4139 |
|
|
4140 |
|
|
4141 |
|
|
4142 |
|
|
4143 |
Schoenebeck Expires August 17, 2008 [Page 73] |
Schoenebeck Expires May 5, 2010 [Page 74] |
4144 |
|
|
4145 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
4146 |
|
|
4147 |
|
|
4148 |
|
LinuxSampler will answer by returning the maximum number of active |
4149 |
|
voices. |
4150 |
|
|
4151 |
6.6.3. Current number of active disk streams |
6.6.3. Current number of active disk streams |
4152 |
|
|
4153 |
The front-end can ask for the current number of active disk streams |
The front-end can ask for the current number of active disk streams |
4194 |
|
|
4195 |
|
|
4196 |
|
|
|
DESCRIPTION - |
|
4197 |
|
|
4198 |
|
|
4199 |
|
Schoenebeck Expires May 5, 2010 [Page 75] |
4200 |
|
|
4201 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4202 |
|
|
4203 |
|
|
|
Schoenebeck Expires August 17, 2008 [Page 74] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
4204 |
|
|
4205 |
|
|
4206 |
|
DESCRIPTION - |
4207 |
|
|
4208 |
arbitrary textual description about the sampler (note that |
arbitrary textual description about the sampler (note that |
4209 |
the character string may contain escape sequences |
the character string may contain escape sequences |
4210 |
(Section 7.1)) |
(Section 7.1)) |
4248 |
The client can alter the current global sampler-wide volume |
The client can alter the current global sampler-wide volume |
4249 |
attenuation by sending the following command: |
attenuation by sending the following command: |
4250 |
|
|
4251 |
|
|
4252 |
|
|
4253 |
|
|
4254 |
|
|
4255 |
|
Schoenebeck Expires May 5, 2010 [Page 76] |
4256 |
|
|
4257 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4258 |
|
|
4259 |
|
|
4260 |
SET VOLUME <volume> |
SET VOLUME <volume> |
4261 |
|
|
4262 |
Where <volume> should be replaced by the optional dotted floating |
Where <volume> should be replaced by the optional dotted floating |
4263 |
point value, reflecting the new global volume parameter. This value |
point value, reflecting the new global volume parameter. This value |
4264 |
might usually be in the range between 0.0 and 1.0, that is for |
might usually be in the range between 0.0 and 1.0, that is for |
4265 |
|
attenuating the overall volume. |
4266 |
|
|
4267 |
|
Possible Answers: |
4268 |
|
|
4269 |
|
"OK" - |
4270 |
|
|
4271 |
|
on success |
4272 |
|
|
4273 |
|
"WRN:<warning-code>:<warning-message>" - |
4274 |
|
|
4275 |
|
if the global volume was set, but there are noteworthy issue(s) |
4276 |
|
related, providing an appropriate warning code and warning |
4277 |
|
message |
4278 |
|
|
4279 |
|
"ERR:<error-code>:<error-message>" - |
4280 |
|
|
4281 |
|
in case it failed, providing an appropriate error code and |
4282 |
|
error message |
4283 |
|
|
4284 |
|
6.6.8. Getting global voice limit |
4285 |
|
|
4286 |
|
The client can ask for the current global sampler-wide limit for |
4287 |
|
maximum voices by sending the following command: |
4288 |
|
|
4289 |
Schoenebeck Expires August 17, 2008 [Page 75] |
GET VOICES |
4290 |
|
|
4291 |
|
Possible Answers: |
4292 |
|
|
4293 |
|
LinuxSampler will answer by returning the number for the current |
4294 |
|
limit of maximum voices. |
4295 |
|
|
4296 |
|
The voice limit setting defines how many voices should maximum be |
4297 |
|
processed by the sampler at the same time. If the user triggers new |
4298 |
|
notes which would exceed that voice limit, the sampler engine will |
4299 |
|
react by stealing old voices for those newly triggered notes. Note |
4300 |
|
that the amount of voices triggered by a new note can be larger than |
4301 |
|
one and is dependent to the respective instrument and probably |
4302 |
|
further criterias. |
4303 |
|
|
4304 |
|
6.6.9. Setting global voice limit |
4305 |
|
|
4306 |
|
The client can alter the current global sampler-wide limit for |
4307 |
|
maximum voices by sending the following command: |
4308 |
|
|
4309 |
|
|
4310 |
|
|
4311 |
|
Schoenebeck Expires May 5, 2010 [Page 77] |
4312 |
|
|
4313 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
4314 |
|
|
4315 |
|
|
4316 |
attenuating the overall volume. |
SET VOICES <max-voices> |
4317 |
|
|
4318 |
|
Where <max-voices> should be replaced by the integer value, |
4319 |
|
reflecting the new global amount limit of maximum voices. This value |
4320 |
|
has to be larger than 0. |
4321 |
|
|
4322 |
Possible Answers: |
Possible Answers: |
4323 |
|
|
4327 |
|
|
4328 |
"WRN:<warning-code>:<warning-message>" - |
"WRN:<warning-code>:<warning-message>" - |
4329 |
|
|
4330 |
if the global volume was set, but there are noteworthy issue(s) |
if the voice limit was set, but there are noteworthy issue(s) |
4331 |
related, providing an appropriate warning code and warning |
related, providing an appropriate warning code and warning |
4332 |
message |
message |
4333 |
|
|
4336 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
4337 |
error message |
error message |
4338 |
|
|
4339 |
|
Note: the given value will be passed to all sampler engine instances. |
4340 |
|
The total amount of maximum voices on the running system might thus |
4341 |
|
be as big as the given value multiplied by the current amount of |
4342 |
|
engine instances. |
4343 |
|
|
4344 |
|
Caution: when adjusting the voice limit, you SHOULD also adjust the |
4345 |
|
disk stream limit respectively and vice versa. |
4346 |
|
|
4347 |
|
6.6.10. Getting global disk stream limit |
4348 |
|
|
4349 |
|
The client can ask for the current global sampler-wide limit for |
4350 |
|
maximum disk streams by sending the following command: |
4351 |
|
|
4352 |
|
GET STREAMS |
4353 |
|
|
4354 |
|
Possible Answers: |
4355 |
|
|
4356 |
|
LinuxSampler will answer by returning the number for the current |
4357 |
|
limit of maximum disk streams. |
4358 |
|
|
4359 |
|
The disk stream limit setting defines how many disk streams should |
4360 |
|
maximum be processed by a sampler engine at the same time. The |
4361 |
|
higher this value, the more memory (RAM) will be occupied, since |
4362 |
|
every disk streams allocates a certain buffer size for being able to |
4363 |
|
perform its streaming operations. |
4364 |
|
|
4365 |
|
|
4366 |
|
|
4367 |
|
Schoenebeck Expires May 5, 2010 [Page 78] |
4368 |
|
|
4369 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4370 |
|
|
4371 |
|
|
4372 |
|
6.6.11. Setting global disk stream limit |
4373 |
|
|
4374 |
|
The client can alter the current global sampler-wide limit for |
4375 |
|
maximum disk streams by sending the following command: |
4376 |
|
|
4377 |
|
SET STREAMS <max-streams> |
4378 |
|
|
4379 |
|
Where <max-streams> should be replaced by the integer value, |
4380 |
|
reflecting the new global amount limit of maximum disk streams. This |
4381 |
|
value has to be positive. |
4382 |
|
|
4383 |
|
Possible Answers: |
4384 |
|
|
4385 |
|
"OK" - |
4386 |
|
|
4387 |
|
on success |
4388 |
|
|
4389 |
|
"WRN:<warning-code>:<warning-message>" - |
4390 |
|
|
4391 |
|
if the disk stream limit was set, but there are noteworthy |
4392 |
|
issue(s) related, providing an appropriate warning code and |
4393 |
|
warning message |
4394 |
|
|
4395 |
|
"ERR:<error-code>:<error-message>" - |
4396 |
|
|
4397 |
|
in case it failed, providing an appropriate error code and |
4398 |
|
error message |
4399 |
|
|
4400 |
|
Note: the given value will be passed to all sampler engine instances. |
4401 |
|
The total amount of maximum disk streams on the running system might |
4402 |
|
thus be as big as the given value multiplied by the current amount of |
4403 |
|
engine instances. |
4404 |
|
|
4405 |
|
Caution: when adjusting the disk stream limit, you SHOULD also adjust |
4406 |
|
the voice limit respectively and vice versa. |
4407 |
|
|
4408 |
6.7. MIDI Instrument Mapping |
6.7. MIDI Instrument Mapping |
4409 |
|
|
4410 |
The MIDI protocol provides a way to switch between instruments by |
The MIDI protocol provides a way to switch between instruments by |
4417 |
maps which define which instrument to load on which MIDI program |
maps which define which instrument to load on which MIDI program |
4418 |
change message. |
change message. |
4419 |
|
|
4420 |
|
|
4421 |
|
|
4422 |
|
|
4423 |
|
Schoenebeck Expires May 5, 2010 [Page 79] |
4424 |
|
|
4425 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4426 |
|
|
4427 |
|
|
4428 |
By default, that is when the sampler is launched, there is no map, |
By default, that is when the sampler is launched, there is no map, |
4429 |
thus the sampler will simply ignore all program change messages. The |
thus the sampler will simply ignore all program change messages. The |
4430 |
front-end has to explicitly create at least one map, add entries to |
front-end has to explicitly create at least one map, add entries to |
4443 |
sampler to switch to the respective instrument as reflected by the |
sampler to switch to the respective instrument as reflected by the |
4444 |
current MIDI instrument map. |
current MIDI instrument map. |
4445 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 76] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4446 |
6.7.1. Create a new MIDI instrument map |
6.7.1. Create a new MIDI instrument map |
4447 |
|
|
4448 |
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 |
4472 |
|
|
4473 |
C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'" |
C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'" |
4474 |
|
|
4475 |
|
|
4476 |
|
|
4477 |
|
|
4478 |
|
|
4479 |
|
Schoenebeck Expires May 5, 2010 [Page 80] |
4480 |
|
|
4481 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4482 |
|
|
4483 |
|
|
4484 |
S: "OK[0]" |
S: "OK[0]" |
4485 |
|
|
4486 |
C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'" |
C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'" |
4501 |
Where <map> reflects the unique ID of the map to delete as returned |
Where <map> reflects the unique ID of the map to delete as returned |
4502 |
by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command. |
by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command. |
4503 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 77] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4504 |
The front-end can delete all MIDI instrument maps by sending the |
The front-end can delete all MIDI instrument maps by sending the |
4505 |
following command: |
following command: |
4506 |
|
|
4526 |
|
|
4527 |
S: "OK" |
S: "OK" |
4528 |
|
|
4529 |
|
|
4530 |
|
|
4531 |
|
|
4532 |
|
|
4533 |
|
|
4534 |
|
|
4535 |
|
Schoenebeck Expires May 5, 2010 [Page 81] |
4536 |
|
|
4537 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4538 |
|
|
4539 |
|
|
4540 |
6.7.3. Get amount of existing MIDI instrument maps |
6.7.3. Get amount of existing MIDI instrument maps |
4541 |
|
|
4542 |
The front-end can retrieve the current amount of MIDI instrument maps |
The front-end can retrieve the current amount of MIDI instrument maps |
4561 |
current list of MIDI instrument maps, the front-end can send the |
current list of MIDI instrument maps, the front-end can send the |
4562 |
following command: |
following command: |
4563 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 78] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4564 |
LIST MIDI_INSTRUMENT_MAPS |
LIST MIDI_INSTRUMENT_MAPS |
4565 |
|
|
4566 |
Possible Answers: |
Possible Answers: |
4585 |
interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS" |
interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS" |
4586 |
(Section 6.7.4) command. |
(Section 6.7.4) command. |
4587 |
|
|
4588 |
|
|
4589 |
|
|
4590 |
|
|
4591 |
|
Schoenebeck Expires May 5, 2010 [Page 82] |
4592 |
|
|
4593 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4594 |
|
|
4595 |
|
|
4596 |
Possible Answers: |
Possible Answers: |
4597 |
|
|
4598 |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
4618 |
|
|
4619 |
Example: |
Example: |
4620 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 79] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4621 |
C: "GET MIDI_INSTRUMENT_MAP INFO 0" |
C: "GET MIDI_INSTRUMENT_MAP INFO 0" |
4622 |
|
|
4623 |
S: "NAME: Standard Map" |
S: "NAME: Standard Map" |
4641 |
|
|
4642 |
Possible Answers: |
Possible Answers: |
4643 |
|
|
4644 |
|
|
4645 |
|
|
4646 |
|
|
4647 |
|
Schoenebeck Expires May 5, 2010 [Page 83] |
4648 |
|
|
4649 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4650 |
|
|
4651 |
|
|
4652 |
"OK" - |
"OK" - |
4653 |
|
|
4654 |
on success |
on success |
4674 |
|
|
4675 |
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 |
4676 |
integer value between 0..16383 reflecting the MIDI bank select index, |
integer value between 0..16383 reflecting the MIDI bank select index, |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 80] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4677 |
<midi_prog> an integer value between 0..127 reflecting the MIDI |
<midi_prog> an integer value between 0..127 reflecting the MIDI |
4678 |
program change index, <engine_name> a sampler engine name as returned |
program change index, <engine_name> a sampler engine name as returned |
4679 |
by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not |
by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not |
4698 |
be freed from memory when not needed by any sampler channel |
be freed from memory when not needed by any sampler channel |
4699 |
anymore. |
anymore. |
4700 |
|
|
4701 |
|
|
4702 |
|
|
4703 |
|
Schoenebeck Expires May 5, 2010 [Page 84] |
4704 |
|
|
4705 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4706 |
|
|
4707 |
|
|
4708 |
"ON_DEMAND_HOLD" - |
"ON_DEMAND_HOLD" - |
4709 |
|
|
4710 |
The instrument will be loaded when needed, that is when |
The instrument will be loaded when needed, that is when |
4729 |
In case there is no <instr_load_mode> argument given, it will |
In case there is no <instr_load_mode> argument given, it will |
4730 |
be up to the InstrumentManager to decide which mode to use. |
be up to the InstrumentManager to decide which mode to use. |
4731 |
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 August 17, 2008 [Page 81] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4732 |
instrument does not exist in the InstrumentManager's list yet, |
instrument does not exist in the InstrumentManager's list yet, |
4733 |
otherwise if an entry already exists, it will simply stick with |
otherwise if an entry already exists, it will simply stick with |
4734 |
the mode currently reflected by the already existing entry, |
the mode currently reflected by the already existing entry, |
4753 |
"Character Set and Escape Sequences (Section 7.1)") for the mapping |
"Character Set and Escape Sequences (Section 7.1)") for the mapping |
4754 |
entry, useful for frontends for displaying an appropriate name for |
entry, useful for frontends for displaying an appropriate name for |
4755 |
mapped instruments (using "GET MIDI_INSTRUMENT INFO" |
mapped instruments (using "GET MIDI_INSTRUMENT INFO" |
4756 |
|
|
4757 |
|
|
4758 |
|
|
4759 |
|
Schoenebeck Expires May 5, 2010 [Page 85] |
4760 |
|
|
4761 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4762 |
|
|
4763 |
|
|
4764 |
(Section 6.7.11)). |
(Section 6.7.11)). |
4765 |
|
|
4766 |
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
4784 |
|
|
4785 |
usually |
usually |
4786 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 82] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4787 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
4788 |
|
|
4789 |
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 |
4809 |
C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 |
C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 |
4810 |
'Silent Piano'" |
'Silent Piano'" |
4811 |
|
|
4812 |
|
|
4813 |
|
|
4814 |
|
|
4815 |
|
Schoenebeck Expires May 5, 2010 [Page 86] |
4816 |
|
|
4817 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4818 |
|
|
4819 |
|
|
4820 |
S: "OK" |
S: "OK" |
4821 |
|
|
4822 |
C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/ |
C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/ |
4838 |
|
|
4839 |
Possible Answers: |
Possible Answers: |
4840 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 83] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4841 |
The sampler will answer by sending the current number of entries |
The sampler will answer by sending the current number of entries |
4842 |
in the MIDI instrument map(s). |
in the MIDI instrument map(s). |
4843 |
|
|
4863 |
The front-end can query a list of all currently existing entries of |
The front-end can query a list of all currently existing entries of |
4864 |
all MIDI instrument maps by sending the following command: |
all MIDI instrument maps by sending the following command: |
4865 |
|
|
4866 |
|
|
4867 |
|
|
4868 |
|
|
4869 |
|
|
4870 |
|
|
4871 |
|
Schoenebeck Expires May 5, 2010 [Page 87] |
4872 |
|
|
4873 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4874 |
|
|
4875 |
|
|
4876 |
LIST MIDI_INSTRUMENTS ALL |
LIST MIDI_INSTRUMENTS ALL |
4877 |
|
|
4878 |
Possible Answers: |
Possible Answers: |
4896 |
The front-end can delete an entry from a MIDI instrument map by |
The front-end can delete an entry from a MIDI instrument map by |
4897 |
sending the following command: |
sending the following command: |
4898 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 84] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4899 |
UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> |
UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> |
4900 |
|
|
4901 |
Where <map> is the numeric ID of the MIDI instrument map, <midi_bank> |
Where <map> is the numeric ID of the MIDI instrument map, <midi_bank> |
4919 |
|
|
4920 |
S: "OK" |
S: "OK" |
4921 |
|
|
4922 |
|
|
4923 |
|
|
4924 |
|
|
4925 |
|
|
4926 |
|
|
4927 |
|
Schoenebeck Expires May 5, 2010 [Page 88] |
4928 |
|
|
4929 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4930 |
|
|
4931 |
|
|
4932 |
6.7.11. Get current settings of MIDI instrument map entry |
6.7.11. Get current settings of MIDI instrument map entry |
4933 |
|
|
4934 |
The front-end can retrieve the current settings of a certain |
The front-end can retrieve the current settings of a certain |
4954 |
|
|
4955 |
Name for this MIDI instrument map entry (if defined). This |
Name for this MIDI instrument map entry (if defined). This |
4956 |
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 August 17, 2008 [Page 85] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
4957 |
mapped instrument. It can be set and changed with the "MAP |
mapped instrument. It can be set and changed with the "MAP |
4958 |
MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to |
MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to |
4959 |
be unique. (note that this character string may contain escape |
be unique. (note that this character string may contain escape |
4977 |
Name of the loaded instrument as reflected by its file. In |
Name of the loaded instrument as reflected by its file. In |
4978 |
contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
4979 |
cannot be changed (note that this character string may contain |
cannot be changed (note that this character string may contain |
4980 |
|
|
4981 |
|
|
4982 |
|
|
4983 |
|
Schoenebeck Expires May 5, 2010 [Page 89] |
4984 |
|
|
4985 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
4986 |
|
|
4987 |
|
|
4988 |
escape sequences (Section 7.1)). |
escape sequences (Section 7.1)). |
4989 |
|
|
4990 |
"LOAD_MODE" - |
"LOAD_MODE" - |
5010 |
|
|
5011 |
"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig" |
"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig" |
5012 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 86] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5013 |
"INSTRUMENT_NR: 0" |
"INSTRUMENT_NR: 0" |
5014 |
|
|
5015 |
"INSTRUMENT_NAME: Joe's Drumkit" |
"INSTRUMENT_NAME: Joe's Drumkit" |
5032 |
The front-end can clear all MIDI instrument maps, that is delete all |
The front-end can clear all MIDI instrument maps, that is delete all |
5033 |
entries of all maps by sending the following command: |
entries of all maps by sending the following command: |
5034 |
|
|
5035 |
|
|
5036 |
|
|
5037 |
|
|
5038 |
|
|
5039 |
|
Schoenebeck Expires May 5, 2010 [Page 90] |
5040 |
|
|
5041 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5042 |
|
|
5043 |
|
|
5044 |
CLEAR MIDI_INSTRUMENTS ALL |
CLEAR MIDI_INSTRUMENTS ALL |
5045 |
|
|
5046 |
The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps, |
The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps, |
5063 |
|
|
5064 |
S: "OK" |
S: "OK" |
5065 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 87] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5066 |
6.8. Managing Instruments Database |
6.8. Managing Instruments Database |
5067 |
|
|
5068 |
The following commands describe how to use and manage the instruments |
The following commands describe how to use and manage the instruments |
5090 |
|
|
5091 |
Possible Answers: |
Possible Answers: |
5092 |
|
|
5093 |
|
|
5094 |
|
|
5095 |
|
Schoenebeck Expires May 5, 2010 [Page 91] |
5096 |
|
|
5097 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5098 |
|
|
5099 |
|
|
5100 |
"OK" - |
"OK" - |
5101 |
|
|
5102 |
on success |
on success |
5118 |
The front-end can delete a particular instrument directory from the |
The front-end can delete a particular instrument directory from the |
5119 |
instruments database by sending the following command: |
instruments database by sending the following command: |
5120 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 88] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5121 |
REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir> |
REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir> |
5122 |
|
|
5123 |
Where <dir> is the absolute path name of the directory to delete. |
Where <dir> is the absolute path name of the directory to delete. |
5141 |
|
|
5142 |
S: "OK" |
S: "OK" |
5143 |
|
|
5144 |
|
|
5145 |
|
|
5146 |
|
|
5147 |
|
|
5148 |
|
|
5149 |
|
|
5150 |
|
|
5151 |
|
Schoenebeck Expires May 5, 2010 [Page 92] |
5152 |
|
|
5153 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5154 |
|
|
5155 |
|
|
5156 |
6.8.3. Getting amount of instrument directories |
6.8.3. Getting amount of instrument directories |
5157 |
|
|
5158 |
The front-end can retrieve the current amount of directories in a |
The front-end can retrieve the current amount of directories in a |
5176 |
|
|
5177 |
Example: |
Example: |
5178 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 89] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5179 |
C: "GET DB_INSTRUMENT_DIRECTORIES '/'" |
C: "GET DB_INSTRUMENT_DIRECTORIES '/'" |
5180 |
|
|
5181 |
S: "2" |
S: "2" |
5201 |
|
|
5202 |
if the given directory does not exist. |
if the given directory does not exist. |
5203 |
|
|
5204 |
|
|
5205 |
|
|
5206 |
|
|
5207 |
|
Schoenebeck Expires May 5, 2010 [Page 93] |
5208 |
|
|
5209 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5210 |
|
|
5211 |
|
|
5212 |
Example: |
Example: |
5213 |
|
|
5214 |
C: "LIST DB_INSTRUMENT_DIRECTORIES '/'" |
C: "LIST DB_INSTRUMENT_DIRECTORIES '/'" |
5232 |
|
|
5233 |
Possible Answers: |
Possible Answers: |
5234 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 90] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5235 |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
5236 |
answer line begins with the settings category name followed by a |
answer line begins with the settings category name followed by a |
5237 |
colon and then a space character <SP> and finally the info |
colon and then a space character <SP> and finally the info |
5257 |
|
|
5258 |
The mentioned fields above don't have to be in particular order. |
The mentioned fields above don't have to be in particular order. |
5259 |
|
|
5260 |
|
|
5261 |
|
|
5262 |
|
|
5263 |
|
Schoenebeck Expires May 5, 2010 [Page 94] |
5264 |
|
|
5265 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5266 |
|
|
5267 |
|
|
5268 |
Example: |
Example: |
5269 |
|
|
5270 |
C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'" |
C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'" |
5288 |
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 |
5289 |
the new name for that directory. |
the new name for that directory. |
5290 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 91] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5291 |
Possible Answers: |
Possible Answers: |
5292 |
|
|
5293 |
"OK" - |
"OK" - |
5311 |
The front-end can move a specific instrument directory by sending the |
The front-end can move a specific instrument directory by sending the |
5312 |
following command: |
following command: |
5313 |
|
|
5314 |
|
|
5315 |
|
|
5316 |
|
|
5317 |
|
|
5318 |
|
|
5319 |
|
Schoenebeck Expires May 5, 2010 [Page 95] |
5320 |
|
|
5321 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5322 |
|
|
5323 |
|
|
5324 |
MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst> |
MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst> |
5325 |
|
|
5326 |
Where <dir> is the absolute path name of the directory to move and |
Where <dir> is the absolute path name of the directory to move and |
5346 |
|
|
5347 |
S: "OK" |
S: "OK" |
5348 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 92] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5349 |
6.8.8. Copying instrument directories |
6.8.8. Copying instrument directories |
5350 |
|
|
5351 |
The front-end can copy a specific instrument directory by sending the |
The front-end can copy a specific instrument directory by sending the |
5369 |
exists in the destination directory. Error is also thrown when |
exists in the destination directory. Error is also thrown when |
5370 |
trying to copy a directory to a subdirectory of itself. |
trying to copy a directory to a subdirectory of itself. |
5371 |
|
|
5372 |
|
|
5373 |
|
|
5374 |
|
|
5375 |
|
Schoenebeck Expires May 5, 2010 [Page 96] |
5376 |
|
|
5377 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5378 |
|
|
5379 |
|
|
5380 |
Example: |
Example: |
5381 |
|
|
5382 |
C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' |
C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' |
5402 |
|
|
5403 |
on success |
on success |
5404 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 93] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5405 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
5406 |
|
|
5407 |
in case the given directory does not exists. |
in case the given directory does not exists. |
5425 |
directory to search in. If NON_RECURSIVE is specified, the |
directory to search in. If NON_RECURSIVE is specified, the |
5426 |
directories located in subdirectories of the specified directory will |
directories located in subdirectories of the specified directory will |
5427 |
not be searched. <criteria-list> is a list of search criterias in |
not be searched. <criteria-list> is a list of search criterias in |
5428 |
|
|
5429 |
|
|
5430 |
|
|
5431 |
|
Schoenebeck Expires May 5, 2010 [Page 97] |
5432 |
|
|
5433 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5434 |
|
|
5435 |
|
|
5436 |
form of "key1=val1 key2=val2 ...". The following criterias are |
form of "key1=val1 key2=val2 ...". The following criterias are |
5437 |
allowed: |
allowed: |
5438 |
|
|
5458 |
modification satisfies the specified period, where <date-after> |
modification satisfies the specified period, where <date-after> |
5459 |
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- |
5460 |
after> is omitted the search is restricted to directories, which |
after> is omitted the search is restricted to directories, which |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 94] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5461 |
are last modified before <date-before>. If <date-before> is |
are last modified before <date-before>. If <date-before> is |
5462 |
omitted, the search is restricted to directories, which are last |
omitted, the search is restricted to directories, which are last |
5463 |
modified after <date-after>. |
modified after <date-after>. |
5480 |
|
|
5481 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
5482 |
|
|
5483 |
|
|
5484 |
|
|
5485 |
|
|
5486 |
|
|
5487 |
|
Schoenebeck Expires May 5, 2010 [Page 98] |
5488 |
|
|
5489 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5490 |
|
|
5491 |
|
|
5492 |
if the given directory does not exist. |
if the given directory does not exist. |
5493 |
|
|
5494 |
Example: |
Example: |
5507 |
The front-end can add one or more instruments to the instruments |
The front-end can add one or more instruments to the instruments |
5508 |
database by sending the following command: |
database by sending the following command: |
5509 |
|
|
5510 |
ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> |
ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> |
5511 |
[<instr_index>] |
<file_path> [<instr_index>] |
5512 |
|
|
5513 |
Where <db_dir> is the absolute path name of a directory (encapsulated |
Where <db_dir> is the absolute path name of a directory (encapsulated |
5514 |
into apostrophes) in the instruments database in which only the new |
into apostrophes) in the instruments database in which only the new |
5515 |
instruments (that are not already in the database) will be added, |
instruments (that are not already in the database) will be added, |
5516 |
<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 |
5517 |
file system (encapsulated into apostrophes). In case an instrument |
file system (encapsulated into apostrophes). In case an instrument |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 95] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5518 |
file is supplied, only the instruments in the specified file will be |
file is supplied, only the instruments in the specified file will be |
5519 |
added to the instruments database. If the optional <instr_index> |
added to the instruments database. If the optional <instr_index> |
5520 |
(the index of the instrument within the given file) is supplied too, |
(the index of the instrument within the given file) is supplied too, |
5535 |
Only the instruments in the specified directory will be added, |
Only the instruments in the specified directory will be added, |
5536 |
the instruments in the subdirectories will not be processed. |
the instruments in the subdirectories will not be processed. |
5537 |
|
|
5538 |
|
|
5539 |
|
|
5540 |
|
|
5541 |
|
|
5542 |
|
|
5543 |
|
Schoenebeck Expires May 5, 2010 [Page 99] |
5544 |
|
|
5545 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5546 |
|
|
5547 |
|
|
5548 |
"FLAT" - |
"FLAT" - |
5549 |
|
|
5550 |
All instruments will be processed, including those in the |
All instruments will be processed, including those in the |
5552 |
not be recreated in the instruments database. All instruments |
not be recreated in the instruments database. All instruments |
5553 |
will be added directly in the specified database directory. |
will be added directly in the specified database directory. |
5554 |
|
|
5555 |
|
If FILE_AS_DIR argument is supplied, all instruments in an instrument |
5556 |
|
file will be added to a separate directory in the instruments |
5557 |
|
database, which name will be the name of the instrument file with the |
5558 |
|
file extension stripped off. |
5559 |
|
|
5560 |
The difference between regular and NON_MODAL versions of the command |
The difference between regular and NON_MODAL versions of the command |
5561 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
5562 |
while NON_MODAL version returns immediately and a background process |
while NON_MODAL version returns immediately and a background process |
5577 |
|
|
5578 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
5579 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 96] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5580 |
if an invalid path is specified. |
if an invalid path is specified. |
5581 |
|
|
5582 |
Examples: |
Examples: |
5591 |
The front-end can remove a particular instrument from the instruments |
The front-end can remove a particular instrument from the instruments |
5592 |
database by sending the following command: |
database by sending the following command: |
5593 |
|
|
5594 |
|
|
5595 |
|
|
5596 |
|
|
5597 |
|
|
5598 |
|
|
5599 |
|
Schoenebeck Expires May 5, 2010 [Page 100] |
5600 |
|
|
5601 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5602 |
|
|
5603 |
|
|
5604 |
REMOVE DB_INSTRUMENT <instr_path> |
REMOVE DB_INSTRUMENT <instr_path> |
5605 |
|
|
5606 |
Where <instr_path> is the absolute path name (in the instruments |
Where <instr_path> is the absolute path name (in the instruments |
5636 |
|
|
5637 |
Possible Answers: |
Possible Answers: |
5638 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 97] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5639 |
The current number of instruments in the specified directory. |
The current number of instruments in the specified directory. |
5640 |
|
|
5641 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
5648 |
|
|
5649 |
S: "2" |
S: "2" |
5650 |
|
|
5651 |
|
|
5652 |
|
|
5653 |
|
|
5654 |
|
|
5655 |
|
Schoenebeck Expires May 5, 2010 [Page 101] |
5656 |
|
|
5657 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5658 |
|
|
5659 |
|
|
5660 |
6.8.14. Listing all instruments in specific directory |
6.8.14. Listing all instruments in specific directory |
5661 |
|
|
5662 |
The front-end can retrieve the current list of instruments in |
The front-end can retrieve the current list of instruments in |
5689 |
S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/ |
S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/ |
5690 |
Steinway D','/Piano Collection/Lite/Free Piano'" |
Steinway D','/Piano Collection/Lite/Free Piano'" |
5691 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 98] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5692 |
6.8.15. Getting instrument information |
6.8.15. Getting instrument information |
5693 |
|
|
5694 |
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 |
5705 |
answer line begins with the settings category name followed by a |
answer line begins with the settings category name followed by a |
5706 |
colon and then a space character <SP> and finally the info |
colon and then a space character <SP> and finally the info |
5707 |
character string to that setting category. At the moment the |
character string to that setting category. At the moment the |
5708 |
|
|
5709 |
|
|
5710 |
|
|
5711 |
|
Schoenebeck Expires May 5, 2010 [Page 102] |
5712 |
|
|
5713 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5714 |
|
|
5715 |
|
|
5716 |
following categories are defined: |
following categories are defined: |
5717 |
|
|
5718 |
|
|
5744 |
instruments database, represented in "YYYY-MM-DD HH:MM:SS" |
instruments database, represented in "YYYY-MM-DD HH:MM:SS" |
5745 |
format |
format |
5746 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 99] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5747 |
MODIFIED - |
MODIFIED - |
5748 |
|
|
5749 |
The date and time of the last modification of the |
The date and time of the last modification of the |
5760 |
either true or false, determines whether the instrument is a |
either true or false, determines whether the instrument is a |
5761 |
drumkit or a chromatic instrument |
drumkit or a chromatic instrument |
5762 |
|
|
5763 |
|
|
5764 |
|
|
5765 |
|
|
5766 |
|
|
5767 |
|
Schoenebeck Expires May 5, 2010 [Page 103] |
5768 |
|
|
5769 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5770 |
|
|
5771 |
|
|
5772 |
PRODUCT - |
PRODUCT - |
5773 |
|
|
5774 |
The product title of the instrument. Note that the |
The product title of the instrument. Note that the |
5800 |
|
|
5801 |
"FORMAT_VERSION: 2" |
"FORMAT_VERSION: 2" |
5802 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 100] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5803 |
"SIZE: 2050871870" |
"SIZE: 2050871870" |
5804 |
|
|
5805 |
"CREATED: 2007-02-05 10:23:12" |
"CREATED: 2007-02-05 10:23:12" |
5816 |
|
|
5817 |
"KEYWORDS: Bosendorfer" |
"KEYWORDS: Bosendorfer" |
5818 |
|
|
5819 |
|
|
5820 |
|
|
5821 |
|
|
5822 |
|
|
5823 |
|
Schoenebeck Expires May 5, 2010 [Page 104] |
5824 |
|
|
5825 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5826 |
|
|
5827 |
|
|
5828 |
"." |
"." |
5829 |
|
|
5830 |
6.8.16. Renaming an instrument |
6.8.16. Renaming an instrument |
5855 |
|
|
5856 |
S: "OK" |
S: "OK" |
5857 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 101] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5858 |
6.8.17. Moving an instrument |
6.8.17. Moving an instrument |
5859 |
|
|
5860 |
The front-end can move a specific instrument to another directory by |
The front-end can move a specific instrument to another directory by |
5871 |
|
|
5872 |
on success |
on success |
5873 |
|
|
5874 |
|
|
5875 |
|
|
5876 |
|
|
5877 |
|
|
5878 |
|
|
5879 |
|
Schoenebeck Expires May 5, 2010 [Page 105] |
5880 |
|
|
5881 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5882 |
|
|
5883 |
|
|
5884 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
5885 |
|
|
5886 |
in case the given instrument does not exists, or if an |
in case the given instrument does not exists, or if an |
5912 |
|
|
5913 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
5914 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 102] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5915 |
in case the given instrument does not exists, or if an |
in case the given instrument does not exists, or if an |
5916 |
instrument with name equal to the name of the specified |
instrument with name equal to the name of the specified |
5917 |
instrument already exists in the destination directory. |
instrument already exists in the destination directory. |
5928 |
The front-end can alter the description of a specific instrument by |
The front-end can alter the description of a specific instrument by |
5929 |
sending the following command: |
sending the following command: |
5930 |
|
|
5931 |
|
|
5932 |
|
|
5933 |
|
|
5934 |
|
|
5935 |
|
Schoenebeck Expires May 5, 2010 [Page 106] |
5936 |
|
|
5937 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5938 |
|
|
5939 |
|
|
5940 |
SET DB_INSTRUMENT DESCRIPTION <instr> <desc> |
SET DB_INSTRUMENT DESCRIPTION <instr> <desc> |
5941 |
|
|
5942 |
Where <instr> is the absolute path name of the instrument and <desc> |
Where <instr> is the absolute path name of the instrument and <desc> |
5969 |
FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list> |
FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list> |
5970 |
|
|
5971 |
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 August 17, 2008 [Page 103] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
5972 |
directory to search in. If NON_RECURSIVE is specified, the |
directory to search in. If NON_RECURSIVE is specified, the |
5973 |
directories located in subdirectories of the specified directory will |
directories located in subdirectories of the specified directory will |
5974 |
not be searched. <criteria-list> is a list of search criterias in |
not be searched. <criteria-list> is a list of search criterias in |
5984 |
|
|
5985 |
SIZE=[<min>]..[<max>] |
SIZE=[<min>]..[<max>] |
5986 |
|
|
5987 |
|
|
5988 |
|
|
5989 |
|
|
5990 |
|
|
5991 |
|
Schoenebeck Expires May 5, 2010 [Page 107] |
5992 |
|
|
5993 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
5994 |
|
|
5995 |
|
|
5996 |
Restricts the search to instruments, which size is in the |
Restricts the search to instruments, which size is in the |
5997 |
specified range. If <min> is omitted, the search results are |
specified range. If <min> is omitted, the search results are |
5998 |
restricted to instruments with size less then or equal to <max>. |
restricted to instruments with size less then or equal to <max>. |
6027 |
|
|
6028 |
PRODUCT='<search-string>' |
PRODUCT='<search-string>' |
6029 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 104] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
6030 |
Restricts the search to instruments with product info that |
Restricts the search to instruments with product info that |
6031 |
satisfies the supplied search string (encapsulated into |
satisfies the supplied search string (encapsulated into |
6032 |
apostrophes, supporting escape sequences as described in chapter |
apostrophes, supporting escape sequences as described in chapter |
6041 |
|
|
6042 |
KEYWORDS='<search-string>' |
KEYWORDS='<search-string>' |
6043 |
|
|
6044 |
|
|
6045 |
|
|
6046 |
|
|
6047 |
|
Schoenebeck Expires May 5, 2010 [Page 108] |
6048 |
|
|
6049 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6050 |
|
|
6051 |
|
|
6052 |
Restricts the search to instruments with keyword list that |
Restricts the search to instruments with keyword list that |
6053 |
satisfies the supplied search string (encapsulated into |
satisfies the supplied search string (encapsulated into |
6054 |
apostrophes, supporting escape sequences as described in chapter |
apostrophes, supporting escape sequences as described in chapter |
6083 |
C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+ |
C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+ |
6084 |
290'" |
290'" |
6085 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 105] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
6086 |
S: "'/Piano Collection/Bosendorfer 290'" |
S: "'/Piano Collection/Bosendorfer 290'" |
6087 |
|
|
6088 |
C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 |
C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 |
6096 |
The front-end can ask for the current status of a particular database |
The front-end can ask for the current status of a particular database |
6097 |
instruments job by sending the following command: |
instruments job by sending the following command: |
6098 |
|
|
6099 |
|
|
6100 |
|
|
6101 |
|
|
6102 |
|
|
6103 |
|
Schoenebeck Expires May 5, 2010 [Page 109] |
6104 |
|
|
6105 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6106 |
|
|
6107 |
|
|
6108 |
GET DB_INSTRUMENTS_JOB INFO <job-id> |
GET DB_INSTRUMENTS_JOB INFO <job-id> |
6109 |
|
|
6110 |
Where <job-id> should be replaced by the numerical ID of the job the |
Where <job-id> should be replaced by the numerical ID of the job the |
6141 |
|
|
6142 |
The mentioned fields above don't have to be in particular order. |
The mentioned fields above don't have to be in particular order. |
6143 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 106] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
6144 |
Example: |
Example: |
6145 |
|
|
6146 |
C: "GET DB_INSTRUMENTS_JOB INFO 2" |
C: "GET DB_INSTRUMENTS_JOB INFO 2" |
6153 |
|
|
6154 |
"STATUS: 42" |
"STATUS: 42" |
6155 |
|
|
6156 |
|
|
6157 |
|
|
6158 |
|
|
6159 |
|
Schoenebeck Expires May 5, 2010 [Page 110] |
6160 |
|
|
6161 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6162 |
|
|
6163 |
|
|
6164 |
"." |
"." |
6165 |
|
|
6166 |
6.8.22. Formatting the instruments database |
6.8.22. Formatting the instruments database |
6181 |
|
|
6182 |
If the formatting of the instruments database failed. |
If the formatting of the instruments database failed. |
6183 |
|
|
6184 |
|
6.8.23. Checking for lost instrument files |
6185 |
|
|
6186 |
|
The front-end can retrieve the list of all instrument files in the |
6187 |
|
instruments database that don't exist in the filesystem by sending |
6188 |
|
the following command: |
6189 |
|
|
6190 |
|
FIND LOST DB_INSTRUMENT_FILES |
6191 |
|
|
6192 |
|
Possible Answers: |
6193 |
|
|
6194 |
|
A comma separated list with the absolute path names (encapsulated |
6195 |
|
into apostrophes) of all lost instrument files. |
6196 |
|
|
6197 |
|
"ERR:<error-code>:<error-message>" - |
6198 |
|
|
6199 |
|
in case it failed, providing an appropriate error code and |
6200 |
|
error message. |
6201 |
|
|
6202 |
|
Example: |
6203 |
|
|
6204 |
|
C: "FIND LOST DB_INSTRUMENT_FILES" |
6205 |
|
|
6206 |
|
S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free |
6207 |
|
Piano.gig'" |
6208 |
|
|
6209 |
|
|
6210 |
|
|
6211 |
|
|
6212 |
|
|
6213 |
|
|
6214 |
|
|
6215 |
|
Schoenebeck Expires May 5, 2010 [Page 111] |
6216 |
|
|
6217 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6218 |
|
|
6219 |
|
|
6220 |
|
6.8.24. Replacing an instrument file |
6221 |
|
|
6222 |
|
The front-end can substitute all occurrences of an instrument file in |
6223 |
|
the instruments database with a new one by sending the following |
6224 |
|
command: |
6225 |
|
|
6226 |
|
SET DB_INSTRUMENT FILE_PATH <old_path> <new_path> |
6227 |
|
|
6228 |
|
Where <old_path> is the absolute path name of the instrument file to |
6229 |
|
substitute with <new_path>. |
6230 |
|
|
6231 |
|
Possible Answers: |
6232 |
|
|
6233 |
|
"OK" - |
6234 |
|
|
6235 |
|
on success |
6236 |
|
|
6237 |
|
"ERR:<error-code>:<error-message>" - |
6238 |
|
|
6239 |
|
in case it failed, providing an appropriate error code and |
6240 |
|
error message. |
6241 |
|
|
6242 |
|
Example: |
6243 |
|
|
6244 |
|
C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' |
6245 |
|
'/gigs/pianos/Bosendorfer 290.gig'" |
6246 |
|
|
6247 |
|
S: "OK" |
6248 |
|
|
6249 |
6.9. Editing Instruments |
6.9. Editing Instruments |
6250 |
|
|
6251 |
The sampler allows to edit instruments while playing with the sampler |
The sampler allows to edit instruments while playing with the sampler |
6265 |
|
|
6266 |
|
|
6267 |
|
|
6268 |
Schoenebeck Expires August 17, 2008 [Page 107] |
|
6269 |
|
|
6270 |
|
|
6271 |
|
Schoenebeck Expires May 5, 2010 [Page 112] |
6272 |
|
|
6273 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
6274 |
|
|
6275 |
|
|
6276 |
EDIT CHANNEL INSTRUMENT <sampler-channel> |
EDIT CHANNEL INSTRUMENT <sampler-channel> |
6324 |
|
|
6325 |
|
|
6326 |
|
|
6327 |
Schoenebeck Expires August 17, 2008 [Page 108] |
Schoenebeck Expires May 5, 2010 [Page 113] |
6328 |
|
|
6329 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
6330 |
|
|
6331 |
|
|
6332 |
6.10.1. Retrieving amount of instruments of a file |
6.10.1. Retrieving amount of instruments of a file |
6380 |
|
|
6381 |
|
|
6382 |
|
|
6383 |
Schoenebeck Expires August 17, 2008 [Page 109] |
Schoenebeck Expires May 5, 2010 [Page 114] |
6384 |
|
|
6385 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
6386 |
|
|
6387 |
|
|
6388 |
On success, the sampler will answer by returning a comma separated |
On success, the sampler will answer by returning a comma separated |
6436 |
|
|
6437 |
|
|
6438 |
|
|
6439 |
Schoenebeck Expires August 17, 2008 [Page 110] |
Schoenebeck Expires May 5, 2010 [Page 115] |
6440 |
|
|
6441 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
6442 |
|
|
6443 |
|
|
6444 |
name of the sampler format of the given instrument |
name of the sampler format of the given instrument |
6456 |
|
|
6457 |
artists / sample library vendor of the instrument |
artists / sample library vendor of the instrument |
6458 |
|
|
6459 |
|
KEY_BINDINGS - |
6460 |
|
|
6461 |
|
comma separated list of integer values representing the |
6462 |
|
instrument's key mapping in the range between 0 .. 127, |
6463 |
|
reflecting the analog meaning of the MIDI specification. |
6464 |
|
|
6465 |
|
KEYSWITCH_BINDINGS - |
6466 |
|
|
6467 |
|
comma separated list of integer values representing the |
6468 |
|
instrument's keyswitch mapping in the range between 0 .. |
6469 |
|
127, reflecting the analog meaning of the MIDI |
6470 |
|
specification. |
6471 |
|
|
6472 |
The mentioned fields above don't have to be in particular order. |
The mentioned fields above don't have to be in particular order. |
6473 |
|
|
6474 |
Example: |
Example: |
6492 |
|
|
6493 |
|
|
6494 |
|
|
6495 |
|
Schoenebeck Expires May 5, 2010 [Page 116] |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 111] |
|
6496 |
|
|
6497 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
6498 |
|
|
6499 |
|
|
6500 |
7. Command Syntax |
7. Command Syntax |
6548 |
|
|
6549 |
|
|
6550 |
|
|
6551 |
Schoenebeck Expires August 17, 2008 [Page 112] |
Schoenebeck Expires May 5, 2010 [Page 117] |
6552 |
|
|
6553 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
6554 |
|
|
6555 |
|
|
6556 |
/ LIST SP list_instruction |
/ LIST SP list_instruction |
6579 |
|
|
6580 |
/ FORMAT SP format_instruction |
/ FORMAT SP format_instruction |
6581 |
|
|
6582 |
|
/ SEND SP send_instruction |
6583 |
|
|
6584 |
/ RESET |
/ RESET |
6585 |
|
|
6586 |
/ QUIT |
/ QUIT |
6593 |
|
|
6594 |
/ 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 |
6595 |
|
|
6596 |
|
/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP |
6597 |
|
db_path SP filename |
6598 |
|
|
6599 |
/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
6600 |
|
|
6601 |
/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP |
6602 |
|
filename |
6603 |
|
|
|
/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP |
|
|
instrument_index |
|
6604 |
|
|
|
/ DB_INSTRUMENTS SP db_path SP filename |
|
6605 |
|
|
6606 |
|
|
6607 |
|
Schoenebeck Expires May 5, 2010 [Page 118] |
6608 |
|
|
6609 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6610 |
|
|
6611 |
|
|
6612 |
|
/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
6613 |
|
|
6614 |
Schoenebeck Expires August 17, 2008 [Page 113] |
/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP |
6615 |
|
instrument_index |
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
6616 |
|
|
6617 |
|
/ DB_INSTRUMENTS SP db_path SP filename |
6618 |
|
|
6619 |
/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
6620 |
|
|
6636 |
|
|
6637 |
/ CHANNEL_MIDI |
/ CHANNEL_MIDI |
6638 |
|
|
6639 |
|
/ DEVICE_MIDI |
6640 |
|
|
6641 |
/ VOICE_COUNT |
/ VOICE_COUNT |
6642 |
|
|
6643 |
/ STREAM_COUNT |
/ STREAM_COUNT |
6656 |
|
|
6657 |
/ MIDI_INSTRUMENT_COUNT |
/ MIDI_INSTRUMENT_COUNT |
6658 |
|
|
|
/ MIDI_INSTRUMENT_INFO |
|
6659 |
|
|
|
/ DB_INSTRUMENT_DIRECTORY_COUNT |
|
6660 |
|
|
|
/ DB_INSTRUMENT_DIRECTORY_INFO |
|
6661 |
|
|
|
/ DB_INSTRUMENT_COUNT |
|
6662 |
|
|
6663 |
/ DB_INSTRUMENT_INFO |
Schoenebeck Expires May 5, 2010 [Page 119] |
6664 |
|
|
6665 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6666 |
|
|
6667 |
|
|
6668 |
|
/ MIDI_INSTRUMENT_INFO |
6669 |
|
|
6670 |
|
/ DB_INSTRUMENT_DIRECTORY_COUNT |
6671 |
|
|
6672 |
Schoenebeck Expires August 17, 2008 [Page 114] |
/ DB_INSTRUMENT_DIRECTORY_INFO |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
6673 |
|
|
6674 |
|
/ DB_INSTRUMENT_COUNT |
6675 |
|
|
6676 |
|
/ DB_INSTRUMENT_INFO |
6677 |
|
|
6678 |
/ DB_INSTRUMENTS_JOB_INFO |
/ DB_INSTRUMENTS_JOB_INFO |
6679 |
|
|
6699 |
|
|
6700 |
/ CHANNEL_MIDI |
/ CHANNEL_MIDI |
6701 |
|
|
6702 |
|
/ DEVICE_MIDI |
6703 |
|
|
6704 |
/ VOICE_COUNT |
/ VOICE_COUNT |
6705 |
|
|
6706 |
/ STREAM_COUNT |
/ STREAM_COUNT |
6713 |
|
|
6714 |
/ FX_SEND_INFO |
/ FX_SEND_INFO |
6715 |
|
|
6716 |
|
|
6717 |
|
|
6718 |
|
|
6719 |
|
Schoenebeck Expires May 5, 2010 [Page 120] |
6720 |
|
|
6721 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6722 |
|
|
6723 |
|
|
6724 |
/ MIDI_INSTRUMENT_MAP_COUNT |
/ MIDI_INSTRUMENT_MAP_COUNT |
6725 |
|
|
6726 |
/ MIDI_INSTRUMENT_MAP_INFO |
/ MIDI_INSTRUMENT_MAP_INFO |
6733 |
|
|
6734 |
/ DB_INSTRUMENT_DIRECTORY_INFO |
/ DB_INSTRUMENT_DIRECTORY_INFO |
6735 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 115] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
6736 |
/ DB_INSTRUMENT_COUNT |
/ DB_INSTRUMENT_COUNT |
6737 |
|
|
6738 |
/ DB_INSTRUMENT_INFO |
/ DB_INSTRUMENT_INFO |
6770 |
|
|
6771 |
remove_instruction = |
remove_instruction = |
6772 |
|
|
6773 |
|
|
6774 |
|
|
6775 |
|
Schoenebeck Expires May 5, 2010 [Page 121] |
6776 |
|
|
6777 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6778 |
|
|
6779 |
|
|
6780 |
CHANNEL SP sampler_channel |
CHANNEL SP sampler_channel |
6781 |
|
|
6782 |
/ MIDI_INSTRUMENT_MAP SP midi_map |
/ MIDI_INSTRUMENT_MAP SP midi_map |
6787 |
|
|
6788 |
/ DB_INSTRUMENT_DIRECTORY SP db_path |
/ DB_INSTRUMENT_DIRECTORY SP db_path |
6789 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 116] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
6790 |
/ DB_INSTRUMENT SP db_path |
/ DB_INSTRUMENT SP db_path |
6791 |
|
|
6792 |
get_instruction = |
get_instruction = |
6825 |
|
|
6826 |
/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number |
/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number |
6827 |
|
|
|
/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP |
|
|
string |
|
6828 |
|
|
|
/ CHANNELS |
|
6829 |
|
|
|
/ CHANNEL SP INFO SP sampler_channel |
|
|
|
|
|
/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel |
|
6830 |
|
|
6831 |
|
Schoenebeck Expires May 5, 2010 [Page 122] |
6832 |
|
|
6833 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6834 |
|
|
6835 |
|
|
6836 |
|
/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP |
6837 |
|
string |
6838 |
|
|
6839 |
|
/ CHANNELS |
6840 |
|
|
6841 |
Schoenebeck Expires August 17, 2008 [Page 117] |
/ CHANNEL SP INFO SP sampler_channel |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
6842 |
|
|
6843 |
|
/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel |
6844 |
|
|
6845 |
/ CHANNEL SP STREAM_COUNT SP sampler_channel |
/ CHANNEL SP STREAM_COUNT SP sampler_channel |
6846 |
|
|
6880 |
|
|
6881 |
/ DB_INSTRUMENTS SP db_path |
/ DB_INSTRUMENTS SP db_path |
6882 |
|
|
|
/ DB_INSTRUMENT SP INFO SP db_path |
|
6883 |
|
|
|
/ DB_INSTRUMENTS_JOB SP INFO SP number |
|
6884 |
|
|
|
/ VOLUME |
|
6885 |
|
|
|
/ FILE SP INSTRUMENTS SP filename |
|
6886 |
|
|
6887 |
/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
Schoenebeck Expires May 5, 2010 [Page 123] |
6888 |
|
|
6889 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6890 |
|
|
6891 |
|
|
6892 |
|
/ DB_INSTRUMENT SP INFO SP db_path |
6893 |
|
|
6894 |
|
/ DB_INSTRUMENTS_JOB SP INFO SP number |
6895 |
|
|
6896 |
Schoenebeck Expires August 17, 2008 [Page 118] |
/ VOLUME |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
6897 |
|
|
6898 |
|
/ VOICES |
6899 |
|
|
6900 |
|
/ STREAMS |
6901 |
|
|
6902 |
|
/ FILE SP INSTRUMENTS SP filename |
6903 |
|
|
6904 |
|
/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6905 |
|
|
6906 |
set_instruction = |
set_instruction = |
6907 |
|
|
6936 |
|
|
6937 |
/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
6938 |
|
|
6939 |
|
|
6940 |
|
|
6941 |
|
|
6942 |
|
|
6943 |
|
Schoenebeck Expires May 5, 2010 [Page 124] |
6944 |
|
|
6945 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
6946 |
|
|
6947 |
|
|
6948 |
/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP |
/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP |
6949 |
stringval_escaped |
stringval_escaped |
6950 |
|
|
6952 |
|
|
6953 |
/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
6954 |
|
|
6955 |
|
/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
6956 |
|
|
6957 |
/ ECHO SP boolean |
/ ECHO SP boolean |
6958 |
|
|
6959 |
/ VOLUME SP volume_value |
/ VOLUME SP volume_value |
6960 |
|
|
6961 |
create_instruction = |
/ VOICES SP number |
|
|
|
|
AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
|
|
|
|
|
|
|
6962 |
|
|
6963 |
|
/ STREAMS SP number |
6964 |
|
|
6965 |
Schoenebeck Expires August 17, 2008 [Page 119] |
create_instruction = |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
6966 |
|
|
6967 |
|
AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
6968 |
|
|
6969 |
/ AUDIO_OUTPUT_DEVICE SP string |
/ AUDIO_OUTPUT_DEVICE SP string |
6970 |
|
|
6992 |
|
|
6993 |
/ DB_INSTRUMENTS SP db_path SP query_val_list |
/ DB_INSTRUMENTS SP db_path SP query_val_list |
6994 |
|
|
6995 |
|
|
6996 |
|
|
6997 |
|
|
6998 |
|
|
6999 |
|
Schoenebeck Expires May 5, 2010 [Page 125] |
7000 |
|
|
7001 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7002 |
|
|
7003 |
|
|
7004 |
/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP |
/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP |
7005 |
query_val_list |
query_val_list |
7006 |
|
|
7007 |
/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
7008 |
|
|
7009 |
|
/ LOST SP DB_INSTRUMENT_FILES |
7010 |
|
|
7011 |
move_instruction = |
move_instruction = |
7012 |
|
|
7013 |
DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
7024 |
|
|
7025 |
AUDIO_OUTPUT_DEVICE SP number |
AUDIO_OUTPUT_DEVICE SP number |
7026 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 120] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7027 |
/ MIDI_INPUT_DEVICE SP number |
/ MIDI_INPUT_DEVICE SP number |
7028 |
|
|
7029 |
/ FX_SEND SP sampler_channel SP fx_send_id |
/ FX_SEND SP sampler_channel SP fx_send_id |
7048 |
|
|
7049 |
/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index |
/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index |
7050 |
|
|
7051 |
|
|
7052 |
|
|
7053 |
|
|
7054 |
|
|
7055 |
|
Schoenebeck Expires May 5, 2010 [Page 126] |
7056 |
|
|
7057 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7058 |
|
|
7059 |
|
|
7060 |
/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index |
/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index |
7061 |
|
|
7062 |
/ MIDI_INPUT_CHANNEL SP sampler_channel SP |
/ MIDI_INPUT_CHANNEL SP sampler_channel SP |
7082 |
|
|
7083 |
format_instruction = |
format_instruction = |
7084 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 121] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7085 |
INSTRUMENTS_DB |
INSTRUMENTS_DB |
7086 |
|
|
7087 |
modal_arg = |
modal_arg = |
7104 |
|
|
7105 |
list_instruction = |
list_instruction = |
7106 |
|
|
7107 |
|
|
7108 |
|
|
7109 |
|
|
7110 |
|
|
7111 |
|
Schoenebeck Expires May 5, 2010 [Page 127] |
7112 |
|
|
7113 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7114 |
|
|
7115 |
|
|
7116 |
AUDIO_OUTPUT_DEVICES |
AUDIO_OUTPUT_DEVICES |
7117 |
|
|
7118 |
/ MIDI_INPUT_DEVICES |
/ MIDI_INPUT_DEVICES |
7139 |
|
|
7140 |
/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
7141 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 122] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7142 |
/ DB_INSTRUMENTS SP db_path |
/ DB_INSTRUMENTS SP db_path |
7143 |
|
|
7144 |
/ FILE SP INSTRUMENTS SP filename |
/ FILE SP INSTRUMENTS SP filename |
7145 |
|
|
7146 |
|
send_instruction = |
7147 |
|
|
7148 |
|
CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP |
7149 |
|
number |
7150 |
|
|
7151 |
load_instr_args = |
load_instr_args = |
7152 |
|
|
7153 |
filename SP instrument_index SP sampler_channel |
filename SP instrument_index SP sampler_channel |
7160 |
|
|
7161 |
instr_load_mode = |
instr_load_mode = |
7162 |
|
|
7163 |
|
|
7164 |
|
|
7165 |
|
|
7166 |
|
|
7167 |
|
Schoenebeck Expires May 5, 2010 [Page 128] |
7168 |
|
|
7169 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7170 |
|
|
7171 |
|
|
7172 |
ON_DEMAND |
ON_DEMAND |
7173 |
|
|
7174 |
/ ON_DEMAND_HOLD |
/ ON_DEMAND_HOLD |
7201 |
|
|
7202 |
string |
string |
7203 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 123] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7204 |
midi_map = |
midi_map = |
7205 |
|
|
7206 |
number |
number |
7217 |
|
|
7218 |
number |
number |
7219 |
|
|
7220 |
|
|
7221 |
|
|
7222 |
|
|
7223 |
|
Schoenebeck Expires May 5, 2010 [Page 129] |
7224 |
|
|
7225 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7226 |
|
|
7227 |
|
|
7228 |
volume_value = |
volume_value = |
7229 |
|
|
7230 |
dotnum |
dotnum |
7257 |
|
|
7258 |
map_name = |
map_name = |
7259 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 124] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7260 |
stringval_escaped |
stringval_escaped |
7261 |
|
|
7262 |
entry_name = |
entry_name = |
7273 |
|
|
7274 |
/ param_val_list','param_val |
/ param_val_list','param_val |
7275 |
|
|
7276 |
|
|
7277 |
|
|
7278 |
|
|
7279 |
|
Schoenebeck Expires May 5, 2010 [Page 130] |
7280 |
|
|
7281 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7282 |
|
|
7283 |
|
|
7284 |
param_val = |
param_val = |
7285 |
|
|
7286 |
string |
string |
7311 |
|
|
7312 |
/ FLAT |
/ FLAT |
7313 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 125] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7314 |
7.1. Character Set and Escape Sequences |
7.1. Character Set and Escape Sequences |
7315 |
|
|
7316 |
Older versions of this protocol up to and including v1.1 only |
Older versions of this protocol up to and including v1.1 only |
7321 |
certain, explicitly declared parts of the protocol. The supported |
certain, explicitly declared parts of the protocol. The supported |
7322 |
escape sequences are defined as follows: |
escape sequences are defined as follows: |
7323 |
|
|
7324 |
|
|
7325 |
|
|
7326 |
|
|
7327 |
|
|
7328 |
|
|
7329 |
|
|
7330 |
|
|
7331 |
|
|
7332 |
|
|
7333 |
|
|
7334 |
|
|
7335 |
|
Schoenebeck Expires May 5, 2010 [Page 131] |
7336 |
|
|
7337 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7338 |
|
|
7339 |
|
|
7340 |
+------------------------+------------------------------------------+ |
+------------------------+------------------------------------------+ |
7341 |
| ASCII Character | Translated into (Name) | |
| ASCII Character | Translated into (Name) | |
7342 |
| Sequence | | |
| Sequence | | |
7376 |
filename / path based arguments and / or may contain a filename / |
filename / path based arguments and / or may contain a filename / |
7377 |
path with escape sequences in their response: |
path with escape sequences in their response: |
7378 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 126] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7379 |
"LOAD INSTRUMENT" (Section 6.4.1) |
"LOAD INSTRUMENT" (Section 6.4.1) |
7380 |
|
|
7381 |
"GET CHANNEL INFO" (Section 6.4.10) |
"GET CHANNEL INFO" (Section 6.4.10) |
7384 |
|
|
7385 |
"GET MIDI_INSTRUMENT INFO" (Section 6.7.11) |
"GET MIDI_INSTRUMENT INFO" (Section 6.7.11) |
7386 |
|
|
7387 |
|
|
7388 |
|
|
7389 |
|
|
7390 |
|
|
7391 |
|
Schoenebeck Expires May 5, 2010 [Page 132] |
7392 |
|
|
7393 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7394 |
|
|
7395 |
|
|
7396 |
"ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1) |
"ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1) |
7397 |
|
|
7398 |
"ADD DB_INSTRUMENTS" (Section 6.8.11) |
"ADD DB_INSTRUMENTS" (Section 6.8.11) |
7433 |
|
|
7434 |
"COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8) |
"COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8) |
7435 |
|
|
7436 |
|
"FIND LOST DB_INSTRUMENT_FILES" (Section 6.8.23) |
7437 |
|
|
7438 |
|
"SET DB_INSTRUMENT FILE_PATH" (Section 6.8.24) |
7439 |
|
|
7440 |
|
"GET FILE INSTRUMENTS" (Section 6.10.1) |
7441 |
|
|
7442 |
Schoenebeck Expires August 17, 2008 [Page 127] |
"LIST FILE INSTRUMENTS" (Section 6.10.2) |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
7443 |
|
|
7444 |
|
|
|
"GET FILE INSTRUMENTS" (Section 6.10.1) |
|
7445 |
|
|
7446 |
"LIST FILE INSTRUMENTS" (Section 6.10.2) |
|
7447 |
|
Schoenebeck Expires May 5, 2010 [Page 133] |
7448 |
|
|
7449 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7450 |
|
|
7451 |
|
|
7452 |
"GET FILE INSTRUMENT INFO" (Section 6.10.3) |
"GET FILE INSTRUMENT INFO" (Section 6.10.3) |
7453 |
|
|
7492 |
|
|
7493 |
"SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6) |
"SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6) |
7494 |
|
|
7495 |
|
"GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5) |
7496 |
|
|
7497 |
|
"SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6) |
7498 |
|
|
7499 |
|
|
7500 |
|
|
|
Schoenebeck Expires August 17, 2008 [Page 128] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
7501 |
|
|
7502 |
|
|
7503 |
"GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5) |
Schoenebeck Expires May 5, 2010 [Page 134] |
7504 |
|
|
7505 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7506 |
|
|
|
"SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6) |
|
7507 |
|
|
7508 |
"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9) |
"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9) |
7509 |
|
|
7552 |
|
|
7553 |
|
|
7554 |
|
|
7555 |
Schoenebeck Expires August 17, 2008 [Page 129] |
|
7556 |
|
|
7557 |
|
|
7558 |
|
|
7559 |
|
Schoenebeck Expires May 5, 2010 [Page 135] |
7560 |
|
|
7561 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
7562 |
|
|
7563 |
|
|
7564 |
8. Events |
8. Events |
7612 |
|
|
7613 |
|
|
7614 |
|
|
7615 |
Schoenebeck Expires August 17, 2008 [Page 130] |
Schoenebeck Expires May 5, 2010 [Page 136] |
7616 |
|
|
7617 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
7618 |
|
|
7619 |
|
|
7620 |
"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>" |
"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>" |
7668 |
|
|
7669 |
|
|
7670 |
|
|
7671 |
Schoenebeck Expires August 17, 2008 [Page 131] |
Schoenebeck Expires May 5, 2010 [Page 137] |
7672 |
|
|
7673 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
7674 |
|
|
7675 |
|
|
7676 |
"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>" |
"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>" |
7688 |
safeness of the backend's MIDI and audio thread unaffected by this |
safeness of the backend's MIDI and audio thread unaffected by this |
7689 |
feature. |
feature. |
7690 |
|
|
7691 |
8.7. Number of active voices changed |
8.7. MIDI data on a MIDI input device arrived |
7692 |
|
|
7693 |
|
Client may want to be notified when MIDI data arrive on MIDI input |
7694 |
|
devices by issuing the following command: |
7695 |
|
|
7696 |
|
SUBSCRIBE DEVICE_MIDI |
7697 |
|
|
7698 |
|
Server will start sending one of the the following notification |
7699 |
|
messages: |
7700 |
|
|
7701 |
|
"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> |
7702 |
|
<velocity>" |
7703 |
|
|
7704 |
|
"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> |
7705 |
|
<velocity>" |
7706 |
|
|
7707 |
|
where <device-id> <port-id> will be replaced by the IDs of the |
7708 |
|
respective MIDI input device and the device's MIDI port where the |
7709 |
|
MIDI data arrived. <note> and <velocity> are integer values in the |
7710 |
|
range between 0 .. 127, reflecting the analog meaning of the MIDI |
7711 |
|
specification. |
7712 |
|
|
7713 |
|
CAUTION: no guarantee whatsoever will be made that MIDI events are |
7714 |
|
actually all delivered by this mechanism! With other words: events |
7715 |
|
could be lost at any time! This restriction was made to keep the RT- |
7716 |
|
safeness of the backend's MIDI and audio thread unaffected by this |
7717 |
|
feature. |
7718 |
|
|
7719 |
|
8.8. Number of active voices changed |
7720 |
|
|
7721 |
Client may want to be notified when the number of voices on the back- |
Client may want to be notified when the number of voices on the back- |
7722 |
end changes by issuing the following command: |
end changes by issuing the following command: |
7723 |
|
|
7724 |
|
|
7725 |
|
|
7726 |
|
|
7727 |
|
Schoenebeck Expires May 5, 2010 [Page 138] |
7728 |
|
|
7729 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7730 |
|
|
7731 |
|
|
7732 |
SUBSCRIBE VOICE_COUNT |
SUBSCRIBE VOICE_COUNT |
7733 |
|
|
7734 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
7739 |
voice count change occurred and <voices> by the new number of active |
voice count change occurred and <voices> by the new number of active |
7740 |
voices on that channel. |
voices on that channel. |
7741 |
|
|
7742 |
8.8. Number of active disk streams changed |
8.9. Number of active disk streams changed |
7743 |
|
|
7744 |
Client may want to be notified when the number of streams on the |
Client may want to be notified when the number of streams on the |
7745 |
back-end changes by issuing the following command: SUBSCRIBE |
back-end changes by issuing the following command: SUBSCRIBE |
7755 |
stream count change occurred and <streams> by the new number of |
stream count change occurred and <streams> by the new number of |
7756 |
active disk streams on that channel. |
active disk streams on that channel. |
7757 |
|
|
7758 |
|
8.10. Disk stream buffer fill state changed |
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 132] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
|
8.9. Disk stream buffer fill state changed |
|
7759 |
|
|
7760 |
Client may want to be notified when the buffer fill state of a disk |
Client may want to be notified when the buffer fill state of a disk |
7761 |
stream on the back-end changes by issuing the following command: |
stream on the back-end changes by issuing the following command: |
7772 |
Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" |
Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" |
7773 |
(Section 6.4.13) command was issued on this channel. |
(Section 6.4.13) command was issued on this channel. |
7774 |
|
|
7775 |
8.10. Channel information changed |
8.11. Channel information changed |
7776 |
|
|
7777 |
Client may want to be notified when changes were made to sampler |
Client may want to be notified when changes were made to sampler |
7778 |
channels on the back-end by issuing the following command: |
channels on the back-end by issuing the following command: |
7779 |
|
|
7780 |
|
|
7781 |
|
|
7782 |
|
|
7783 |
|
Schoenebeck Expires May 5, 2010 [Page 139] |
7784 |
|
|
7785 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7786 |
|
|
7787 |
|
|
7788 |
SUBSCRIBE CHANNEL_INFO |
SUBSCRIBE CHANNEL_INFO |
7789 |
|
|
7790 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
7798 |
rather than real time events happening on the server, it is believed |
rather than real time events happening on the server, it is believed |
7799 |
that an empty notification message is sufficient here. |
that an empty notification message is sufficient here. |
7800 |
|
|
7801 |
8.11. Number of effect sends changed |
8.12. Number of effect sends changed |
7802 |
|
|
7803 |
Client may want to be notified when the number of effect sends on a |
Client may want to be notified when the number of effect sends on a |
7804 |
particular sampler channel is changed by issuing the following |
particular sampler channel is changed by issuing the following |
7811 |
"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>" |
"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>" |
7812 |
|
|
7813 |
where <channel-id> will be replaced by the numerical ID of the |
where <channel-id> will be replaced by the numerical ID of the |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 133] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7814 |
sampler channel, on which the effect sends number is changed and <fx- |
sampler channel, on which the effect sends number is changed and <fx- |
7815 |
sends> will be replaced by the new number of effect sends on that |
sends> will be replaced by the new number of effect sends on that |
7816 |
channel. |
channel. |
7817 |
|
|
7818 |
8.12. Effect send information changed |
8.13. Effect send information changed |
7819 |
|
|
7820 |
Client may want to be notified when changes were made to effect sends |
Client may want to be notified when changes were made to effect sends |
7821 |
on a a particular sampler channel by issuing the following command: |
on a a particular sampler channel by issuing the following command: |
7831 |
send-id> will be replaced by the numerical ID of the changed effect |
send-id> will be replaced by the numerical ID of the changed effect |
7832 |
send. |
send. |
7833 |
|
|
7834 |
8.13. Total number of active voices changed |
|
7835 |
|
|
7836 |
|
|
7837 |
|
|
7838 |
|
|
7839 |
|
Schoenebeck Expires May 5, 2010 [Page 140] |
7840 |
|
|
7841 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7842 |
|
|
7843 |
|
|
7844 |
|
8.14. Total number of active voices changed |
7845 |
|
|
7846 |
Client may want to be notified when the total number of voices on the |
Client may want to be notified when the total number of voices on the |
7847 |
back-end changes by issuing the following command: |
back-end changes by issuing the following command: |
7855 |
where <voices> will be replaced by the new number of all currently |
where <voices> will be replaced by the new number of all currently |
7856 |
active voices. |
active voices. |
7857 |
|
|
7858 |
8.14. Total number of active disk streams changed |
8.15. Total number of active disk streams changed |
7859 |
|
|
7860 |
Client may want to be notified when the total number of disk streams |
Client may want to be notified when the total number of disk streams |
7861 |
on the back-end changes by issuing the following command: |
on the back-end changes by issuing the following command: |
7869 |
where <streams> will be replaced by the new number of all currently |
where <streams> will be replaced by the new number of all currently |
7870 |
active disk streams. |
active disk streams. |
7871 |
|
|
7872 |
|
8.16. Number of MIDI instrument maps changed |
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 134] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
|
8.15. Number of MIDI instrument maps changed |
|
7873 |
|
|
7874 |
Client may want to be notified when the number of MIDI instrument |
Client may want to be notified when the number of MIDI instrument |
7875 |
maps on the back-end changes by issuing the following command: |
maps on the back-end changes by issuing the following command: |
7883 |
where <maps> will be replaced by the new number of MIDI instrument |
where <maps> will be replaced by the new number of MIDI instrument |
7884 |
maps. |
maps. |
7885 |
|
|
7886 |
8.16. MIDI instrument map information changed |
8.17. MIDI instrument map information changed |
7887 |
|
|
7888 |
Client may want to be notified when changes were made to MIDI |
Client may want to be notified when changes were made to MIDI |
7889 |
instrument maps on the back-end by issuing the following command: |
instrument maps on the back-end by issuing the following command: |
7890 |
|
|
7891 |
|
|
7892 |
|
|
7893 |
|
|
7894 |
|
|
7895 |
|
Schoenebeck Expires May 5, 2010 [Page 141] |
7896 |
|
|
7897 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7898 |
|
|
7899 |
|
|
7900 |
SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO |
SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO |
7901 |
|
|
7902 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
7911 |
happening on the server, it is believed that an empty notification |
happening on the server, it is believed that an empty notification |
7912 |
message is sufficient here. |
message is sufficient here. |
7913 |
|
|
7914 |
8.17. Number of MIDI instruments changed |
8.18. Number of MIDI instruments changed |
7915 |
|
|
7916 |
Client may want to be notified when the number of MIDI instrument |
Client may want to be notified when the number of MIDI instrument |
7917 |
maps on the back-end changes by issuing the following command: |
maps on the back-end changes by issuing the following command: |
7926 |
which the nuber of instruments has changed and <instruments> will be |
which the nuber of instruments has changed and <instruments> will be |
7927 |
replaced by the new number of MIDI instruments in the specified map. |
replaced by the new number of MIDI instruments in the specified map. |
7928 |
|
|
7929 |
|
8.19. MIDI instrument information changed |
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 135] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
|
8.18. MIDI instrument information changed |
|
7930 |
|
|
7931 |
Client may want to be notified when changes were made to MIDI |
Client may want to be notified when changes were made to MIDI |
7932 |
instruments on the back-end by issuing the following command: |
instruments on the back-end by issuing the following command: |
7946 |
real time events happening on the server, it is believed that an |
real time events happening on the server, it is believed that an |
7947 |
empty notification message is sufficient here. |
empty notification message is sufficient here. |
7948 |
|
|
7949 |
8.19. Global settings changed |
|
7950 |
|
|
7951 |
|
Schoenebeck Expires May 5, 2010 [Page 142] |
7952 |
|
|
7953 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
7954 |
|
|
7955 |
|
|
7956 |
|
8.20. Global settings changed |
7957 |
|
|
7958 |
Client may want to be notified when changes to the global settings of |
Client may want to be notified when changes to the global settings of |
7959 |
the sampler were made by issuing the following command: |
the sampler were made by issuing the following command: |
7968 |
by the optional dotted floating point value, reflecting the new |
by the optional dotted floating point value, reflecting the new |
7969 |
global volume parameter. |
global volume parameter. |
7970 |
|
|
7971 |
8.20. Number of database instrument directories changed |
"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
7972 |
|
golbal limit of the sampler for maximum voices is changed, where |
7973 |
|
<max-voices> will be an integer value, reflecting the new global |
7974 |
|
voice limit parameter. |
7975 |
|
|
7976 |
|
"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
7977 |
|
golbal limit of the sampler for maximum disk streams is changed, |
7978 |
|
where <max-streams> will be an integer value, reflecting the new |
7979 |
|
global disk streams limit parameter. |
7980 |
|
|
7981 |
|
8.21. Number of database instrument directories changed |
7982 |
|
|
7983 |
Client may want to be notified when the number of instrument |
Client may want to be notified when the number of instrument |
7984 |
directories in a particular directory in the instruments database is |
directories in a particular directory in the instruments database is |
7991 |
"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>" |
"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>" |
7992 |
|
|
7993 |
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 |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 136] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
7994 |
directory in the instruments database, in which the number of |
directory in the instruments database, in which the number of |
7995 |
directories is changed. |
directories is changed. |
7996 |
|
|
7997 |
Note that when a non-empty directory is removed, this event is not |
Note that when a non-empty directory is removed, this event is not |
7998 |
sent for the subdirectories in that directory. |
sent for the subdirectories in that directory. |
7999 |
|
|
8000 |
8.21. Database instrument directory information changed |
8.22. Database instrument directory information changed |
8001 |
|
|
8002 |
Client may want to be notified when changes were made to directories |
Client may want to be notified when changes were made to directories |
8003 |
in the instruments database by issuing the following command: |
in the instruments database by issuing the following command: |
8004 |
|
|
8005 |
|
|
8006 |
|
|
8007 |
|
Schoenebeck Expires May 5, 2010 [Page 143] |
8008 |
|
|
8009 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
8010 |
|
|
8011 |
|
|
8012 |
SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO |
SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO |
8013 |
|
|
8014 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
8030 |
(encapsulated into apostrophes), which name is changes and <new-name> |
(encapsulated into apostrophes), which name is changes and <new-name> |
8031 |
is the new name of the directory, encapsulated into apostrophes. |
is the new name of the directory, encapsulated into apostrophes. |
8032 |
|
|
8033 |
8.22. Number of database instruments changed |
8.23. Number of database instruments changed |
8034 |
|
|
8035 |
Client may want to be notified when the number of instruments in a |
Client may want to be notified when the number of instruments in a |
8036 |
particular directory in the instruments database is changed by |
particular directory in the instruments database is changed by |
8046 |
directory in the instruments database, in which the number of |
directory in the instruments database, in which the number of |
8047 |
instruments is changed. |
instruments is changed. |
8048 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 137] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
8049 |
Note that when a non-empty directory is removed, this event is not |
Note that when a non-empty directory is removed, this event is not |
8050 |
sent for the instruments in that directory. |
sent for the instruments in that directory. |
8051 |
|
|
8052 |
8.23. Database instrument information changed |
8.24. Database instrument information changed |
8053 |
|
|
8054 |
Client may want to be notified when changes were made to instruments |
Client may want to be notified when changes were made to instruments |
8055 |
in the instruments database by issuing the following command: |
in the instruments database by issuing the following command: |
8058 |
|
|
8059 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
8060 |
|
|
8061 |
|
|
8062 |
|
|
8063 |
|
Schoenebeck Expires May 5, 2010 [Page 144] |
8064 |
|
|
8065 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
8066 |
|
|
8067 |
|
|
8068 |
"NOTIFY:DB_INSTRUMENT_INFO:<instr-path>" |
"NOTIFY:DB_INSTRUMENT_INFO:<instr-path>" |
8069 |
|
|
8070 |
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 |
8082 |
<new-name> is the new name of the instrument, encapsulated into |
<new-name> is the new name of the instrument, encapsulated into |
8083 |
apostrophes. |
apostrophes. |
8084 |
|
|
8085 |
8.24. Database job status information changed |
8.25. Database job status information changed |
8086 |
|
|
8087 |
Client may want to be notified when the status of particular database |
Client may want to be notified when the status of particular database |
8088 |
instruments job is changed by issuing the following command: |
instruments job is changed by issuing the following command: |
8100 |
real time events happening on the server, it is believed that an |
real time events happening on the server, it is believed that an |
8101 |
empty notification message is sufficient here. |
empty notification message is sufficient here. |
8102 |
|
|
8103 |
|
8.26. Miscellaneous and debugging events |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires August 17, 2008 [Page 138] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol February 2008 |
|
|
|
|
|
|
|
|
8.25. Miscellaneous and debugging events |
|
8104 |
|
|
8105 |
Client may want to be notified of miscellaneous and debugging events |
Client may want to be notified of miscellaneous and debugging events |
8106 |
occurring at the server by issuing the following command: |
occurring at the server by issuing the following command: |
8113 |
|
|
8114 |
where <string> will be replaced by whatever data server wants to send |
where <string> will be replaced by whatever data server wants to send |
8115 |
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 |
8116 |
|
|
8117 |
|
|
8118 |
|
|
8119 |
|
Schoenebeck Expires May 5, 2010 [Page 145] |
8120 |
|
|
8121 |
|
Internet-Draft LinuxSampler Control Protocol November 2009 |
8122 |
|
|
8123 |
|
|
8124 |
facilitate debugging. |
facilitate debugging. |
8125 |
|
|
8126 |
|
|
8159 |
|
|
8160 |
|
|
8161 |
|
|
8162 |
Schoenebeck Expires August 17, 2008 [Page 139] |
|
8163 |
|
|
8164 |
|
|
8165 |
|
|
8166 |
|
|
8167 |
|
|
8168 |
|
|
8169 |
|
|
8170 |
|
|
8171 |
|
|
8172 |
|
|
8173 |
|
|
8174 |
|
|
8175 |
|
Schoenebeck Expires May 5, 2010 [Page 146] |
8176 |
|
|
8177 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
8178 |
|
|
8179 |
|
|
8180 |
9. Security Considerations |
9. Security Considerations |
8228 |
|
|
8229 |
|
|
8230 |
|
|
8231 |
Schoenebeck Expires August 17, 2008 [Page 140] |
Schoenebeck Expires May 5, 2010 [Page 147] |
8232 |
|
|
8233 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
8234 |
|
|
8235 |
|
|
8236 |
10. Acknowledgments |
10. Acknowledgments |
8284 |
|
|
8285 |
|
|
8286 |
|
|
8287 |
Schoenebeck Expires August 17, 2008 [Page 141] |
Schoenebeck Expires May 5, 2010 [Page 148] |
8288 |
|
|
8289 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
8290 |
|
|
8291 |
|
|
8292 |
11. References |
11. References |
8340 |
|
|
8341 |
|
|
8342 |
|
|
8343 |
Schoenebeck Expires August 17, 2008 [Page 142] |
Schoenebeck Expires May 5, 2010 [Page 149] |
8344 |
|
|
8345 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
8346 |
|
|
8347 |
|
|
8348 |
Author's Address |
Author's Address |
8396 |
|
|
8397 |
|
|
8398 |
|
|
8399 |
Schoenebeck Expires August 17, 2008 [Page 143] |
Schoenebeck Expires May 5, 2010 [Page 150] |
8400 |
|
|
8401 |
Internet-Draft LinuxSampler Control Protocol February 2008 |
Internet-Draft LinuxSampler Control Protocol November 2009 |
8402 |
|
|
8403 |
|
|
8404 |
Full Copyright Statement |
Full Copyright Statement |
8405 |
|
|
8406 |
Copyright (C) The IETF Trust (2008). |
Copyright (C) The IETF Trust (2009). |
8407 |
|
|
8408 |
This document is subject to the rights, licenses and restrictions |
This document is subject to the rights, licenses and restrictions |
8409 |
contained in BCP 78, and except as set forth therein, the authors |
contained in BCP 78, and except as set forth therein, the authors |
8443 |
ietf-ipr@ietf.org. |
ietf-ipr@ietf.org. |
8444 |
|
|
8445 |
|
|
|
Acknowledgment |
|
8446 |
|
|
|
Funding for the RFC Editor function is provided by the IETF |
|
|
Administrative Support Activity (IASA). |
|
8447 |
|
|
8448 |
|
|
8449 |
|
|
8450 |
|
|
8451 |
|
|
8452 |
Schoenebeck Expires August 17, 2008 [Page 144] |
|
8453 |
|
|
8454 |
|
|
8455 |
|
Schoenebeck Expires May 5, 2010 [Page 151] |
8456 |
|
|
8457 |
|
|