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: June 18, 2007 December 15, 2006 |
Expires: April 17, 2008 October 15, 2007 |
8 |
|
|
9 |
|
|
10 |
LinuxSampler Control Protocol |
LinuxSampler Control Protocol |
33 |
The list of Internet-Draft Shadow Directories can be accessed at |
The list of Internet-Draft Shadow Directories can be accessed at |
34 |
http://www.ietf.org/shadow.html. |
http://www.ietf.org/shadow.html. |
35 |
|
|
36 |
This Internet-Draft will expire on June 18, 2007. |
This Internet-Draft will expire on April 17, 2008. |
37 |
|
|
38 |
Copyright Notice |
Copyright Notice |
39 |
|
|
40 |
Copyright (C) The Internet Society (2006). |
Copyright (C) The IETF Trust (2007). |
41 |
|
|
42 |
|
|
43 |
|
|
52 |
|
|
53 |
|
|
54 |
|
|
55 |
Schoenebeck Expires June 18, 2007 [Page 1] |
Schoenebeck Expires April 17, 2008 [Page 1] |
56 |
|
|
57 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
58 |
|
|
59 |
|
|
60 |
Abstract |
Abstract |
68 |
|
|
69 |
Table of Contents |
Table of Contents |
70 |
|
|
71 |
1. Requirements notation . . . . . . . . . . . . . . . . . . . . 5 |
1. Requirements notation . . . . . . . . . . . . . . . . . . . . 6 |
72 |
2. Versioning of this specification . . . . . . . . . . . . . . . 6 |
2. Versioning of this specification . . . . . . . . . . . . . . 7 |
73 |
3. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 7 |
3. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 8 |
74 |
4. Focus of this protocol . . . . . . . . . . . . . . . . . . . . 8 |
4. Focus of this protocol . . . . . . . . . . . . . . . . . . . 9 |
75 |
5. Communication Overview . . . . . . . . . . . . . . . . . . . . 9 |
5. Communication Overview . . . . . . . . . . . . . . . . . . . 10 |
76 |
5.1. Request/response communication method . . . . . . . . . . 9 |
5.1. Request/response communication method . . . . . . . . . . 10 |
77 |
5.1.1. Result format . . . . . . . . . . . . . . . . . . . . 10 |
5.1.1. Result format . . . . . . . . . . . . . . . . . . . . 11 |
78 |
5.2. Subscribe/notify communication method . . . . . . . . . . 12 |
5.2. Subscribe/notify communication method . . . . . . . . . . 13 |
79 |
6. Description for control commands . . . . . . . . . . . . . . . 14 |
6. Description for control commands . . . . . . . . . . . . . . 15 |
80 |
6.1. Ignored lines and comments . . . . . . . . . . . . . . . . 14 |
6.1. Ignored lines and comments . . . . . . . . . . . . . . . 15 |
81 |
6.2. Configuring audio drivers . . . . . . . . . . . . . . . . 14 |
6.2. Configuring audio drivers . . . . . . . . . . . . . . . . 15 |
82 |
6.2.1. Getting amount of available audio output drivers . . . 15 |
6.2.1. Getting amount of available audio output drivers . . 16 |
83 |
6.2.2. Getting all available audio output drivers . . . . . . 15 |
6.2.2. Getting all available audio output drivers . . . . . 16 |
84 |
6.2.3. Getting information about a specific audio output |
6.2.3. Getting information about a specific audio output |
85 |
driver . . . . . . . . . . . . . . . . . . . . . . . . 15 |
driver . . . . . . . . . . . . . . . . . . . . . . . 16 |
86 |
6.2.4. Getting information about specific audio output |
6.2.4. Getting information about specific audio output |
87 |
driver parameter . . . . . . . . . . . . . . . . . . . 16 |
driver parameter . . . . . . . . . . . . . . . . . . 17 |
88 |
6.2.5. Creating an audio output device . . . . . . . . . . . 20 |
6.2.5. Creating an audio output device . . . . . . . . . . . 21 |
89 |
6.2.6. Destroying an audio output device . . . . . . . . . . 21 |
6.2.6. Destroying an audio output device . . . . . . . . . . 22 |
90 |
6.2.7. Getting all created audio output device count . . . . 22 |
6.2.7. Getting all created audio output device count . . . . 23 |
91 |
6.2.8. Getting all created audio output device list . . . . . 22 |
6.2.8. Getting all created audio output device list . . . . 23 |
92 |
6.2.9. Getting current settings of an audio output device . . 22 |
6.2.9. Getting current settings of an audio output device . 23 |
93 |
6.2.10. Changing settings of audio output devices . . . . . . 24 |
6.2.10. Changing settings of audio output devices . . . . . . 25 |
94 |
6.2.11. Getting information about an audio channel . . . . . . 25 |
6.2.11. Getting information about an audio channel . . . . . 26 |
95 |
6.2.12. Getting information about specific audio channel |
6.2.12. Getting information about specific audio channel |
96 |
parameter . . . . . . . . . . . . . . . . . . . . . . 26 |
parameter . . . . . . . . . . . . . . . . . . . . . . 27 |
97 |
6.2.13. Changing settings of audio output channels . . . . . . 28 |
6.2.13. Changing settings of audio output channels . . . . . 29 |
98 |
6.3. Configuring MIDI input drivers . . . . . . . . . . . . . . 29 |
6.3. Configuring MIDI input drivers . . . . . . . . . . . . . 30 |
99 |
6.3.1. Getting amount of available MIDI input drivers . . . . 30 |
6.3.1. Getting amount of available MIDI input drivers . . . 31 |
100 |
6.3.2. Getting all available MIDI input drivers . . . . . . . 30 |
6.3.2. Getting all available MIDI input drivers . . . . . . 31 |
101 |
6.3.3. Getting information about a specific MIDI input |
6.3.3. Getting information about a specific MIDI input |
102 |
driver . . . . . . . . . . . . . . . . . . . . . . . . 31 |
driver . . . . . . . . . . . . . . . . . . . . . . . 32 |
103 |
6.3.4. Getting information about specific MIDI input |
6.3.4. Getting information about specific MIDI input |
104 |
driver parameter . . . . . . . . . . . . . . . . . . . 32 |
driver parameter . . . . . . . . . . . . . . . . . . 33 |
105 |
6.3.5. Creating a MIDI input device . . . . . . . . . . . . . 34 |
6.3.5. Creating a MIDI input device . . . . . . . . . . . . 35 |
106 |
6.3.6. Destroying a MIDI input device . . . . . . . . . . . . 35 |
6.3.6. Destroying a MIDI input device . . . . . . . . . . . 36 |
107 |
6.3.7. Getting all created MIDI input device count . . . . . 36 |
6.3.7. Getting all created MIDI input device count . . . . . 37 |
108 |
|
|
109 |
|
|
110 |
|
|
111 |
Schoenebeck Expires June 18, 2007 [Page 2] |
Schoenebeck Expires April 17, 2008 [Page 2] |
112 |
|
|
113 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
114 |
|
|
115 |
|
|
116 |
6.3.8. Getting all created MIDI input device list . . . . . . 36 |
6.3.8. Getting all created MIDI input device list . . . . . 37 |
117 |
6.3.9. Getting current settings of a MIDI input device . . . 37 |
6.3.9. Getting current settings of a MIDI input device . . . 38 |
118 |
6.3.10. Changing settings of MIDI input devices . . . . . . . 38 |
6.3.10. Changing settings of MIDI input devices . . . . . . . 39 |
119 |
6.3.11. Getting information about a MIDI port . . . . . . . . 38 |
6.3.11. Getting information about a MIDI port . . . . . . . . 39 |
120 |
6.3.12. Getting information about specific MIDI port |
6.3.12. Getting information about specific MIDI port |
121 |
parameter . . . . . . . . . . . . . . . . . . . . . . 39 |
parameter . . . . . . . . . . . . . . . . . . . . . . 40 |
122 |
6.3.13. Changing settings of MIDI input ports . . . . . . . . 41 |
6.3.13. Changing settings of MIDI input ports . . . . . . . . 42 |
123 |
6.4. Configuring sampler channels . . . . . . . . . . . . . . . 42 |
6.4. Configuring sampler channels . . . . . . . . . . . . . . 43 |
124 |
6.4.1. Loading an instrument . . . . . . . . . . . . . . . . 42 |
6.4.1. Loading an instrument . . . . . . . . . . . . . . . . 43 |
125 |
6.4.2. Loading a sampler engine . . . . . . . . . . . . . . . 43 |
6.4.2. Loading a sampler engine . . . . . . . . . . . . . . 44 |
126 |
6.4.3. Getting all created sampler channel count . . . . . . 44 |
6.4.3. Getting all created sampler channel count . . . . . . 45 |
127 |
6.4.4. Getting all created sampler channel list . . . . . . . 44 |
6.4.4. Getting all created sampler channel list . . . . . . 45 |
128 |
6.4.5. Adding a new sampler channel . . . . . . . . . . . . . 44 |
6.4.5. Adding a new sampler channel . . . . . . . . . . . . 46 |
129 |
6.4.6. Removing a sampler channel . . . . . . . . . . . . . . 45 |
6.4.6. Removing a sampler channel . . . . . . . . . . . . . 47 |
130 |
6.4.7. Getting amount of available engines . . . . . . . . . 46 |
6.4.7. Getting amount of available engines . . . . . . . . . 47 |
131 |
6.4.8. Getting all available engines . . . . . . . . . . . . 46 |
6.4.8. Getting all available engines . . . . . . . . . . . . 48 |
132 |
6.4.9. Getting information about an engine . . . . . . . . . 47 |
6.4.9. Getting information about an engine . . . . . . . . . 48 |
133 |
6.4.10. Getting sampler channel information . . . . . . . . . 48 |
6.4.10. Getting sampler channel information . . . . . . . . . 49 |
134 |
6.4.11. Current number of active voices . . . . . . . . . . . 51 |
6.4.11. Current number of active voices . . . . . . . . . . . 52 |
135 |
6.4.12. Current number of active disk streams . . . . . . . . 51 |
6.4.12. Current number of active disk streams . . . . . . . . 53 |
136 |
6.4.13. Current fill state of disk stream buffers . . . . . . 52 |
6.4.13. Current fill state of disk stream buffers . . . . . . 53 |
137 |
6.4.14. Setting audio output device . . . . . . . . . . . . . 53 |
6.4.14. Setting audio output device . . . . . . . . . . . . . 54 |
138 |
6.4.15. Setting audio output type . . . . . . . . . . . . . . 53 |
6.4.15. Setting audio output type . . . . . . . . . . . . . . 55 |
139 |
6.4.16. Setting audio output channel . . . . . . . . . . . . . 54 |
6.4.16. Setting audio output channel . . . . . . . . . . . . 55 |
140 |
6.4.17. Setting MIDI input device . . . . . . . . . . . . . . 55 |
6.4.17. Setting MIDI input device . . . . . . . . . . . . . . 56 |
141 |
6.4.18. Setting MIDI input type . . . . . . . . . . . . . . . 56 |
6.4.18. Setting MIDI input type . . . . . . . . . . . . . . . 57 |
142 |
6.4.19. Setting MIDI input port . . . . . . . . . . . . . . . 56 |
6.4.19. Setting MIDI input port . . . . . . . . . . . . . . . 58 |
143 |
6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57 |
6.4.20. Setting MIDI input channel . . . . . . . . . . . . . 58 |
144 |
6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 58 |
6.4.21. Setting channel volume . . . . . . . . . . . . . . . 59 |
145 |
6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58 |
6.4.22. Muting a sampler channel . . . . . . . . . . . . . . 60 |
146 |
6.4.23. Soloing a sampler channel . . . . . . . . . . . . . . 59 |
6.4.23. Soloing a sampler channel . . . . . . . . . . . . . . 60 |
147 |
6.4.24. Assigning a MIDI instrument map to a sampler |
6.4.24. Assigning a MIDI instrument map to a sampler |
148 |
channel . . . . . . . . . . . . . . . . . . . . . . . 60 |
channel . . . . . . . . . . . . . . . . . . . . . . . 61 |
149 |
6.4.25. Resetting a sampler channel . . . . . . . . . . . . . 61 |
6.4.25. Adding an effect send to a sampler channel . . . . . 62 |
150 |
6.5. Controlling connection . . . . . . . . . . . . . . . . . . 61 |
6.4.26. Removing an effect send from a sampler channel . . . 63 |
151 |
6.5.1. Register front-end for receiving event messages . . . 61 |
6.4.27. Getting amount of effect sends on a sampler channel . 64 |
152 |
|
6.4.28. Listing all effect sends on a sampler channel . . . . 64 |
153 |
|
6.4.29. Getting effect send information . . . . . . . . . . . 65 |
154 |
|
6.4.30. Changing effect send's name . . . . . . . . . . . . . 66 |
155 |
|
6.4.31. Altering effect send's audio routing . . . . . . . . 67 |
156 |
|
6.4.32. Altering effect send's MIDI controller . . . . . . . 68 |
157 |
|
6.4.33. Altering effect send's send level . . . . . . . . . . 69 |
158 |
|
6.4.34. Resetting a sampler channel . . . . . . . . . . . . . 70 |
159 |
|
6.5. Controlling connection . . . . . . . . . . . . . . . . . 70 |
160 |
|
6.5.1. Register front-end for receiving event messages . . . 70 |
161 |
6.5.2. Unregister front-end for not receiving event |
6.5.2. Unregister front-end for not receiving event |
162 |
messages . . . . . . . . . . . . . . . . . . . . . . . 62 |
messages . . . . . . . . . . . . . . . . . . . . . . 71 |
163 |
6.5.3. Enable or disable echo of commands . . . . . . . . . . 63 |
6.5.3. Enable or disable echo of commands . . . . . . . . . 72 |
|
6.5.4. Close client connection . . . . . . . . . . . . . . . 63 |
|
|
6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 64 |
|
|
6.6.1. Current number of active voices . . . . . . . . . . . 64 |
|
|
6.6.2. Maximum amount of active voices . . . . . . . . . . . 64 |
|
|
6.6.3. Reset sampler . . . . . . . . . . . . . . . . . . . . 64 |
|
|
6.6.4. General sampler informations . . . . . . . . . . . . . 65 |
|
|
6.7. MIDI Instrument Mapping . . . . . . . . . . . . . . . . . 65 |
|
|
6.7.1. Create a new MIDI instrument map . . . . . . . . . . . 66 |
|
|
6.7.2. Delete one particular or all MIDI instrument maps . . 67 |
|
164 |
|
|
165 |
|
|
166 |
|
|
167 |
Schoenebeck Expires June 18, 2007 [Page 3] |
Schoenebeck Expires April 17, 2008 [Page 3] |
168 |
|
|
169 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
|
|
|
|
|
|
|
6.7.3. Get amount of existing MIDI instrument maps . . . . . 67 |
|
|
6.7.4. Getting all created MIDI instrument maps . . . . . . . 68 |
|
|
6.7.5. Getting MIDI instrument map information . . . . . . . 68 |
|
|
6.7.6. Renaming a MIDI instrument map . . . . . . . . . . . . 69 |
|
|
6.7.7. Create or replace a MIDI instrument map entry . . . . 69 |
|
|
6.7.8. Getting ammount of MIDI instrument map entries . . . . 72 |
|
|
6.7.9. Getting indeces of all entries of a MIDI |
|
|
instrument map . . . . . . . . . . . . . . . . . . . . 73 |
|
|
6.7.10. Remove an entry from the MIDI instrument map . . . . . 73 |
|
|
6.7.11. Get current settings of MIDI instrument map entry . . 74 |
|
|
6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . . 76 |
|
|
7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 77 |
|
|
8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 |
|
|
8.1. Number of sampler channels changed . . . . . . . . . . . . 86 |
|
|
8.2. Number of active voices changed . . . . . . . . . . . . . 86 |
|
|
8.3. Number of active disk streams changed . . . . . . . . . . 86 |
|
|
8.4. Disk stream buffer fill state changed . . . . . . . . . . 87 |
|
|
8.5. Channel information changed . . . . . . . . . . . . . . . 87 |
|
|
8.6. Total number of active voices changed . . . . . . . . . . 87 |
|
|
8.7. Miscellaneous and debugging events . . . . . . . . . . . . 88 |
|
|
9. Security Considerations . . . . . . . . . . . . . . . . . . . 89 |
|
|
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 90 |
|
|
11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 91 |
|
|
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 92 |
|
|
Intellectual Property and Copyright Statements . . . . . . . . . . 93 |
|
170 |
|
|
171 |
|
|
172 |
|
6.5.4. Close client connection . . . . . . . . . . . . . . . 72 |
173 |
|
6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 73 |
174 |
|
6.6.1. Current number of active voices . . . . . . . . . . . 73 |
175 |
|
6.6.2. Maximum amount of active voices . . . . . . . . . . . 73 |
176 |
|
6.6.3. Reset sampler . . . . . . . . . . . . . . . . . . . . 73 |
177 |
|
6.6.4. General sampler informations . . . . . . . . . . . . 74 |
178 |
|
6.6.5. Getting global volume attenuation . . . . . . . . . . 74 |
179 |
|
6.6.6. Setting global volume attenuation . . . . . . . . . . 75 |
180 |
|
6.7. MIDI Instrument Mapping . . . . . . . . . . . . . . . . . 75 |
181 |
|
6.7.1. Create a new MIDI instrument map . . . . . . . . . . 76 |
182 |
|
6.7.2. Delete one particular or all MIDI instrument maps . . 77 |
183 |
|
6.7.3. Get amount of existing MIDI instrument maps . . . . . 78 |
184 |
|
6.7.4. Getting all created MIDI instrument maps . . . . . . 78 |
185 |
|
6.7.5. Getting MIDI instrument map information . . . . . . . 78 |
186 |
|
6.7.6. Renaming a MIDI instrument map . . . . . . . . . . . 79 |
187 |
|
6.7.7. Create or replace a MIDI instrument map entry . . . . 80 |
188 |
|
6.7.8. Getting ammount of MIDI instrument map entries . . . 83 |
189 |
|
6.7.9. Getting indeces of all entries of a MIDI |
190 |
|
instrument map . . . . . . . . . . . . . . . . . . . 83 |
191 |
|
6.7.10. Remove an entry from the MIDI instrument map . . . . 84 |
192 |
|
6.7.11. Get current settings of MIDI instrument map entry . . 85 |
193 |
|
6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . . 86 |
194 |
|
6.8. Managing Instruments Database . . . . . . . . . . . . . . 87 |
195 |
|
6.8.1. Creating a new instrument directory . . . . . . . . . 87 |
196 |
|
6.8.2. Deleting an instrument directory . . . . . . . . . . 88 |
197 |
|
6.8.3. Getting amount of instrument directories . . . . . . 89 |
198 |
|
6.8.4. Listing all directories in specific directory . . . . 89 |
199 |
|
6.8.5. Getting instrument directory information . . . . . . 90 |
200 |
|
6.8.6. Renaming an instrument directory . . . . . . . . . . 91 |
201 |
|
6.8.7. Moving an instrument directory . . . . . . . . . . . 91 |
202 |
|
6.8.8. Copying instrument directories . . . . . . . . . . . 92 |
203 |
|
6.8.9. Changing the description of directory . . . . . . . . 93 |
204 |
|
6.8.10. Finding directories . . . . . . . . . . . . . . . . . 93 |
205 |
|
6.8.11. Adding instruments to the instruments database . . . 95 |
206 |
|
6.8.12. Removing an instrument . . . . . . . . . . . . . . . 96 |
207 |
|
6.8.13. Getting amount of instruments . . . . . . . . . . . . 97 |
208 |
|
6.8.14. Listing all instruments in specific directory . . . . 97 |
209 |
|
6.8.15. Getting instrument information . . . . . . . . . . . 98 |
210 |
|
6.8.16. Renaming an instrument . . . . . . . . . . . . . . . 100 |
211 |
|
6.8.17. Moving an instrument . . . . . . . . . . . . . . . . 101 |
212 |
|
6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102 |
213 |
|
6.8.19. Changing the description of instrument . . . . . . . 102 |
214 |
|
6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103 |
215 |
|
6.8.21. Getting job status information . . . . . . . . . . . 105 |
216 |
|
6.8.22. Formatting the instruments database . . . . . . . . . 106 |
217 |
|
6.9. Editing Instruments . . . . . . . . . . . . . . . . . . . 107 |
218 |
|
6.9.1. Opening an appropriate instrument editor |
219 |
|
application . . . . . . . . . . . . . . . . . . . . . 107 |
220 |
|
|
221 |
|
|
222 |
|
|
223 |
|
Schoenebeck Expires April 17, 2008 [Page 4] |
224 |
|
|
225 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
226 |
|
|
227 |
|
|
228 |
|
7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . 109 |
229 |
|
7.1. Character Set and Escape Sequences . . . . . . . . . . . 122 |
230 |
|
8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 |
231 |
|
8.1. Number of audio output devices changed . . . . . . . . . 126 |
232 |
|
8.2. Audio output device's settings changed . . . . . . . . . 126 |
233 |
|
8.3. Number of MIDI input devices changed . . . . . . . . . . 126 |
234 |
|
8.4. MIDI input device's settings changed . . . . . . . . . . 127 |
235 |
|
8.5. Number of sampler channels changed . . . . . . . . . . . 127 |
236 |
|
8.6. Number of active voices changed . . . . . . . . . . . . . 127 |
237 |
|
8.7. Number of active disk streams changed . . . . . . . . . . 128 |
238 |
|
8.8. Disk stream buffer fill state changed . . . . . . . . . . 128 |
239 |
|
8.9. Channel information changed . . . . . . . . . . . . . . . 128 |
240 |
|
8.10. Number of effect sends changed . . . . . . . . . . . . . 129 |
241 |
|
8.11. Effect send information changed . . . . . . . . . . . . . 129 |
242 |
|
8.12. Total number of active voices changed . . . . . . . . . . 129 |
243 |
|
8.13. Number of MIDI instrument maps changed . . . . . . . . . 130 |
244 |
|
8.14. MIDI instrument map information changed . . . . . . . . . 130 |
245 |
|
8.15. Number of MIDI instruments changed . . . . . . . . . . . 130 |
246 |
|
8.16. MIDI instrument information changed . . . . . . . . . . . 131 |
247 |
|
8.17. Global settings changed . . . . . . . . . . . . . . . . . 131 |
248 |
|
8.18. Number of database instrument directories changed . . . . 132 |
249 |
|
8.19. Database instrument directory information changed . . . . 132 |
250 |
|
8.20. Number of database instruments changed . . . . . . . . . 133 |
251 |
|
8.21. Database instrument information changed . . . . . . . . . 133 |
252 |
|
8.22. Database job status information changed . . . . . . . . . 134 |
253 |
|
8.23. Miscellaneous and debugging events . . . . . . . . . . . 134 |
254 |
|
9. Security Considerations . . . . . . . . . . . . . . . . . . . 135 |
255 |
|
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 136 |
256 |
|
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 137 |
257 |
|
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 138 |
258 |
|
Intellectual Property and Copyright Statements . . . . . . . . . 139 |
259 |
|
|
260 |
|
|
261 |
|
|
276 |
|
|
277 |
|
|
278 |
|
|
279 |
Schoenebeck Expires June 18, 2007 [Page 4] |
Schoenebeck Expires April 17, 2008 [Page 5] |
280 |
|
|
281 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
282 |
|
|
283 |
|
|
284 |
1. Requirements notation |
1. Requirements notation |
294 |
end) and server (LinuxSampler) respectively. Lines in examples must |
end) and server (LinuxSampler) respectively. Lines in examples must |
295 |
be interpreted as every line being CRLF terminated (carriage return |
be interpreted as every line being CRLF terminated (carriage return |
296 |
character followed by line feed character as defined in the ASCII |
character followed by line feed character as defined in the ASCII |
297 |
standard), thus the following example: |
standard [RFC20]), thus the following example: |
298 |
|
|
299 |
C: "some line" |
C: "some line" |
300 |
|
|
332 |
|
|
333 |
|
|
334 |
|
|
335 |
Schoenebeck Expires June 18, 2007 [Page 5] |
Schoenebeck Expires April 17, 2008 [Page 6] |
336 |
|
|
337 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
338 |
|
|
339 |
|
|
340 |
2. Versioning of this specification |
2. Versioning of this specification |
388 |
|
|
389 |
|
|
390 |
|
|
391 |
Schoenebeck Expires June 18, 2007 [Page 6] |
Schoenebeck Expires April 17, 2008 [Page 7] |
392 |
|
|
393 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
394 |
|
|
395 |
|
|
396 |
3. Introduction |
3. Introduction |
444 |
|
|
445 |
|
|
446 |
|
|
447 |
Schoenebeck Expires June 18, 2007 [Page 7] |
Schoenebeck Expires April 17, 2008 [Page 8] |
448 |
|
|
449 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
450 |
|
|
451 |
|
|
452 |
4. Focus of this protocol |
4. Focus of this protocol |
500 |
|
|
501 |
|
|
502 |
|
|
503 |
Schoenebeck Expires June 18, 2007 [Page 8] |
Schoenebeck Expires April 17, 2008 [Page 9] |
504 |
|
|
505 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
506 |
|
|
507 |
|
|
508 |
5. Communication Overview |
5. Communication Overview |
556 |
|
|
557 |
|
|
558 |
|
|
559 |
Schoenebeck Expires June 18, 2007 [Page 9] |
Schoenebeck Expires April 17, 2008 [Page 10] |
560 |
|
|
561 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
562 |
|
|
563 |
|
|
564 |
5.1.1. Result format |
5.1.1. Result format |
612 |
|
|
613 |
|
|
614 |
|
|
615 |
Schoenebeck Expires June 18, 2007 [Page 10] |
Schoenebeck Expires April 17, 2008 [Page 11] |
616 |
|
|
617 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
618 |
|
|
619 |
|
|
620 |
set has the following format: |
set has the following format: |
668 |
|
|
669 |
|
|
670 |
|
|
671 |
Schoenebeck Expires June 18, 2007 [Page 11] |
Schoenebeck Expires April 17, 2008 [Page 12] |
672 |
|
|
673 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 12] |
Schoenebeck Expires April 17, 2008 [Page 13] |
728 |
|
|
729 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 13] |
Schoenebeck Expires April 17, 2008 [Page 14] |
784 |
|
|
785 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
786 |
|
|
787 |
|
|
788 |
6. Description for control commands |
6. Description for control commands |
836 |
|
|
837 |
|
|
838 |
|
|
839 |
Schoenebeck Expires June 18, 2007 [Page 14] |
Schoenebeck Expires April 17, 2008 [Page 15] |
840 |
|
|
841 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 15] |
Schoenebeck Expires April 17, 2008 [Page 16] |
896 |
|
|
897 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 16] |
Schoenebeck Expires April 17, 2008 [Page 17] |
952 |
|
|
953 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 17] |
Schoenebeck Expires April 17, 2008 [Page 18] |
1008 |
|
|
1009 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1010 |
|
|
1011 |
|
|
1012 |
MULTIPLICITY - |
MULTIPLICITY - |
1060 |
|
|
1061 |
|
|
1062 |
|
|
1063 |
Schoenebeck Expires June 18, 2007 [Page 18] |
Schoenebeck Expires April 17, 2008 [Page 19] |
1064 |
|
|
1065 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1066 |
|
|
1067 |
|
|
1068 |
returned, dependent to driver parameter) |
returned, dependent to driver parameter) |
1116 |
|
|
1117 |
|
|
1118 |
|
|
1119 |
Schoenebeck Expires June 18, 2007 [Page 19] |
Schoenebeck Expires April 17, 2008 [Page 20] |
1120 |
|
|
1121 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1122 |
|
|
1123 |
|
|
1124 |
"TYPE: INT" |
"TYPE: INT" |
1172 |
|
|
1173 |
|
|
1174 |
|
|
1175 |
Schoenebeck Expires June 18, 2007 [Page 20] |
Schoenebeck Expires April 17, 2008 [Page 21] |
1176 |
|
|
1177 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 21] |
Schoenebeck Expires April 17, 2008 [Page 22] |
1232 |
|
|
1233 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1234 |
|
|
1235 |
|
|
1236 |
C: "DESTROY AUDIO_OUTPUT_DEVICE 0" |
C: "DESTROY AUDIO_OUTPUT_DEVICE 0" |
1284 |
|
|
1285 |
|
|
1286 |
|
|
1287 |
Schoenebeck Expires June 18, 2007 [Page 22] |
Schoenebeck Expires April 17, 2008 [Page 23] |
1288 |
|
|
1289 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1290 |
|
|
1291 |
|
|
1292 |
Possible Answers: |
Possible Answers: |
1340 |
|
|
1341 |
|
|
1342 |
|
|
1343 |
Schoenebeck Expires June 18, 2007 [Page 23] |
Schoenebeck Expires April 17, 2008 [Page 24] |
1344 |
|
|
1345 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1346 |
|
|
1347 |
|
|
1348 |
"FRAGMENTS: 2" |
"FRAGMENTS: 2" |
1396 |
|
|
1397 |
|
|
1398 |
|
|
1399 |
Schoenebeck Expires June 18, 2007 [Page 24] |
Schoenebeck Expires April 17, 2008 [Page 25] |
1400 |
|
|
1401 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 25] |
Schoenebeck Expires April 17, 2008 [Page 26] |
1456 |
|
|
1457 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1458 |
|
|
1459 |
|
|
1460 |
Examples: |
Examples: |
1508 |
|
|
1509 |
|
|
1510 |
|
|
1511 |
Schoenebeck Expires June 18, 2007 [Page 26] |
Schoenebeck Expires April 17, 2008 [Page 27] |
1512 |
|
|
1513 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 27] |
Schoenebeck Expires April 17, 2008 [Page 28] |
1568 |
|
|
1569 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1570 |
|
|
1571 |
|
|
1572 |
RANGE_MAX - |
RANGE_MAX - |
1620 |
|
|
1621 |
|
|
1622 |
|
|
1623 |
Schoenebeck Expires June 18, 2007 [Page 28] |
Schoenebeck Expires April 17, 2008 [Page 29] |
1624 |
|
|
1625 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1626 |
|
|
1627 |
|
|
1628 |
"OK" - |
"OK" - |
1676 |
|
|
1677 |
|
|
1678 |
|
|
1679 |
Schoenebeck Expires June 18, 2007 [Page 29] |
Schoenebeck Expires April 17, 2008 [Page 30] |
1680 |
|
|
1681 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 30] |
Schoenebeck Expires April 17, 2008 [Page 31] |
1736 |
|
|
1737 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 31] |
Schoenebeck Expires April 17, 2008 [Page 32] |
1792 |
|
|
1793 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 32] |
Schoenebeck Expires April 17, 2008 [Page 33] |
1848 |
|
|
1849 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1850 |
|
|
1851 |
|
|
1852 |
FIX - |
FIX - |
1900 |
|
|
1901 |
|
|
1902 |
|
|
1903 |
Schoenebeck Expires June 18, 2007 [Page 33] |
Schoenebeck Expires April 17, 2008 [Page 34] |
1904 |
|
|
1905 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 34] |
Schoenebeck Expires April 17, 2008 [Page 35] |
1960 |
|
|
1961 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
1962 |
|
|
1963 |
|
|
1964 |
"OK[<device-id>]" - |
"OK[<device-id>]" - |
2012 |
|
|
2013 |
|
|
2014 |
|
|
2015 |
Schoenebeck Expires June 18, 2007 [Page 35] |
Schoenebeck Expires April 17, 2008 [Page 36] |
2016 |
|
|
2017 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 36] |
Schoenebeck Expires April 17, 2008 [Page 37] |
2072 |
|
|
2073 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 37] |
Schoenebeck Expires April 17, 2008 [Page 38] |
2128 |
|
|
2129 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
2130 |
|
|
2131 |
|
|
2132 |
"ACTIVE: true" |
"ACTIVE: true" |
2180 |
|
|
2181 |
|
|
2182 |
|
|
2183 |
Schoenebeck Expires June 18, 2007 [Page 38] |
Schoenebeck Expires April 17, 2008 [Page 39] |
2184 |
|
|
2185 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 39] |
Schoenebeck Expires April 17, 2008 [Page 40] |
2240 |
|
|
2241 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 June 18, 2007 [Page 40] |
Schoenebeck Expires April 17, 2008 [Page 41] |
2296 |
|
|
2297 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
2298 |
|
|
2299 |
|
|
2300 |
returned, dependent to device and port parameter) |
returned, dependent to device and port parameter) |
2328 |
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) |
2329 |
or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the |
or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the |
2330 |
MIDI port number, <key> by the name of the parameter to change and |
MIDI port number, <key> by the name of the parameter to change and |
2331 |
<value> by the new value for this parameter. |
<value> by the new value for this parameter (encapsulated into |
2332 |
|
apostrophes) or NONE (not encapsulated into apostrophes) for |
2333 |
|
specifying no value for parameters allowing a list of values. |
2334 |
|
|
2335 |
Possible Answers: |
Possible Answers: |
2336 |
|
|
2344 |
noteworthy issue(s) related, providing an appropriate warning |
noteworthy issue(s) related, providing an appropriate warning |
2345 |
code and warning message |
code and warning message |
2346 |
|
|
|
"ERR:<error-code>:<error-message>" - |
|
|
|
|
2347 |
|
|
2348 |
|
|
2349 |
|
|
2350 |
|
|
2351 |
Schoenebeck Expires June 18, 2007 [Page 41] |
Schoenebeck Expires April 17, 2008 [Page 42] |
2352 |
|
|
2353 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
2354 |
|
|
2355 |
|
|
2356 |
|
"ERR:<error-code>:<error-message>" - |
2357 |
|
|
2358 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
2359 |
error message |
error message |
2360 |
|
|
2361 |
Example: |
Example: |
2362 |
|
|
2363 |
|
C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'" |
2364 |
|
|
2365 |
|
S: "OK" |
2366 |
|
|
2367 |
|
C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE" |
2368 |
|
|
2369 |
|
S: "OK" |
2370 |
|
|
2371 |
6.4. Configuring sampler channels |
6.4. Configuring sampler channels |
2372 |
|
|
2388 |
of the sampler channel the instrument should be assigned to. Each |
of the sampler channel the instrument should be assigned to. Each |
2389 |
sampler channel can only have one instrument. |
sampler channel can only have one instrument. |
2390 |
|
|
2391 |
|
Notice: since LSCP 1.2 the <filename> argument supports escape |
2392 |
|
characters for special characters (see chapter "Character Set and |
2393 |
|
Escape Sequences (Section 7.1)" for details) and accordingly |
2394 |
|
backslash characters in the filename MUST now be escaped as well! |
2395 |
|
|
2396 |
The difference between regular and NON_MODAL versions of the command |
The difference between regular and NON_MODAL versions of the command |
2397 |
is that the regular command returns OK only after the instrument has |
is that the regular command returns OK only after the instrument has |
2398 |
been fully loaded and the channel is ready to be used while NON_MODAL |
been fully loaded and the channel is ready to be used while NON_MODAL |
2401 |
(Section 6.4.10) command can be used to obtain loading progress from |
(Section 6.4.10) command can be used to obtain loading progress from |
2402 |
INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
2403 |
such as making sure that the file could be read and it is of a proper |
such as making sure that the file could be read and it is of a proper |
2404 |
|
|
2405 |
|
|
2406 |
|
|
2407 |
|
Schoenebeck Expires April 17, 2008 [Page 43] |
2408 |
|
|
2409 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
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 |
2413 |
process should any errors be detected at that point. |
process should any errors be detected at that point. |
2414 |
|
|
2422 |
|
|
2423 |
in case the instrument was loaded successfully, but there are |
in case the instrument was loaded successfully, but there are |
2424 |
noteworthy issue(s) related (e.g. Engine doesn't support one |
noteworthy issue(s) related (e.g. Engine doesn't support one |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 42] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2425 |
or more patch parameters provided by the loaded instrument |
or more patch parameters provided by the loaded instrument |
2426 |
file), providing an appropriate warning code and warning |
file), providing an appropriate warning code and warning |
2427 |
message |
message |
2456 |
|
|
2457 |
Possible Answers: |
Possible Answers: |
2458 |
|
|
2459 |
|
|
2460 |
|
|
2461 |
|
|
2462 |
|
|
2463 |
|
Schoenebeck Expires April 17, 2008 [Page 44] |
2464 |
|
|
2465 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2466 |
|
|
2467 |
|
|
2468 |
"OK" - |
"OK" - |
2469 |
|
|
2470 |
in case the engine was successfully deployed |
in case the engine was successfully deployed |
2480 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
2481 |
error message |
error message |
2482 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 43] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2483 |
Example: |
Example: |
2484 |
|
|
2485 |
|
|
2513 |
|
|
2514 |
Possible Answers: |
Possible Answers: |
2515 |
|
|
2516 |
|
|
2517 |
|
|
2518 |
|
|
2519 |
|
Schoenebeck Expires April 17, 2008 [Page 45] |
2520 |
|
|
2521 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2522 |
|
|
2523 |
|
|
2524 |
LinuxSampler will answer by returning a comma separated list with |
LinuxSampler will answer by returning a comma separated list with |
2525 |
all sampler channels numerical IDs. |
all sampler channels numerical IDs. |
2526 |
|
|
2535 |
A new sampler channel can be added to the end of the sampler channel |
A new sampler channel can be added to the end of the sampler channel |
2536 |
list by sending the following command: |
list by sending the following command: |
2537 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 44] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2538 |
ADD CHANNEL |
ADD CHANNEL |
2539 |
|
|
2540 |
This will increment the sampler channel count by one and the new |
This will increment the sampler channel count by one and the new |
2571 |
|
|
2572 |
|
|
2573 |
|
|
2574 |
|
|
2575 |
|
Schoenebeck Expires April 17, 2008 [Page 46] |
2576 |
|
|
2577 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2578 |
|
|
2579 |
|
|
2580 |
|
|
2581 |
|
|
2582 |
6.4.6. Removing a sampler channel |
6.4.6. Removing a sampler channel |
2583 |
|
|
2584 |
A sampler channel can be removed by sending the following command: |
A sampler channel can be removed by sending the following command: |
2592 |
|
|
2593 |
Possible Answers: |
Possible Answers: |
2594 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 45] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2595 |
"OK" - |
"OK" - |
2596 |
|
|
2597 |
in case the given sampler channel could be removed |
in case the given sampler channel could be removed |
2625 |
|
|
2626 |
Example: |
Example: |
2627 |
|
|
2628 |
|
|
2629 |
|
|
2630 |
|
|
2631 |
|
Schoenebeck Expires April 17, 2008 [Page 47] |
2632 |
|
|
2633 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2634 |
|
|
2635 |
|
|
2636 |
C: "GET AVAILABLE_ENGINES" |
C: "GET AVAILABLE_ENGINES" |
2637 |
|
|
2638 |
S: "4" |
S: "4" |
2646 |
|
|
2647 |
Possible Answers: |
Possible Answers: |
2648 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 46] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2649 |
LinuxSampler will answer by sending a comma separated list of the |
LinuxSampler will answer by sending a comma separated list of the |
2650 |
engines' names encapsulated into apostrophes ('). Engine names |
engines' names encapsulated into apostrophes ('). Engine names |
2651 |
can consist of lower and upper cases, digits and underlines ("_" |
can consist of lower and upper cases, digits and underlines ("_" |
2679 |
|
|
2680 |
DESCRIPTION - |
DESCRIPTION - |
2681 |
|
|
2682 |
arbitrary description text about the engine |
arbitrary description text about the engine (note that the |
2683 |
|
character string may contain escape sequences (Section 7.1)) |
2684 |
|
|
2685 |
|
|
2686 |
|
|
2687 |
|
Schoenebeck Expires April 17, 2008 [Page 48] |
2688 |
|
|
2689 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2690 |
|
|
2691 |
|
|
2692 |
VERSION - |
VERSION - |
2693 |
|
|
2701 |
|
|
2702 |
S: "DESCRIPTION: this is Joe's custom sampler engine" |
S: "DESCRIPTION: this is Joe's custom sampler engine" |
2703 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 47] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2704 |
"VERSION: testing-1.0" |
"VERSION: testing-1.0" |
2705 |
|
|
2706 |
"." |
"." |
2737 |
numerical ID of the audio output device which is currently |
numerical ID of the audio output device which is currently |
2738 |
connected to this sampler channel to output the audio |
connected to this sampler channel to output the audio |
2739 |
signal, "NONE" if there's no device connected to this |
signal, "NONE" if there's no device connected to this |
2740 |
|
|
2741 |
|
|
2742 |
|
|
2743 |
|
Schoenebeck Expires April 17, 2008 [Page 49] |
2744 |
|
|
2745 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2746 |
|
|
2747 |
|
|
2748 |
sampler channel |
sampler channel |
2749 |
|
|
2750 |
AUDIO_OUTPUT_CHANNELS - |
AUDIO_OUTPUT_CHANNELS - |
2757 |
comma separated list which reflects to which audio channel |
comma separated list which reflects to which audio channel |
2758 |
of the selected audio output device each sampler output |
of the selected audio output device each sampler output |
2759 |
channel is routed to, e.g. "0,3" would mean the engine's |
channel is routed to, e.g. "0,3" would mean the engine's |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 48] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2760 |
output channel 0 is routed to channel 0 of the audio output |
output channel 0 is routed to channel 0 of the audio output |
2761 |
device and the engine's output channel 1 is routed to the |
device and the engine's output channel 1 is routed to the |
2762 |
channel 3 of the audio output device |
channel 3 of the audio output device |
2764 |
INSTRUMENT_FILE - |
INSTRUMENT_FILE - |
2765 |
|
|
2766 |
the file name of the loaded instrument, "NONE" if there's no |
the file name of the loaded instrument, "NONE" if there's no |
2767 |
instrument yet loaded for this sampler channel |
instrument yet loaded for this sampler channel (note: since |
2768 |
|
LSCP 1.2 this path may contain escape sequences |
2769 |
|
(Section 7.1)) |
2770 |
|
|
2771 |
INSTRUMENT_NR - |
INSTRUMENT_NR - |
2772 |
|
|
2774 |
|
|
2775 |
INSTRUMENT_NAME - |
INSTRUMENT_NAME - |
2776 |
|
|
2777 |
the instrument name of the loaded instrument |
the instrument name of the loaded instrument (note: since |
2778 |
|
LSCP 1.2 this character string may contain escape sequences |
2779 |
|
(Section 7.1)) |
2780 |
|
|
2781 |
INSTRUMENT_STATUS - |
INSTRUMENT_STATUS - |
2782 |
|
|
2792 |
commands, "NONE" if there's no device connected to this |
commands, "NONE" if there's no device connected to this |
2793 |
sampler channel |
sampler channel |
2794 |
|
|
2795 |
|
|
2796 |
|
|
2797 |
|
|
2798 |
|
|
2799 |
|
Schoenebeck Expires April 17, 2008 [Page 50] |
2800 |
|
|
2801 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2802 |
|
|
2803 |
|
|
2804 |
MIDI_INPUT_PORT - |
MIDI_INPUT_PORT - |
2805 |
|
|
2806 |
port number of the MIDI input device |
port number of the MIDI input device |
2816 |
(where a value < 1.0 means attenuation and a value > 1.0 |
(where a value < 1.0 means attenuation and a value > 1.0 |
2817 |
means amplification) |
means amplification) |
2818 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 49] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2819 |
MUTE - |
MUTE - |
2820 |
|
|
2821 |
Determines whether the channel is muted, "true" if the |
Determines whether the channel is muted, "true" if the |
2848 |
|
|
2849 |
"AUDIO_OUTPUT_DEVICE: 0" |
"AUDIO_OUTPUT_DEVICE: 0" |
2850 |
|
|
2851 |
|
|
2852 |
|
|
2853 |
|
|
2854 |
|
|
2855 |
|
Schoenebeck Expires April 17, 2008 [Page 51] |
2856 |
|
|
2857 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2858 |
|
|
2859 |
|
|
2860 |
"AUDIO_OUTPUT_CHANNELS: 2" |
"AUDIO_OUTPUT_CHANNELS: 2" |
2861 |
|
|
2862 |
"AUDIO_OUTPUT_ROUTING: 0,1" |
"AUDIO_OUTPUT_ROUTING: 0,1" |
2873 |
|
|
2874 |
"MIDI_INPUT_PORT: 0" |
"MIDI_INPUT_PORT: 0" |
2875 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 50] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2876 |
"MIDI_INPUT_CHANNEL: 5" |
"MIDI_INPUT_CHANNEL: 5" |
2877 |
|
|
2878 |
"VOLUME: 1.0" |
"VOLUME: 1.0" |
2905 |
|
|
2906 |
|
|
2907 |
|
|
2908 |
|
|
2909 |
|
|
2910 |
|
|
2911 |
|
Schoenebeck Expires April 17, 2008 [Page 52] |
2912 |
|
|
2913 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2914 |
|
|
2915 |
|
|
2916 |
|
|
2917 |
|
|
2918 |
6.4.12. Current number of active disk streams |
6.4.12. Current number of active disk streams |
2919 |
|
|
2920 |
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 |
2931 |
LinuxSampler will answer by returning the number of active disk |
LinuxSampler will answer by returning the number of active disk |
2932 |
streams on that channel in case the engine supports disk |
streams on that channel in case the engine supports disk |
2933 |
streaming, if the engine doesn't support disk streaming it will |
streaming, if the engine doesn't support disk streaming it will |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 51] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2934 |
return "NA" for not available. |
return "NA" for not available. |
2935 |
|
|
2936 |
Example: |
Example: |
2961 |
"NA" for *not available* in case the engine which is deployed |
"NA" for *not available* in case the engine which is deployed |
2962 |
doesn't support disk streaming. Each entry in the answer list |
doesn't support disk streaming. Each entry in the answer list |
2963 |
will begin with the stream's ID in brackets followed by the |
will begin with the stream's ID in brackets followed by the |
2964 |
|
|
2965 |
|
|
2966 |
|
|
2967 |
|
Schoenebeck Expires April 17, 2008 [Page 53] |
2968 |
|
|
2969 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
2970 |
|
|
2971 |
|
|
2972 |
numerical representation of the fill size (either in bytes or |
numerical representation of the fill size (either in bytes or |
2973 |
percentage). Note: due to efficiency reasons the fill states in |
percentage). Note: due to efficiency reasons the fill states in |
2974 |
the response are not in particular order, thus the front-end has |
the response are not in particular order, thus the front-end has |
2986 |
|
|
2987 |
C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4" |
C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4" |
2988 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 52] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
2989 |
S: "" |
S: "" |
2990 |
|
|
2991 |
6.4.14. Setting audio output device |
6.4.14. Setting audio output device |
3015 |
issue(s) related, providing an appropriate warning code and |
issue(s) related, providing an appropriate warning code and |
3016 |
warning message |
warning message |
3017 |
|
|
3018 |
|
|
3019 |
|
|
3020 |
|
|
3021 |
|
|
3022 |
|
|
3023 |
|
Schoenebeck Expires April 17, 2008 [Page 54] |
3024 |
|
|
3025 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3026 |
|
|
3027 |
|
|
3028 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
3029 |
|
|
3030 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3044 |
SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output- |
SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output- |
3045 |
type> |
type> |
3046 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 53] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3047 |
Where <audio-output-type> is currently either "ALSA" or "JACK" and |
Where <audio-output-type> is currently either "ALSA" or "JACK" and |
3048 |
<sampler-channel> is the respective sampler channel number. |
<sampler-channel> is the respective sampler channel number. |
3049 |
|
|
3073 |
The front-end can alter the audio output channel on a specific |
The front-end can alter the audio output channel on a specific |
3074 |
sampler channel by sending the following command: |
sampler channel by sending the following command: |
3075 |
|
|
3076 |
|
|
3077 |
|
|
3078 |
|
|
3079 |
|
Schoenebeck Expires April 17, 2008 [Page 55] |
3080 |
|
|
3081 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3082 |
|
|
3083 |
|
|
3084 |
SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out> |
SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out> |
3085 |
<audio-in> |
<audio-in> |
3086 |
|
|
3099 |
|
|
3100 |
"WRN:<warning-code>:<warning-message>" - |
"WRN:<warning-code>:<warning-message>" - |
3101 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 54] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3102 |
if audio output channel was set, but there are noteworthy |
if audio output channel was set, but there are noteworthy |
3103 |
issue(s) related, providing an appropriate warning code and |
issue(s) related, providing an appropriate warning code and |
3104 |
warning message |
warning message |
3127 |
|
|
3128 |
Possible Answers: |
Possible Answers: |
3129 |
|
|
3130 |
|
|
3131 |
|
|
3132 |
|
|
3133 |
|
|
3134 |
|
|
3135 |
|
Schoenebeck Expires April 17, 2008 [Page 56] |
3136 |
|
|
3137 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3138 |
|
|
3139 |
|
|
3140 |
"OK" - |
"OK" - |
3141 |
|
|
3142 |
on success |
on success |
3156 |
|
|
3157 |
|
|
3158 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 55] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3159 |
6.4.18. Setting MIDI input type |
6.4.18. Setting MIDI input type |
3160 |
|
|
3161 |
DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON! |
DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON! |
3185 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3186 |
error message |
error message |
3187 |
|
|
3188 |
|
|
3189 |
|
|
3190 |
|
|
3191 |
|
Schoenebeck Expires April 17, 2008 [Page 57] |
3192 |
|
|
3193 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3194 |
|
|
3195 |
|
|
3196 |
Examples: |
Examples: |
3197 |
|
|
3198 |
|
|
3211 |
|
|
3212 |
"OK" - |
"OK" - |
3213 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 56] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3214 |
on success |
on success |
3215 |
|
|
3216 |
"WRN:<warning-code>:<warning-message>" - |
"WRN:<warning-code>:<warning-message>" - |
3241 |
|
|
3242 |
Possible Answers: |
Possible Answers: |
3243 |
|
|
3244 |
|
|
3245 |
|
|
3246 |
|
|
3247 |
|
Schoenebeck Expires April 17, 2008 [Page 58] |
3248 |
|
|
3249 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3250 |
|
|
3251 |
|
|
3252 |
"OK" - |
"OK" - |
3253 |
|
|
3254 |
on success |
on success |
3268 |
|
|
3269 |
|
|
3270 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 57] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
|
|
|
|
|
|
3271 |
6.4.21. Setting channel volume |
6.4.21. Setting channel volume |
3272 |
|
|
3273 |
The front-end can alter the volume of a sampler channel by sending |
The front-end can alter the volume of a sampler channel by sending |
3297 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3298 |
error message |
error message |
3299 |
|
|
3300 |
|
|
3301 |
|
|
3302 |
|
|
3303 |
|
Schoenebeck Expires April 17, 2008 [Page 59] |
3304 |
|
|
3305 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3306 |
|
|
3307 |
|
|
3308 |
Examples: |
Examples: |
3309 |
|
|
3310 |
|
|
3323 |
|
|
3324 |
Possible Answers: |
Possible Answers: |
3325 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 58] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3326 |
"OK" - |
"OK" - |
3327 |
|
|
3328 |
on success |
on success |
3354 |
(Section 6.4.4) command and <solo> should be replaced either by "1" |
(Section 6.4.4) command and <solo> should be replaced either by "1" |
3355 |
to solo the channel or "0" to unsolo the channel. |
to solo the channel or "0" to unsolo the channel. |
3356 |
|
|
3357 |
|
|
3358 |
|
|
3359 |
|
Schoenebeck Expires April 17, 2008 [Page 60] |
3360 |
|
|
3361 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3362 |
|
|
3363 |
|
|
3364 |
Possible Answers: |
Possible Answers: |
3365 |
|
|
3366 |
"OK" - |
"OK" - |
3378 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3379 |
error message |
error message |
3380 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 59] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3381 |
Examples: |
Examples: |
3382 |
|
|
3383 |
|
|
3409 |
|
|
3410 |
You can assign a specific MIDI instrument map by replacing |
You can assign a specific MIDI instrument map by replacing |
3411 |
<map> with the respective numeric ID of the MIDI instrument map |
<map> with the respective numeric ID of the MIDI instrument map |
3412 |
|
|
3413 |
|
|
3414 |
|
|
3415 |
|
Schoenebeck Expires April 17, 2008 [Page 61] |
3416 |
|
|
3417 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3418 |
|
|
3419 |
|
|
3420 |
as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) |
as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) |
3421 |
command. Once that map will be deleted, the sampler channel |
command. Once that map will be deleted, the sampler channel |
3422 |
would fall back to "NONE". |
would fall back to "NONE". |
3435 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3436 |
error message |
error message |
3437 |
|
|
3438 |
|
Examples: |
3439 |
|
|
3440 |
|
|
3441 |
Schoenebeck Expires June 18, 2007 [Page 60] |
|
3442 |
|
6.4.25. Adding an effect send to a sampler channel |
3443 |
|
|
3444 |
|
The front-end can create an additional effect send on a specific |
3445 |
|
sampler channel by sending the following command: |
3446 |
|
|
3447 |
|
CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>] |
3448 |
|
|
3449 |
|
Where <sampler-channel> is the respective sampler channel number as |
3450 |
|
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3451 |
|
(Section 6.4.4) command, that is the sampler channel on which the |
3452 |
|
effect send should be created on, <midi-ctrl> is a number between |
3453 |
|
0..127 defining the MIDI controller which can alter the effect send |
3454 |
|
level and <name> is an optional argument defining a name for the |
3455 |
|
effect send entity. The name does not have to be unique, but MUST be |
3456 |
|
encapsulated into apostrophes and supports escape sequences as |
3457 |
|
described in chapter "Character Set and Escape Sequences |
3458 |
|
(Section 7.1)". |
3459 |
|
|
3460 |
|
By default, that is as initial routing, the effect send's audio |
3461 |
|
channels are automatically routed to the last audio channels of the |
3462 |
|
sampler channel's audio output device, that way you can i.e. first |
3463 |
|
increase the amount of audio channels on the audio output device for |
3464 |
|
having dedicated effect send output channels and when "CREATE |
3465 |
|
FX_SEND" is called, those channels will automatically be picked. You |
3466 |
|
can alter the destination channels however with "SET FX_SEND |
3467 |
|
AUDIO_OUTPUT_CHANNEL" (Section 6.4.31). |
3468 |
|
|
3469 |
|
|
3470 |
|
|
3471 |
|
Schoenebeck Expires April 17, 2008 [Page 62] |
3472 |
|
|
3473 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
3474 |
|
|
3475 |
|
|
3476 |
|
Note: Create effect sends on a sampler channel only when needed, |
3477 |
|
because having effect sends on a sampler channel will decrease |
3478 |
|
runtime performance, because for implementing channel effect sends, |
3479 |
|
separate (sampler channel local) audio buffers are needed to render |
3480 |
|
and mix the voices and route the audio signal afterwards to the |
3481 |
|
master outputs and effect send outputs (along with their respective |
3482 |
|
effect send levels). A sampler channel without effect sends however |
3483 |
|
can mix its voices directly into the audio output devices's audio |
3484 |
|
buffers and is thus faster. |
3485 |
|
|
3486 |
|
Possible Answers: |
3487 |
|
|
3488 |
|
"OK[<fx-send-id>]" - |
3489 |
|
|
3490 |
|
in case a new effect send could be added to the sampler |
3491 |
|
channel, where <fx-send-id> reflects the unique ID of the newly |
3492 |
|
created effect send entity |
3493 |
|
|
3494 |
|
"ERR:<error-code>:<error-message>" - |
3495 |
|
|
3496 |
|
when a new effect send could not be added, i.e. due to invalid |
3497 |
|
parameters |
3498 |
|
|
3499 |
|
Examples: |
3500 |
|
|
3501 |
|
C: "CREATE FX_SEND 0 91 'Reverb Send'" |
3502 |
|
|
3503 |
|
S: "OK[0]" |
3504 |
|
|
3505 |
|
C: "CREATE FX_SEND 0 93" |
3506 |
|
|
3507 |
|
S: "OK[1]" |
3508 |
|
|
3509 |
|
6.4.26. Removing an effect send from a sampler channel |
3510 |
|
|
3511 |
|
The front-end can remove an existing effect send on a specific |
3512 |
|
sampler channel by sending the following command: |
3513 |
|
|
3514 |
|
DESTROY FX_SEND <sampler-channel> <fx-send-id> |
3515 |
|
|
3516 |
|
Where <sampler-channel> is the respective sampler channel number as |
3517 |
|
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3518 |
|
(Section 6.4.4) command, that is the sampler channel from which the |
3519 |
|
effect send should be removed from and <fx-send-id> is the respective |
3520 |
|
effect send number as returned by the "CREATE FX_SEND" |
3521 |
|
(Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command. |
3522 |
|
|
3523 |
|
Possible Answers: |
3524 |
|
|
3525 |
|
|
3526 |
|
|
3527 |
|
Schoenebeck Expires April 17, 2008 [Page 63] |
3528 |
|
|
3529 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3530 |
|
|
3531 |
|
|
3532 |
|
"OK" - |
3533 |
|
|
3534 |
|
on success |
3535 |
|
|
3536 |
|
"ERR:<error-code>:<error-message>" - |
3537 |
|
|
3538 |
|
in case it failed, providing an appropriate error code and |
3539 |
|
error message |
3540 |
|
|
3541 |
|
Example: |
3542 |
|
|
3543 |
|
C: "DESTROY FX_SEND 0 0" |
3544 |
|
|
3545 |
|
S: "OK" |
3546 |
|
|
3547 |
|
6.4.27. Getting amount of effect sends on a sampler channel |
3548 |
|
|
3549 |
|
The front-end can ask for the amount of effect sends on a specific |
3550 |
|
sampler channel by sending the following command: |
3551 |
|
|
3552 |
|
GET FX_SENDS <sampler-channel> |
3553 |
|
|
3554 |
|
Where <sampler-channel> is the respective sampler channel number as |
3555 |
|
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3556 |
|
(Section 6.4.4) command. |
3557 |
|
|
3558 |
|
Possible Answers: |
3559 |
|
|
3560 |
|
The sampler will answer by returning the number of effect sends on |
3561 |
|
the given sampler channel. |
3562 |
|
|
3563 |
|
Example: |
3564 |
|
|
3565 |
|
C: "GET FX_SENDS 0" |
3566 |
|
|
3567 |
|
S: "2" |
3568 |
|
|
3569 |
|
6.4.28. Listing all effect sends on a sampler channel |
3570 |
|
|
3571 |
|
The front-end can ask for a list of effect sends on a specific |
3572 |
|
sampler channel by sending the following command: |
3573 |
|
|
3574 |
|
LIST FX_SENDS <sampler-channel> |
3575 |
|
|
3576 |
|
Where <sampler-channel> is the respective sampler channel number as |
3577 |
|
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3578 |
|
(Section 6.4.4) command. |
3579 |
|
|
3580 |
|
|
3581 |
|
|
3582 |
|
|
3583 |
|
Schoenebeck Expires April 17, 2008 [Page 64] |
3584 |
|
|
3585 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3586 |
|
|
3587 |
|
|
3588 |
|
Possible Answers: |
3589 |
|
|
3590 |
|
The sampler will answer by returning a comma separated list with |
3591 |
|
all effect sends' numerical IDs on the given sampler channel. |
3592 |
|
|
3593 |
Examples: |
Examples: |
3594 |
|
|
3595 |
|
C: "LIST FX_SENDS 0" |
3596 |
|
|
3597 |
|
S: "0,1" |
3598 |
|
|
3599 |
6.4.25. Resetting a sampler channel |
C: "LIST FX_SENDS 1" |
3600 |
|
|
3601 |
|
S: "" |
3602 |
|
|
3603 |
|
6.4.29. Getting effect send information |
3604 |
|
|
3605 |
|
The front-end can ask for the current settings of an effect send |
3606 |
|
entity by sending the following command: |
3607 |
|
|
3608 |
|
GET FX_SEND INFO <sampler-channel> <fx-send-id> |
3609 |
|
|
3610 |
|
Where <sampler-channel> is the sampler channel number as returned by |
3611 |
|
the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3612 |
|
command and <fx-send-id> reflects the numerical ID of the effect send |
3613 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3614 |
|
FX_SENDS" (Section 6.4.28) command. |
3615 |
|
|
3616 |
|
Possible Answers: |
3617 |
|
|
3618 |
|
The sampler will answer by sending a <CRLF> separated list. Each |
3619 |
|
answer line begins with the settings category name followed by a |
3620 |
|
colon and then a space character <SP> and finally the info |
3621 |
|
character string to that setting category. At the moment the |
3622 |
|
following categories are defined: |
3623 |
|
|
3624 |
|
|
3625 |
|
|
3626 |
|
NAME - |
3627 |
|
|
3628 |
|
name of the effect send entity (note that this character |
3629 |
|
string may contain escape sequences (Section 7.1)) |
3630 |
|
|
3631 |
|
MIDI_CONTROLLER - |
3632 |
|
|
3633 |
|
a value between 0 and 127 reflecting the MIDI controller |
3634 |
|
which is able to modify the effect send's send level |
3635 |
|
|
3636 |
|
|
3637 |
|
|
3638 |
|
|
3639 |
|
Schoenebeck Expires April 17, 2008 [Page 65] |
3640 |
|
|
3641 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3642 |
|
|
3643 |
|
|
3644 |
|
LEVEL - |
3645 |
|
|
3646 |
|
optionally dotted number reflecting the effect send's |
3647 |
|
current send level (where a value < 1.0 means attenuation |
3648 |
|
and a value > 1.0 means amplification) |
3649 |
|
|
3650 |
|
AUDIO_OUTPUT_ROUTING - |
3651 |
|
|
3652 |
|
comma separated list which reflects to which audio channel |
3653 |
|
of the selected audio output device each effect send output |
3654 |
|
channel is routed to, e.g. "0,3" would mean the effect |
3655 |
|
send's output channel 0 is routed to channel 0 of the audio |
3656 |
|
output device and the effect send's output channel 1 is |
3657 |
|
routed to the channel 3 of the audio output device (see "SET |
3658 |
|
FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details) |
3659 |
|
|
3660 |
|
The mentioned fields above don't have to be in particular order. |
3661 |
|
|
3662 |
|
Example: |
3663 |
|
|
3664 |
|
C: "GET FX_SEND INFO 0 0" |
3665 |
|
|
3666 |
|
S: "NAME: Reverb Send" |
3667 |
|
|
3668 |
|
"MIDI_CONTROLLER: 91" |
3669 |
|
|
3670 |
|
"LEVEL: 0.3" |
3671 |
|
|
3672 |
|
"AUDIO_OUTPUT_ROUTING: 2,3" |
3673 |
|
|
3674 |
|
"." |
3675 |
|
|
3676 |
|
6.4.30. Changing effect send's name |
3677 |
|
|
3678 |
|
The front-end can alter the current name of an effect send entity by |
3679 |
|
sending the following command: |
3680 |
|
|
3681 |
|
SET FX_SEND NAME <sampler-chan> <fx-send-id> <name> |
3682 |
|
|
3683 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3684 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3685 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3686 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3687 |
|
FX_SENDS" (Section 6.4.28) command and <name> is the new name of the |
3688 |
|
effect send entity, which does not have to be unique (name MUST be |
3689 |
|
encapsulated into apostrophes and supports escape sequences as |
3690 |
|
described in chapter "Character Set and Escape Sequences |
3691 |
|
(Section 7.1)"). |
3692 |
|
|
3693 |
|
|
3694 |
|
|
3695 |
|
Schoenebeck Expires April 17, 2008 [Page 66] |
3696 |
|
|
3697 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3698 |
|
|
3699 |
|
|
3700 |
|
Possible Answers: |
3701 |
|
|
3702 |
|
"OK" - |
3703 |
|
|
3704 |
|
on success |
3705 |
|
|
3706 |
|
"ERR:<error-code>:<error-message>" - |
3707 |
|
|
3708 |
|
in case it failed, providing an appropriate error code and |
3709 |
|
error message |
3710 |
|
|
3711 |
|
Example: |
3712 |
|
|
3713 |
|
C: "SET FX_SEND NAME 0 0 'Fx Send 1'" |
3714 |
|
|
3715 |
|
S: "OK" |
3716 |
|
|
3717 |
|
6.4.31. Altering effect send's audio routing |
3718 |
|
|
3719 |
|
The front-end can alter the destination of an effect send's audio |
3720 |
|
channel on a specific sampler channel by sending the following |
3721 |
|
command: |
3722 |
|
|
3723 |
|
SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> |
3724 |
|
<audio-src> <audio-dst> |
3725 |
|
|
3726 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3727 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3728 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3729 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3730 |
|
FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID |
3731 |
|
of the effect send's audio channel which should be rerouted and |
3732 |
|
<audio-dst> is the numerical ID of the audio channel of the selected |
3733 |
|
audio output device where <audio-src> should be routed to. |
3734 |
|
|
3735 |
|
Note that effect sends can only route audio to the same audio output |
3736 |
|
device as assigned to the effect send's sampler channel. Also note |
3737 |
|
that an effect send entity does always have exactly as much audio |
3738 |
|
channels as its sampler channel. So if the sampler channel is |
3739 |
|
stereo, the effect send does have two audio channels as well. Also |
3740 |
|
keep in mind that the amount of audio channels on a sampler channel |
3741 |
|
might be dependant not only to the deployed sampler engine on the |
3742 |
|
sampler channel, but also dependant to the instrument currently |
3743 |
|
loaded. However you can (effectively) turn an i.e. stereo effect |
3744 |
|
send into a mono one by simply altering its audio routing |
3745 |
|
appropriately. |
3746 |
|
|
3747 |
|
Possible Answers: |
3748 |
|
|
3749 |
|
|
3750 |
|
|
3751 |
|
Schoenebeck Expires April 17, 2008 [Page 67] |
3752 |
|
|
3753 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3754 |
|
|
3755 |
|
|
3756 |
|
"OK" - |
3757 |
|
|
3758 |
|
on success |
3759 |
|
|
3760 |
|
"WRN:<warning-code>:<warning-message>" - |
3761 |
|
|
3762 |
|
if audio output channel was set, but there are noteworthy |
3763 |
|
issue(s) related, providing an appropriate warning code and |
3764 |
|
warning message |
3765 |
|
|
3766 |
|
"ERR:<error-code>:<error-message>" - |
3767 |
|
|
3768 |
|
in case it failed, providing an appropriate error code and |
3769 |
|
error message |
3770 |
|
|
3771 |
|
Example: |
3772 |
|
|
3773 |
|
C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2" |
3774 |
|
|
3775 |
|
S: "OK" |
3776 |
|
|
3777 |
|
6.4.32. Altering effect send's MIDI controller |
3778 |
|
|
3779 |
|
The front-end can alter the MIDI controller of an effect send entity |
3780 |
|
by sending the following command: |
3781 |
|
|
3782 |
|
SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi- |
3783 |
|
ctrl> |
3784 |
|
|
3785 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3786 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3787 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3788 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3789 |
|
FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI |
3790 |
|
controller which shall be able to modify the effect send's send |
3791 |
|
level. |
3792 |
|
|
3793 |
|
Possible Answers: |
3794 |
|
|
3795 |
|
"OK" - |
3796 |
|
|
3797 |
|
on success |
3798 |
|
|
3799 |
|
"WRN:<warning-code>:<warning-message>" - |
3800 |
|
|
3801 |
|
if MIDI controller was set, but there are noteworthy issue(s) |
3802 |
|
related, providing an appropriate warning code and warning |
3803 |
|
message |
3804 |
|
|
3805 |
|
|
3806 |
|
|
3807 |
|
Schoenebeck Expires April 17, 2008 [Page 68] |
3808 |
|
|
3809 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3810 |
|
|
3811 |
|
|
3812 |
|
"ERR:<error-code>:<error-message>" - |
3813 |
|
|
3814 |
|
in case it failed, providing an appropriate error code and |
3815 |
|
error message |
3816 |
|
|
3817 |
|
Example: |
3818 |
|
|
3819 |
|
C: "SET FX_SEND MIDI_CONTROLLER 0 0 91" |
3820 |
|
|
3821 |
|
S: "OK" |
3822 |
|
|
3823 |
|
6.4.33. Altering effect send's send level |
3824 |
|
|
3825 |
|
The front-end can alter the current send level of an effect send |
3826 |
|
entity by sending the following command: |
3827 |
|
|
3828 |
|
SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume> |
3829 |
|
|
3830 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3831 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3832 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3833 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3834 |
|
FX_SENDS" (Section 6.4.28) command and <volume> is an optionally |
3835 |
|
dotted positive number (a value smaller than 1.0 means attenuation, |
3836 |
|
whereas a value greater than 1.0 means amplification) reflecting the |
3837 |
|
new send level. |
3838 |
|
|
3839 |
|
Possible Answers: |
3840 |
|
|
3841 |
|
"OK" - |
3842 |
|
|
3843 |
|
on success |
3844 |
|
|
3845 |
|
"WRN:<warning-code>:<warning-message>" - |
3846 |
|
|
3847 |
|
if new send level was set, but there are noteworthy issue(s) |
3848 |
|
related, providing an appropriate warning code and warning |
3849 |
|
message |
3850 |
|
|
3851 |
|
"ERR:<error-code>:<error-message>" - |
3852 |
|
|
3853 |
|
in case it failed, providing an appropriate error code and |
3854 |
|
error message |
3855 |
|
|
3856 |
|
Example: |
3857 |
|
|
3858 |
|
|
3859 |
|
|
3860 |
|
|
3861 |
|
|
3862 |
|
|
3863 |
|
Schoenebeck Expires April 17, 2008 [Page 69] |
3864 |
|
|
3865 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
3866 |
|
|
3867 |
|
|
3868 |
|
C: "SET FX_SEND LEVEL 0 0 0.15" |
3869 |
|
|
3870 |
|
S: "OK" |
3871 |
|
|
3872 |
|
6.4.34. Resetting a sampler channel |
3873 |
|
|
3874 |
The front-end can reset a particular sampler channel by sending the |
The front-end can reset a particular sampler channel by sending the |
3875 |
following command: |
following command: |
3916 |
|
|
3917 |
|
|
3918 |
|
|
3919 |
Schoenebeck Expires June 18, 2007 [Page 61] |
Schoenebeck Expires April 17, 2008 [Page 70] |
3920 |
|
|
3921 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
3922 |
|
|
3923 |
|
|
3924 |
SUBSCRIBE <event-id> |
SUBSCRIBE <event-id> |
3972 |
|
|
3973 |
|
|
3974 |
|
|
3975 |
Schoenebeck Expires June 18, 2007 [Page 62] |
Schoenebeck Expires April 17, 2008 [Page 71] |
3976 |
|
|
3977 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
3978 |
|
|
3979 |
|
|
3980 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
4028 |
|
|
4029 |
|
|
4030 |
|
|
4031 |
Schoenebeck Expires June 18, 2007 [Page 63] |
Schoenebeck Expires April 17, 2008 [Page 72] |
4032 |
|
|
4033 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
4034 |
|
|
4035 |
|
|
4036 |
6.6. Global commands |
6.6. Global commands |
4084 |
|
|
4085 |
|
|
4086 |
|
|
4087 |
Schoenebeck Expires June 18, 2007 [Page 64] |
Schoenebeck Expires April 17, 2008 [Page 73] |
4088 |
|
|
4089 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
4090 |
|
|
4091 |
|
|
4092 |
6.6.4. General sampler informations |
6.6.4. General sampler informations |
4108 |
|
|
4109 |
DESCRIPTION - |
DESCRIPTION - |
4110 |
|
|
4111 |
arbitrary textual description about the sampler |
arbitrary textual description about the sampler (note that |
4112 |
|
the character string may contain escape sequences |
4113 |
|
(Section 7.1)) |
4114 |
|
|
4115 |
VERSION - |
VERSION - |
4116 |
|
|
4121 |
version of the LSCP specification the sampler complies with |
version of the LSCP specification the sampler complies with |
4122 |
(see Section 2 for details) |
(see Section 2 for details) |
4123 |
|
|
4124 |
|
INSTRUMENTS_DB_SUPPORT - |
4125 |
|
|
4126 |
|
either yes or no, specifies whether the sampler is build |
4127 |
|
with instruments database support. |
4128 |
|
|
4129 |
The mentioned fields above don't have to be in particular order. |
The mentioned fields above don't have to be in particular order. |
4130 |
Other fields might be added in future. |
Other fields might be added in future. |
4131 |
|
|
4132 |
|
6.6.5. Getting global volume attenuation |
4133 |
|
|
4134 |
|
The client can ask for the current global sampler-wide volume |
4135 |
|
attenuation by sending the following command: |
4136 |
|
|
4137 |
|
GET VOLUME |
4138 |
|
|
4139 |
|
Possible Answers: |
4140 |
|
|
4141 |
|
|
4142 |
|
|
4143 |
|
Schoenebeck Expires April 17, 2008 [Page 74] |
4144 |
|
|
4145 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4146 |
|
|
4147 |
|
|
4148 |
|
The sampler will always answer by returning the optional dotted |
4149 |
|
floating point coefficient, reflecting the current global volume |
4150 |
|
attenuation. |
4151 |
|
|
4152 |
|
Note: it is up to the respective sampler engine whether to obey that |
4153 |
|
global volume parameter or not, but in general all engines SHOULD use |
4154 |
|
this parameter. |
4155 |
|
|
4156 |
|
6.6.6. Setting global volume attenuation |
4157 |
|
|
4158 |
|
The client can alter the current global sampler-wide volume |
4159 |
|
attenuation by sending the following command: |
4160 |
|
|
4161 |
|
SET VOLUME <volume> |
4162 |
|
|
4163 |
|
Where <volume> should be replaced by the optional dotted floating |
4164 |
|
point value, reflecting the new global volume parameter. This value |
4165 |
|
might usually be in the range between 0.0 and 1.0, that is for |
4166 |
|
attenuating the overall volume. |
4167 |
|
|
4168 |
|
Possible Answers: |
4169 |
|
|
4170 |
|
"OK" - |
4171 |
|
|
4172 |
|
on success |
4173 |
|
|
4174 |
|
"WRN:<warning-code>:<warning-message>" - |
4175 |
|
|
4176 |
|
if the global volume was set, but there are noteworthy issue(s) |
4177 |
|
related, providing an appropriate warning code and warning |
4178 |
|
message |
4179 |
|
|
4180 |
|
"ERR:<error-code>:<error-message>" - |
4181 |
|
|
4182 |
|
in case it failed, providing an appropriate error code and |
4183 |
|
error message |
4184 |
|
|
4185 |
6.7. MIDI Instrument Mapping |
6.7. MIDI Instrument Mapping |
4186 |
|
|
4187 |
The MIDI protocol provides a way to switch between instruments by |
The MIDI protocol provides a way to switch between instruments by |
4194 |
maps which define which instrument to load on which MIDI program |
maps which define which instrument to load on which MIDI program |
4195 |
change message. |
change message. |
4196 |
|
|
|
By default, that is when the sampler is launched, there is no map, |
|
|
thus the sampler will simply ignore all program change messages. The |
|
|
front-end has to explicitly create at least one map, add entries to |
|
|
|
|
4197 |
|
|
4198 |
|
|
4199 |
Schoenebeck Expires June 18, 2007 [Page 65] |
Schoenebeck Expires April 17, 2008 [Page 75] |
4200 |
|
|
4201 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
4202 |
|
|
4203 |
|
|
4204 |
|
By default, that is when the sampler is launched, there is no map, |
4205 |
|
thus the sampler will simply ignore all program change messages. The |
4206 |
|
front-end has to explicitly create at least one map, add entries to |
4207 |
the map and tell the respective sampler channel(s) which MIDI |
the map and tell the respective sampler channel(s) which MIDI |
4208 |
instrument map to use, so the sampler knows how to react on a given |
instrument map to use, so the sampler knows how to react on a given |
4209 |
program change message on the respective sampler channel, that is by |
program change message on the respective sampler channel, that is by |
4227 |
ADD MIDI_INSTRUMENT_MAP [<name>] |
ADD MIDI_INSTRUMENT_MAP [<name>] |
4228 |
|
|
4229 |
Where <name> is an optional argument allowing to assign a custom name |
Where <name> is an optional argument allowing to assign a custom name |
4230 |
to the new map. MIDI instrument Map names do not have to be unique. |
to the new map. MIDI instrument Map names do not have to be unique, |
4231 |
|
but MUST be encapsulated into apostrophes and support escape |
4232 |
|
sequences as described in chapter "Character Set and Escape Sequences |
4233 |
|
(Section 7.1)". |
4234 |
|
|
4235 |
Possible Answers: |
Possible Answers: |
4236 |
|
|
4248 |
|
|
4249 |
C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'" |
C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'" |
4250 |
|
|
|
S: "OK[0]" |
|
4251 |
|
|
|
C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'" |
|
4252 |
|
|
|
S: "OK[1]" |
|
4253 |
|
|
4254 |
|
|
4255 |
|
Schoenebeck Expires April 17, 2008 [Page 76] |
4256 |
|
|
4257 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4258 |
|
|
4259 |
|
|
4260 |
|
S: "OK[0]" |
4261 |
|
|
4262 |
Schoenebeck Expires June 18, 2007 [Page 66] |
C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'" |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
4263 |
|
|
4264 |
|
S: "OK[1]" |
4265 |
|
|
4266 |
C: "ADD MIDI_INSTRUMENT_MAP" |
C: "ADD MIDI_INSTRUMENT_MAP" |
4267 |
|
|
4302 |
|
|
4303 |
S: "OK" |
S: "OK" |
4304 |
|
|
|
6.7.3. Get amount of existing MIDI instrument maps |
|
|
|
|
|
The front-end can retrieve the current amount of MIDI instrument maps |
|
|
by sending the following command: |
|
4305 |
|
|
|
GET MIDI_INSTRUMENT_MAPS |
|
4306 |
|
|
|
Possible Answers: |
|
4307 |
|
|
4308 |
|
|
4309 |
|
|
4310 |
|
|
4311 |
Schoenebeck Expires June 18, 2007 [Page 67] |
Schoenebeck Expires April 17, 2008 [Page 77] |
4312 |
|
|
4313 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
4314 |
|
|
4315 |
|
|
4316 |
|
6.7.3. Get amount of existing MIDI instrument maps |
4317 |
|
|
4318 |
|
The front-end can retrieve the current amount of MIDI instrument maps |
4319 |
|
by sending the following command: |
4320 |
|
|
4321 |
|
GET MIDI_INSTRUMENT_MAPS |
4322 |
|
|
4323 |
|
Possible Answers: |
4324 |
|
|
4325 |
The sampler will answer by returning the current number of MIDI |
The sampler will answer by returning the current number of MIDI |
4326 |
instrument maps. |
instrument maps. |
4327 |
|
|
4361 |
interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS" |
interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS" |
4362 |
(Section 6.7.4) command. |
(Section 6.7.4) command. |
4363 |
|
|
4364 |
|
|
4365 |
|
|
4366 |
|
|
4367 |
|
Schoenebeck Expires April 17, 2008 [Page 78] |
4368 |
|
|
4369 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4370 |
|
|
4371 |
|
|
4372 |
Possible Answers: |
Possible Answers: |
4373 |
|
|
4374 |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
4379 |
|
|
4380 |
|
|
4381 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 68] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
|
|
|
|
|
|
4382 |
NAME - |
NAME - |
4383 |
|
|
4384 |
custom name of the given map, which does not have to be |
custom name of the given map, which does not have to be |
4385 |
unique |
unique (note that this character string may contain escape |
4386 |
|
sequences (Section 7.1)) |
4387 |
|
|
4388 |
|
DEFAULT - |
4389 |
|
|
4390 |
|
either true or false, defines whether this map is the |
4391 |
|
default map |
4392 |
|
|
4393 |
The mentioned fields above don't have to be in particular order. |
The mentioned fields above don't have to be in particular order. |
4394 |
|
|
4398 |
|
|
4399 |
S: "NAME: Standard Map" |
S: "NAME: Standard Map" |
4400 |
|
|
4401 |
|
"DEFAULT: true" |
4402 |
|
|
4403 |
"." |
"." |
4404 |
|
|
4405 |
6.7.6. Renaming a MIDI instrument map |
6.7.6. Renaming a MIDI instrument map |
4410 |
SET MIDI_INSTRUMENT_MAP NAME <map> <name> |
SET MIDI_INSTRUMENT_MAP NAME <map> <name> |
4411 |
|
|
4412 |
Where <map> is the numerical ID of the map and <name> the new custom |
Where <map> is the numerical ID of the map and <name> the new custom |
4413 |
name of the map, which does not have to be unique. |
name of the map, which does not have to be unique (name MUST be |
4414 |
|
encapsulated into apostrophes and supports escape sequences as |
4415 |
|
described in chapter "Character Set and Escape Sequences |
4416 |
|
(Section 7.1)"). |
4417 |
|
|
4418 |
Possible Answers: |
Possible Answers: |
4419 |
|
|
4420 |
|
|
4421 |
|
|
4422 |
|
|
4423 |
|
Schoenebeck Expires April 17, 2008 [Page 79] |
4424 |
|
|
4425 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4426 |
|
|
4427 |
|
|
4428 |
"OK" - |
"OK" - |
4429 |
|
|
4430 |
on success |
on success |
4444 |
The front-end can create a new or replace an existing entry in a |
The front-end can create a new or replace an existing entry in a |
4445 |
sampler's MIDI instrument map by sending the following command: |
sampler's MIDI instrument map by sending the following command: |
4446 |
|
|
4447 |
|
MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog> |
4448 |
|
<engine_name> <filename> <instrument_index> <volume_value> |
4449 |
|
[<instr_load_mode>] [<name>] |
|
Schoenebeck Expires June 18, 2007 [Page 69] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
|
MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name> |
|
|
<filename> <instrument_index> <volume_value> [<instr_load_mode>] |
|
|
[<name>] |
|
4450 |
|
|
4451 |
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 |
4452 |
integer value between 0..16383 reflecting the MIDI bank select index, |
integer value between 0..16383 reflecting the MIDI bank select index, |
4454 |
program change index, <engine_name> a sampler engine name as returned |
program change index, <engine_name> a sampler engine name as returned |
4455 |
by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not |
by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not |
4456 |
encapsulated into apostrophes), <filename> the name of the |
encapsulated into apostrophes), <filename> the name of the |
4457 |
instrument's file to be deployed (encapsulated into apostrophes), |
instrument's file to be deployed (encapsulated into apostrophes, |
4458 |
<instrument_index> the index (integer value) of the instrument within |
supporting escape sequences as described in chapter "Character Set |
4459 |
the given file, <volume_value> reflects the master volume of the |
and Escape Sequences (Section 7.1)"), <instrument_index> the index |
4460 |
instrument as optionally dotted number (where a value < 1.0 means |
(integer value) of the instrument within the given file, |
4461 |
attenuation and a value > 1.0 means amplification). This parameter |
<volume_value> reflects the master volume of the instrument as |
4462 |
easily allows to adjust the volume of all intruments within a custom |
optionally dotted number (where a value < 1.0 means attenuation and a |
4463 |
instrument map without having to adjust their instrument files. The |
value > 1.0 means amplification). This parameter easily allows to |
4464 |
OPTIONAL <instr_load_mode> argument defines the life time of the |
adjust the volume of all intruments within a custom instrument map |
4465 |
instrument, that is when the instrument should be loaded, when freed |
without having to adjust their instrument files. The OPTIONAL |
4466 |
and has exactly the following possibilities: |
<instr_load_mode> argument defines the life time of the instrument, |
4467 |
|
that is when the instrument should be loaded, when freed and has |
4468 |
|
exactly the following possibilities: |
4469 |
|
|
4470 |
"ON_DEMAND" - |
"ON_DEMAND" - |
4471 |
|
|
4474 |
be freed from memory when not needed by any sampler channel |
be freed from memory when not needed by any sampler channel |
4475 |
anymore. |
anymore. |
4476 |
|
|
4477 |
|
|
4478 |
|
|
4479 |
|
Schoenebeck Expires April 17, 2008 [Page 80] |
4480 |
|
|
4481 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4482 |
|
|
4483 |
|
|
4484 |
"ON_DEMAND_HOLD" - |
"ON_DEMAND_HOLD" - |
4485 |
|
|
4486 |
The instrument will be loaded when needed, that is when |
The instrument will be loaded when needed, that is when |
4493 |
|
|
4494 |
"PERSISTENT" - |
"PERSISTENT" - |
4495 |
|
|
4496 |
The instrument will immediately be loaded into memory in the |
The instrument will immediately be loaded into memory when this |
4497 |
background when this mapping command is sent and the instrument |
mapping command is sent and the instrument is kept all the |
4498 |
is kept all the time. Instruments with this mode are only |
time. Instruments with this mode are only freed when the |
4499 |
freed when the sampler is reset or all mapping entries with |
sampler is reset or all mapping entries with this mode (and |
4500 |
this mode (and respective instrument) are explicitly changed to |
respective instrument) are explicitly changed to "ON_DEMAND" |
4501 |
"ON_DEMAND" and no sampler channel is using the instrument |
and no sampler channel is using the instrument anymore. |
|
anymore. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 70] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
4502 |
|
|
4503 |
not supplied - |
not supplied - |
4504 |
|
|
4525 |
frontend should retrieve the actual mode by i.e. sending "GET |
frontend should retrieve the actual mode by i.e. sending "GET |
4526 |
MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s). Finally the |
MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s). Finally the |
4527 |
OPTIONAL <name> argument allows to set a custom name (encapsulated |
OPTIONAL <name> argument allows to set a custom name (encapsulated |
4528 |
into apostrophes) for the mapping entry, useful for frontends for |
into apostrophes, supporting escape sequences as described in chapter |
4529 |
displaying an appropriate name for mapped instruments (using "GET |
"Character Set and Escape Sequences (Section 7.1)") for the mapping |
4530 |
MIDI_INSTRUMENT INFO" (Section 6.7.11)). |
entry, useful for frontends for displaying an appropriate name for |
4531 |
|
mapped instruments (using "GET MIDI_INSTRUMENT INFO" |
4532 |
The "MAP MIDI_INSTRUMENT" command will immediately return, thus it |
|
4533 |
will not block when an instrument is to be loaded due to a |
|
4534 |
"PERSISTENT" type entry as instruments are loaded in the background. |
|
4535 |
As a consequence this command may not necessarily return an error |
Schoenebeck Expires April 17, 2008 [Page 81] |
4536 |
i.e. when the given instrument file does not exist or may turn out to |
|
4537 |
be corrupt. |
Internet-Draft LinuxSampler Control Protocol October 2007 |
4538 |
|
|
4539 |
|
|
4540 |
|
(Section 6.7.11)). |
4541 |
|
|
4542 |
|
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
4543 |
|
completely established in the sampler. The OPTIONAL "NON_MODAL" |
4544 |
|
argument however causes the respective "MAP MIDI_INSTRUMENT" command |
4545 |
|
to return immediately, that is to let the sampler establish the |
4546 |
|
mapping in the background. So this argument might be especially |
4547 |
|
useful for mappings with a "PERSISTENT" type, because these have to |
4548 |
|
load the respective instruments immediately and might thus block for |
4549 |
|
a very long time. It is recommended however to use the OPTIONAL |
4550 |
|
"NON_MODAL" argument only if really necessary, because it has the |
4551 |
|
following drawbacks: as "NON_MODAL" instructions return immediately, |
4552 |
|
they may not necessarily return an error i.e. when the given |
4553 |
|
instrument file turns out to be corrupt, beside that subsequent |
4554 |
|
commands in a LSCP instruction sequence might fail, because mandatory |
4555 |
|
mappings are not yet completed. |
4556 |
|
|
4557 |
Possible Answers: |
Possible Answers: |
4558 |
|
|
4567 |
|
|
4568 |
Examples: |
Examples: |
4569 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 71] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4570 |
C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 |
C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 |
4571 |
0.8 PERSISTENT" |
0.8 PERSISTENT" |
4572 |
|
|
4585 |
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 |
4586 |
'Silent Piano'" |
'Silent Piano'" |
4587 |
|
|
4588 |
|
|
4589 |
|
|
4590 |
|
|
4591 |
|
Schoenebeck Expires April 17, 2008 [Page 82] |
4592 |
|
|
4593 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4594 |
|
|
4595 |
|
|
4596 |
S: "OK" |
S: "OK" |
4597 |
|
|
4598 |
C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 |
C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/ |
4599 |
PERSISTENT 'Foo Drumkit'" |
foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'" |
4600 |
|
|
4601 |
S: "OK" |
S: "OK" |
4602 |
|
|
4623 |
|
|
4624 |
S: "234" |
S: "234" |
4625 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 72] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4626 |
C: "GET MIDI_INSTRUMENTS ALL" |
C: "GET MIDI_INSTRUMENTS ALL" |
4627 |
|
|
4628 |
S: "954" |
S: "954" |
4639 |
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 |
4640 |
all MIDI instrument maps by sending the following command: |
all MIDI instrument maps by sending the following command: |
4641 |
|
|
4642 |
|
|
4643 |
|
|
4644 |
|
|
4645 |
|
|
4646 |
|
|
4647 |
|
Schoenebeck Expires April 17, 2008 [Page 83] |
4648 |
|
|
4649 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4650 |
|
|
4651 |
|
|
4652 |
LIST MIDI_INSTRUMENTS ALL |
LIST MIDI_INSTRUMENTS ALL |
4653 |
|
|
4654 |
Possible Answers: |
Possible Answers: |
4681 |
|
|
4682 |
Possible Answers: |
Possible Answers: |
4683 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 73] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4684 |
"OK" - |
"OK" - |
4685 |
|
|
4686 |
usually |
usually |
4695 |
|
|
4696 |
S: "OK" |
S: "OK" |
4697 |
|
|
4698 |
|
|
4699 |
|
|
4700 |
|
|
4701 |
|
|
4702 |
|
|
4703 |
|
Schoenebeck Expires April 17, 2008 [Page 84] |
4704 |
|
|
4705 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4706 |
|
|
4707 |
|
|
4708 |
6.7.11. Get current settings of MIDI instrument map entry |
6.7.11. Get current settings of MIDI instrument map entry |
4709 |
|
|
4710 |
The front-end can retrieve the current settings of a certain |
The front-end can retrieve the current settings of a certain |
4732 |
name shall be used by frontends for displaying a name for this |
name shall be used by frontends for displaying a name for this |
4733 |
mapped instrument. It can be set and changed with the "MAP |
mapped instrument. It can be set and changed with the "MAP |
4734 |
MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to |
MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to |
4735 |
be unique. |
be unique. (note that this character string may contain escape |
4736 |
|
sequences (Section 7.1)) |
4737 |
|
|
4738 |
"ENGINE_NAME" - |
"ENGINE_NAME" - |
4739 |
|
|
4740 |
Name of the engine to be deployed for this instrument. |
Name of the engine to be deployed for this instrument. |
4741 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 74] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4742 |
"INSTRUMENT_FILE" - |
"INSTRUMENT_FILE" - |
4743 |
|
|
4744 |
File name of the instrument. |
File name of the instrument (note that this path may contain |
4745 |
|
escape sequences (Section 7.1)). |
4746 |
|
|
4747 |
"INSTRUMENT_NR" - |
"INSTRUMENT_NR" - |
4748 |
|
|
4752 |
|
|
4753 |
Name of the loaded instrument as reflected by its file. In |
Name of the loaded instrument as reflected by its file. In |
4754 |
contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
4755 |
cannot be changed. |
cannot be changed (note that this character string may contain |
4756 |
|
|
4757 |
|
|
4758 |
|
|
4759 |
|
Schoenebeck Expires April 17, 2008 [Page 85] |
4760 |
|
|
4761 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4762 |
|
|
4763 |
|
|
4764 |
|
escape sequences (Section 7.1)). |
4765 |
|
|
4766 |
"LOAD_MODE" - |
"LOAD_MODE" - |
4767 |
|
|
4796 |
|
|
4797 |
"." |
"." |
4798 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 75] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4799 |
6.7.12. Clear MIDI instrument map |
6.7.12. Clear MIDI instrument map |
4800 |
|
|
4801 |
The front-end can clear a whole MIDI instrument map, that is delete |
The front-end can clear a whole MIDI instrument map, that is delete |
4808 |
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 |
4809 |
entries of all maps by sending the following command: |
entries of all maps by sending the following command: |
4810 |
|
|
4811 |
|
|
4812 |
|
|
4813 |
|
|
4814 |
|
|
4815 |
|
Schoenebeck Expires April 17, 2008 [Page 86] |
4816 |
|
|
4817 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4818 |
|
|
4819 |
|
|
4820 |
CLEAR MIDI_INSTRUMENTS ALL |
CLEAR MIDI_INSTRUMENTS ALL |
4821 |
|
|
4822 |
The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps, |
The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps, |
4839 |
|
|
4840 |
S: "OK" |
S: "OK" |
4841 |
|
|
4842 |
|
6.8. Managing Instruments Database |
4843 |
|
|
4844 |
|
The following commands describe how to use and manage the instruments |
4845 |
|
database. |
4846 |
|
|
4847 |
|
Notice: |
4848 |
|
|
4849 |
|
All command arguments representing a path or instrument/directory |
4850 |
|
name support escape sequences as described in chapter "Character |
4851 |
|
Set and Escape Sequences (Section 7.1)". |
4852 |
|
|
4853 |
|
All occurrences of a forward slash in instrument and directory |
4854 |
|
names are escaped with its hex (\x2f) or octal (\057) escape |
4855 |
|
sequence. |
4856 |
|
|
4857 |
|
6.8.1. Creating a new instrument directory |
4858 |
|
|
4859 |
|
The front-end can add a new instrument directory to the instruments |
4860 |
|
database by sending the following command: |
4861 |
|
|
4862 |
|
ADD DB_INSTRUMENT_DIRECTORY <dir> |
4863 |
|
|
4864 |
|
Where <dir> is the absolute path name of the directory to be created |
4865 |
|
(encapsulated into apostrophes). |
4866 |
|
|
4867 |
|
Possible Answers: |
4868 |
|
|
4869 |
|
|
4870 |
|
|
4871 |
|
Schoenebeck Expires April 17, 2008 [Page 87] |
4872 |
|
|
4873 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4874 |
|
|
4875 |
|
|
4876 |
|
"OK" - |
4877 |
|
|
4878 |
|
on success |
4879 |
|
|
4880 |
|
"ERR:<error-code>:<error-message>" - |
4881 |
|
|
4882 |
|
when the directory could not be created, which can happen if |
4883 |
|
the directory already exists or the name contains not allowed |
4884 |
|
symbols |
4885 |
|
|
4886 |
|
Examples: |
4887 |
|
|
4888 |
|
C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'" |
4889 |
|
|
4890 |
|
S: "OK" |
4891 |
|
|
4892 |
|
6.8.2. Deleting an instrument directory |
4893 |
|
|
4894 |
|
The front-end can delete a particular instrument directory from the |
4895 |
|
instruments database by sending the following command: |
4896 |
|
|
4897 |
|
REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir> |
4898 |
|
|
4899 |
|
Where <dir> is the absolute path name of the directory to delete. |
4900 |
|
The optional FORCE argument can be used to force the deletion of a |
4901 |
|
non-empty directory and all its content. |
4902 |
|
|
4903 |
|
Possible Answers: |
4904 |
|
|
4905 |
|
"OK" - |
4906 |
|
|
4907 |
|
if the directory is deleted successfully |
4908 |
|
|
4909 |
|
"ERR:<error-code>:<error-message>" - |
4910 |
|
|
4911 |
|
if the given directory does not exist, or if trying to delete a |
4912 |
|
non-empty directory, without using the FORCE argument. |
4913 |
|
|
4914 |
|
Examples: |
4915 |
|
|
4916 |
|
C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'" |
4917 |
|
|
4918 |
|
S: "OK" |
4919 |
|
|
4920 |
|
|
4921 |
|
|
4922 |
|
|
4923 |
|
|
4924 |
|
|
4925 |
|
|
4926 |
|
|
4927 |
|
Schoenebeck Expires April 17, 2008 [Page 88] |
4928 |
|
|
4929 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4930 |
|
|
4931 |
|
|
4932 |
|
6.8.3. Getting amount of instrument directories |
4933 |
|
|
4934 |
|
The front-end can retrieve the current amount of directories in a |
4935 |
|
specific directory by sending the following command: |
4936 |
|
|
4937 |
|
GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir> |
4938 |
|
|
4939 |
|
Where <dir> should be replaced by the absolute path name of the |
4940 |
|
directory. If RECURSIVE is specified, the number of all directories, |
4941 |
|
including those located in subdirectories of the specified directory, |
4942 |
|
will be returned. |
4943 |
|
|
4944 |
|
Possible Answers: |
4945 |
|
|
4946 |
|
The current number of instrument directories in the specified |
4947 |
|
directory. |
4948 |
|
|
4949 |
|
"ERR:<error-code>:<error-message>" - |
4950 |
|
|
4951 |
|
if the given directory does not exist. |
4952 |
|
|
4953 |
|
Example: |
4954 |
|
|
4955 |
|
C: "GET DB_INSTRUMENT_DIRECTORIES '/'" |
4956 |
|
|
4957 |
|
S: "2" |
4958 |
|
|
4959 |
|
6.8.4. Listing all directories in specific directory |
4960 |
|
|
4961 |
|
The front-end can retrieve the current list of directories in |
4962 |
|
specific directory by sending the following command: |
4963 |
|
|
4964 |
|
LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir> |
4965 |
|
|
4966 |
|
Where <dir> should be replaced by the absolute path name of the |
4967 |
|
directory. If RECURSIVE is specified, the absolute path names of all |
4968 |
|
directories, including those located in subdirectories of the |
4969 |
|
specified directory, will be returned. |
4970 |
|
|
4971 |
|
Possible Answers: |
4972 |
|
|
4973 |
|
A comma separated list of all instrument directories (encapsulated |
4974 |
|
into apostrophes) in the specified directory. |
4975 |
|
|
4976 |
|
"ERR:<error-code>:<error-message>" - |
4977 |
|
|
4978 |
|
if the given directory does not exist. |
4979 |
|
|
4980 |
|
|
4981 |
|
|
4982 |
|
|
4983 |
|
Schoenebeck Expires April 17, 2008 [Page 89] |
4984 |
|
|
4985 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
4986 |
|
|
4987 |
|
|
4988 |
|
Example: |
4989 |
|
|
4990 |
|
C: "LIST DB_INSTRUMENT_DIRECTORIES '/'" |
4991 |
|
|
4992 |
|
S: "'Piano Collection','Percussion Collection'" |
4993 |
|
|
4994 |
|
C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'" |
4995 |
|
|
4996 |
|
S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano |
4997 |
|
Collection/Acoustic/New','/Percussion Collection'" |
4998 |
|
|
4999 |
|
6.8.5. Getting instrument directory information |
5000 |
|
|
5001 |
|
The front-end can ask for the current settings of an instrument |
5002 |
|
directory by sending the following command: |
5003 |
|
|
5004 |
|
GET DB_INSTRUMENT_DIRECTORY INFO <dir> |
5005 |
|
|
5006 |
|
Where <dir> should be replaced by the absolute path name of the |
5007 |
|
directory the front-end is interested in. |
5008 |
|
|
5009 |
|
Possible Answers: |
5010 |
|
|
5011 |
|
LinuxSampler will answer by sending a <CRLF> separated list. Each |
5012 |
|
answer line begins with the settings category name followed by a |
5013 |
|
colon and then a space character <SP> and finally the info |
5014 |
|
character string to that setting category. At the moment the |
5015 |
|
following categories are defined: |
5016 |
|
|
5017 |
|
|
5018 |
|
|
5019 |
|
DESCRIPTION - |
5020 |
|
|
5021 |
|
A brief description of the directory content. Note that the |
5022 |
|
character string may contain escape sequences (Section 7.1). |
5023 |
|
|
5024 |
|
CREATED - |
5025 |
|
|
5026 |
|
The creation date and time of the directory, represented in |
5027 |
|
"YYYY-MM-DD HH:MM:SS" format |
5028 |
|
|
5029 |
|
MODIFIED - |
5030 |
|
|
5031 |
|
The date and time of the last modification of the directory, |
5032 |
|
represented in "YYYY-MM-DD HH:MM:SS" format |
5033 |
|
|
5034 |
|
The mentioned fields above don't have to be in particular order. |
5035 |
|
|
5036 |
|
|
5037 |
|
|
5038 |
|
|
5039 |
Schoenebeck Expires June 18, 2007 [Page 76] |
Schoenebeck Expires April 17, 2008 [Page 90] |
5040 |
|
|
5041 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
5042 |
|
|
5043 |
|
|
5044 |
|
Example: |
5045 |
|
|
5046 |
|
C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'" |
5047 |
|
|
5048 |
|
S: "DESCRIPTION: Piano collection of instruments in GigaSampler |
5049 |
|
format." |
5050 |
|
|
5051 |
|
"CREATED: 2007-02-05 10:23:12" |
5052 |
|
|
5053 |
|
"MODIFIED: 2007-04-07 12:50:21" |
5054 |
|
|
5055 |
|
"." |
5056 |
|
|
5057 |
|
6.8.6. Renaming an instrument directory |
5058 |
|
|
5059 |
|
The front-end can alter the name of a specific instrument directory |
5060 |
|
by sending the following command: |
5061 |
|
|
5062 |
|
SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name> |
5063 |
|
|
5064 |
|
Where <dir> is the absolute path name of the directory and <name> is |
5065 |
|
the new name for that directory. |
5066 |
|
|
5067 |
|
Possible Answers: |
5068 |
|
|
5069 |
|
"OK" - |
5070 |
|
|
5071 |
|
on success |
5072 |
|
|
5073 |
|
"ERR:<error-code>:<error-message>" - |
5074 |
|
|
5075 |
|
in case the given directory does not exists, or if a directory |
5076 |
|
with name equal to the new name already exists. |
5077 |
|
|
5078 |
|
Example: |
5079 |
|
|
5080 |
|
C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' |
5081 |
|
'Acoustic'" |
5082 |
|
|
5083 |
|
S: "OK" |
5084 |
|
|
5085 |
|
6.8.7. Moving an instrument directory |
5086 |
|
|
5087 |
|
The front-end can move a specific instrument directory by sending the |
5088 |
|
following command: |
5089 |
|
|
5090 |
|
|
5091 |
|
|
5092 |
|
|
5093 |
|
|
5094 |
|
|
5095 |
|
Schoenebeck Expires April 17, 2008 [Page 91] |
5096 |
|
|
5097 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5098 |
|
|
5099 |
|
|
5100 |
|
MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst> |
5101 |
|
|
5102 |
|
Where <dir> is the absolute path name of the directory to move and |
5103 |
|
<dst> is the location where the directory will be moved to. |
5104 |
|
|
5105 |
|
Possible Answers: |
5106 |
|
|
5107 |
|
"OK" - |
5108 |
|
|
5109 |
|
on success |
5110 |
|
|
5111 |
|
"ERR:<error-code>:<error-message>" - |
5112 |
|
|
5113 |
|
in case a given directory does not exists, or if a directory |
5114 |
|
with name equal to the name of the specified directory already |
5115 |
|
exists in the destination directory. Error is also thrown when |
5116 |
|
trying to move a directory to a subdirectory of itself. |
5117 |
|
|
5118 |
|
Example: |
5119 |
|
|
5120 |
|
C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/ |
5121 |
|
Acoustic'" |
5122 |
|
|
5123 |
|
S: "OK" |
5124 |
|
|
5125 |
|
6.8.8. Copying instrument directories |
5126 |
|
|
5127 |
|
The front-end can copy a specific instrument directory by sending the |
5128 |
|
following command: |
5129 |
|
|
5130 |
|
COPY DB_INSTRUMENT_DIRECTORY <dir> <dst> |
5131 |
|
|
5132 |
|
Where <dir> is the absolute path name of the directory to copy and |
5133 |
|
<dst> is the location where the directory will be copied to. |
5134 |
|
|
5135 |
|
Possible Answers: |
5136 |
|
|
5137 |
|
"OK" - |
5138 |
|
|
5139 |
|
on success |
5140 |
|
|
5141 |
|
"ERR:<error-code>:<error-message>" - |
5142 |
|
|
5143 |
|
in case a given directory does not exists, or if a directory |
5144 |
|
with name equal to the name of the specified directory already |
5145 |
|
exists in the destination directory. Error is also thrown when |
5146 |
|
trying to copy a directory to a subdirectory of itself. |
5147 |
|
|
5148 |
|
|
5149 |
|
|
5150 |
|
|
5151 |
|
Schoenebeck Expires April 17, 2008 [Page 92] |
5152 |
|
|
5153 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5154 |
|
|
5155 |
|
|
5156 |
|
Example: |
5157 |
|
|
5158 |
|
C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' |
5159 |
|
'/Acoustic/Pianos'" |
5160 |
|
|
5161 |
|
S: "OK" |
5162 |
|
|
5163 |
|
6.8.9. Changing the description of directory |
5164 |
|
|
5165 |
|
The front-end can alter the description of a specific instrument |
5166 |
|
directory by sending the following command: |
5167 |
|
|
5168 |
|
SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc> |
5169 |
|
|
5170 |
|
Where <dir> is the absolute path name of the directory and <desc> is |
5171 |
|
the new description for the directory (encapsulated into apostrophes, |
5172 |
|
supporting escape sequences as described in chapter "Character Set |
5173 |
|
and Escape Sequences (Section 7.1)"). |
5174 |
|
|
5175 |
|
Possible Answers: |
5176 |
|
|
5177 |
|
"OK" - |
5178 |
|
|
5179 |
|
on success |
5180 |
|
|
5181 |
|
"ERR:<error-code>:<error-message>" - |
5182 |
|
|
5183 |
|
in case the given directory does not exists. |
5184 |
|
|
5185 |
|
Example: |
5186 |
|
|
5187 |
|
C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A |
5188 |
|
collection of piano instruments in various format.'" |
5189 |
|
|
5190 |
|
S: "OK" |
5191 |
|
|
5192 |
|
6.8.10. Finding directories |
5193 |
|
|
5194 |
|
The front-end can search for directories in specific directory by |
5195 |
|
sending the following command: |
5196 |
|
|
5197 |
|
FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria- |
5198 |
|
list> |
5199 |
|
|
5200 |
|
Where <dir> should be replaced by the absolute path name of the |
5201 |
|
directory to search in. If NON_RECURSIVE is specified, the |
5202 |
|
directories located in subdirectories of the specified directory will |
5203 |
|
not be searched. <criteria-list> is a list of search criterias in |
5204 |
|
|
5205 |
|
|
5206 |
|
|
5207 |
|
Schoenebeck Expires April 17, 2008 [Page 93] |
5208 |
|
|
5209 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5210 |
|
|
5211 |
|
|
5212 |
|
form of "key1=val1 key2=val2 ...". The following criterias are |
5213 |
|
allowed: |
5214 |
|
|
5215 |
|
NAME='<search-string>' |
5216 |
|
|
5217 |
|
Restricts the search to directories, which names satisfy the |
5218 |
|
supplied search string (encapsulated into apostrophes, supporting |
5219 |
|
escape sequences as described in chapter "Character Set and Escape |
5220 |
|
Sequences (Section 7.1)"). |
5221 |
|
|
5222 |
|
CREATED='[<date-after>]..[<date-before>]' |
5223 |
|
|
5224 |
|
Restricts the search to directories, which creation date satisfies |
5225 |
|
the specified period, where <date-after> and <date-before> are in |
5226 |
|
"YYYY-MM-DD HH:MM:SS" format. If <date-after> is omitted the |
5227 |
|
search is restricted to directories created before <date-before>. |
5228 |
|
If <date-before> is omitted, the search is restricted to |
5229 |
|
directories created after <date-after>. |
5230 |
|
|
5231 |
|
MODIFIED='[<date-after>]..[<date-before>]' |
5232 |
|
|
5233 |
|
Restricts the search to directories, which date of last |
5234 |
|
modification satisfies the specified period, where <date-after> |
5235 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. If <date- |
5236 |
|
after> is omitted the search is restricted to directories, which |
5237 |
|
are last modified before <date-before>. If <date-before> is |
5238 |
|
omitted, the search is restricted to directories, which are last |
5239 |
|
modified after <date-after>. |
5240 |
|
|
5241 |
|
DESCRIPTION='<search-string>' |
5242 |
|
|
5243 |
|
Restricts the search to directories with description that |
5244 |
|
satisfies the supplied search string (encapsulated into |
5245 |
|
apostrophes, supporting escape sequences as described in chapter |
5246 |
|
"Character Set and Escape Sequences (Section 7.1)"). |
5247 |
|
|
5248 |
|
Where <search-string> is either a regular expression, or a word list |
5249 |
|
separated with spaces for OR search and with '+' for AND search. |
5250 |
|
|
5251 |
|
Possible Answers: |
5252 |
|
|
5253 |
|
A comma separated list with the absolute path names (encapsulated |
5254 |
|
into apostrophes) of all directories in the specified directory |
5255 |
|
that satisfy the supplied search criterias. |
5256 |
|
|
5257 |
|
"ERR:<error-code>:<error-message>" - |
5258 |
|
|
5259 |
|
|
5260 |
|
|
5261 |
|
|
5262 |
|
|
5263 |
|
Schoenebeck Expires April 17, 2008 [Page 94] |
5264 |
|
|
5265 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5266 |
|
|
5267 |
|
|
5268 |
|
if the given directory does not exist. |
5269 |
|
|
5270 |
|
Example: |
5271 |
|
|
5272 |
|
C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'" |
5273 |
|
|
5274 |
|
S: "'/Piano Collection'" |
5275 |
|
|
5276 |
|
C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09: |
5277 |
|
30:13'" |
5278 |
|
|
5279 |
|
S: "'/Piano Collection','/Percussions'" |
5280 |
|
|
5281 |
|
6.8.11. Adding instruments to the instruments database |
5282 |
|
|
5283 |
|
The front-end can add one or more instruments to the instruments |
5284 |
|
database by sending the following command: |
5285 |
|
|
5286 |
|
ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> |
5287 |
|
[<instr_index>] |
5288 |
|
|
5289 |
|
Where <db_dir> is the absolute path name of a directory (encapsulated |
5290 |
|
into apostrophes) in the instruments database in which only the new |
5291 |
|
instruments (that are not already in the database) will be added, |
5292 |
|
<file_path> is the absolute path name of a file or directory in the |
5293 |
|
file system (encapsulated into apostrophes). In case an instrument |
5294 |
|
file is supplied, only the instruments in the specified file will be |
5295 |
|
added to the instruments database. If the optional <instr_index> |
5296 |
|
(the index of the instrument within the given file) is supplied too, |
5297 |
|
then only the specified instrument will be added. In case a |
5298 |
|
directory is supplied, the instruments in that directory will be |
5299 |
|
added. The OPTIONAL <mode> argument is only applied when a directory |
5300 |
|
is provided as <file_path> and specifies how the scanning will be |
5301 |
|
done and has exactly the following possibilities: |
5302 |
|
|
5303 |
|
"RECURSIVE" - |
5304 |
|
|
5305 |
|
All instruments will be processed, including those in the |
5306 |
|
subdirectories, and the respective subdirectory tree structure |
5307 |
|
will be recreated in the instruments database |
5308 |
|
|
5309 |
|
"NON_RECURSIVE" - |
5310 |
|
|
5311 |
|
Only the instruments in the specified directory will be added, |
5312 |
|
the instruments in the subdirectories will not be processed. |
5313 |
|
|
5314 |
|
|
5315 |
|
|
5316 |
|
|
5317 |
|
|
5318 |
|
|
5319 |
|
Schoenebeck Expires April 17, 2008 [Page 95] |
5320 |
|
|
5321 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5322 |
|
|
5323 |
|
|
5324 |
|
"FLAT" - |
5325 |
|
|
5326 |
|
All instruments will be processed, including those in the |
5327 |
|
subdirectories, but the respective subdirectory structure will |
5328 |
|
not be recreated in the instruments database. All instruments |
5329 |
|
will be added directly in the specified database directory. |
5330 |
|
|
5331 |
|
The difference between regular and NON_MODAL versions of the command |
5332 |
|
is that the regular command returns when the scanning is finished |
5333 |
|
while NON_MODAL version returns immediately and a background process |
5334 |
|
is launched. The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21) |
5335 |
|
command can be used to monitor the scanning progress. |
5336 |
|
|
5337 |
|
Possible Answers: |
5338 |
|
|
5339 |
|
"OK" - |
5340 |
|
|
5341 |
|
on success when NON_MODAL is not supplied |
5342 |
|
|
5343 |
|
"OK[<job-id>]" - |
5344 |
|
|
5345 |
|
on success when NON_MODAL is supplied, where <job-id> is a |
5346 |
|
numerical ID used to obtain status information about the job |
5347 |
|
progress. See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21) |
5348 |
|
|
5349 |
|
"ERR:<error-code>:<error-message>" - |
5350 |
|
|
5351 |
|
if an invalid path is specified. |
5352 |
|
|
5353 |
|
Examples: |
5354 |
|
|
5355 |
|
C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI |
5356 |
|
Bosendorfer 290.gig' 0" |
5357 |
|
|
5358 |
|
S: "OK" |
5359 |
|
|
5360 |
|
6.8.12. Removing an instrument |
5361 |
|
|
5362 |
|
The front-end can remove a particular instrument from the instruments |
5363 |
|
database by sending the following command: |
5364 |
|
|
5365 |
|
REMOVE DB_INSTRUMENT <instr_path> |
5366 |
|
|
5367 |
|
Where <instr_path> is the absolute path name (in the instruments |
5368 |
|
database) of the instrument to remove. |
5369 |
|
|
5370 |
|
Possible Answers: |
5371 |
|
|
5372 |
|
|
5373 |
|
|
5374 |
|
|
5375 |
|
Schoenebeck Expires April 17, 2008 [Page 96] |
5376 |
|
|
5377 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5378 |
|
|
5379 |
|
|
5380 |
|
"OK" - |
5381 |
|
|
5382 |
|
if the instrument is removed successfully |
5383 |
|
|
5384 |
|
"ERR:<error-code>:<error-message>" - |
5385 |
|
|
5386 |
|
if the given path does not exist or is a directory. |
5387 |
|
|
5388 |
|
Examples: |
5389 |
|
|
5390 |
|
C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'" |
5391 |
|
|
5392 |
|
S: "OK" |
5393 |
|
|
5394 |
|
6.8.13. Getting amount of instruments |
5395 |
|
|
5396 |
|
The front-end can retrieve the current amount of instruments in a |
5397 |
|
specific directory by sending the following command: |
5398 |
|
|
5399 |
|
GET DB_INSTRUMENTS [RECURSIVE] <dir> |
5400 |
|
|
5401 |
|
Where <dir> should be replaced by the absolute path name of the |
5402 |
|
directory. If RECURSIVE is specified, the number of all instruments, |
5403 |
|
including those located in subdirectories of the specified directory, |
5404 |
|
will be returned. |
5405 |
|
|
5406 |
|
Possible Answers: |
5407 |
|
|
5408 |
|
The current number of instruments in the specified directory. |
5409 |
|
|
5410 |
|
"ERR:<error-code>:<error-message>" - |
5411 |
|
|
5412 |
|
if the given directory does not exist. |
5413 |
|
|
5414 |
|
Example: |
5415 |
|
|
5416 |
|
C: "GET DB_INSTRUMENTS '/Piano Collection'" |
5417 |
|
|
5418 |
|
S: "2" |
5419 |
|
|
5420 |
|
6.8.14. Listing all instruments in specific directory |
5421 |
|
|
5422 |
|
The front-end can retrieve the current list of instruments in |
5423 |
|
specific directory by sending the following command: |
5424 |
|
|
5425 |
|
LIST DB_INSTRUMENTS [RECURSIVE] <dir> |
5426 |
|
|
5427 |
|
Where <dir> should be replaced by the absolute path name of the |
5428 |
|
|
5429 |
|
|
5430 |
|
|
5431 |
|
Schoenebeck Expires April 17, 2008 [Page 97] |
5432 |
|
|
5433 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5434 |
|
|
5435 |
|
|
5436 |
|
directory. If RECURSIVE is specified, the absolute path names of all |
5437 |
|
instruments, including those located in subdirectories of the |
5438 |
|
specified directory, will be returned. |
5439 |
|
|
5440 |
|
Possible Answers: |
5441 |
|
|
5442 |
|
A comma separated list of all instruments (encapsulated into |
5443 |
|
apostrophes) in the specified directory. |
5444 |
|
|
5445 |
|
"ERR:<error-code>:<error-message>" - |
5446 |
|
|
5447 |
|
if the given directory does not exist. |
5448 |
|
|
5449 |
|
Example: |
5450 |
|
|
5451 |
|
C: "LIST DB_INSTRUMENTS '/Piano Collection'" |
5452 |
|
|
5453 |
|
S: "'Bosendorfer 290','Steinway D'" |
5454 |
|
|
5455 |
|
C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'" |
5456 |
|
|
5457 |
|
S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/ |
5458 |
|
Steinway D','/Piano Collection/Lite/Free Piano'" |
5459 |
|
|
5460 |
|
6.8.15. Getting instrument information |
5461 |
|
|
5462 |
|
The front-end can ask for the current settings of an instrument by |
5463 |
|
sending the following command: |
5464 |
|
|
5465 |
|
GET DB_INSTRUMENT INFO <instr_path> |
5466 |
|
|
5467 |
|
Where <instr_path> should be replaced by the absolute path name of |
5468 |
|
the instrument the front-end is interested in. |
5469 |
|
|
5470 |
|
Possible Answers: |
5471 |
|
|
5472 |
|
LinuxSampler will answer by sending a <CRLF> separated list. Each |
5473 |
|
answer line begins with the settings category name followed by a |
5474 |
|
colon and then a space character <SP> and finally the info |
5475 |
|
character string to that setting category. At the moment the |
5476 |
|
following categories are defined: |
5477 |
|
|
5478 |
|
|
5479 |
|
|
5480 |
|
INSTRUMENT_FILE - |
5481 |
|
|
5482 |
|
File name of the instrument. Note that the character string |
5483 |
|
may contain escape sequences (Section 7.1). |
5484 |
|
|
5485 |
|
|
5486 |
|
|
5487 |
|
Schoenebeck Expires April 17, 2008 [Page 98] |
5488 |
|
|
5489 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5490 |
|
|
5491 |
|
|
5492 |
|
INSTRUMENT_NR - |
5493 |
|
|
5494 |
|
Index of the instrument within the file. |
5495 |
|
|
5496 |
|
FORMAT_FAMILY - |
5497 |
|
|
5498 |
|
The format family of the instrument. |
5499 |
|
|
5500 |
|
FORMAT_VERSION - |
5501 |
|
|
5502 |
|
The format version of the instrument. |
5503 |
|
|
5504 |
|
SIZE - |
5505 |
|
|
5506 |
|
The size of the instrument in bytes. |
5507 |
|
|
5508 |
|
CREATED - |
5509 |
|
|
5510 |
|
The date and time when the instrument is added in the |
5511 |
|
instruments database, represented in "YYYY-MM-DD HH:MM:SS" |
5512 |
|
format |
5513 |
|
|
5514 |
|
MODIFIED - |
5515 |
|
|
5516 |
|
The date and time of the last modification of the |
5517 |
|
instrument's database settings, represented in "YYYY-MM-DD |
5518 |
|
HH:MM:SS" format |
5519 |
|
|
5520 |
|
DESCRIPTION - |
5521 |
|
|
5522 |
|
A brief description of the instrument. Note that the |
5523 |
|
character string may contain escape sequences (Section 7.1). |
5524 |
|
|
5525 |
|
IS_DRUM - |
5526 |
|
|
5527 |
|
either true or false, determines whether the instrument is a |
5528 |
|
drumkit or a chromatic instrument |
5529 |
|
|
5530 |
|
PRODUCT - |
5531 |
|
|
5532 |
|
The product title of the instrument. Note that the |
5533 |
|
character string may contain escape sequences (Section 7.1). |
5534 |
|
|
5535 |
|
ARTISTS - |
5536 |
|
|
5537 |
|
Lists the artist names. Note that the character string may |
5538 |
|
contain escape sequences (Section 7.1). |
5539 |
|
|
5540 |
|
|
5541 |
|
|
5542 |
|
|
5543 |
|
Schoenebeck Expires April 17, 2008 [Page 99] |
5544 |
|
|
5545 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5546 |
|
|
5547 |
|
|
5548 |
|
KEYWORDS - |
5549 |
|
|
5550 |
|
Provides a list of keywords that refer to the instrument. |
5551 |
|
Keywords are separated with semicolon and blank. Note that |
5552 |
|
the character string may contain escape sequences |
5553 |
|
(Section 7.1). |
5554 |
|
|
5555 |
|
The mentioned fields above don't have to be in particular order. |
5556 |
|
|
5557 |
|
Example: |
5558 |
|
|
5559 |
|
C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'" |
5560 |
|
|
5561 |
|
S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig" |
5562 |
|
|
5563 |
|
"INSTRUMENT_NR: 0" |
5564 |
|
|
5565 |
|
"FORMAT_FAMILY: GIG" |
5566 |
|
|
5567 |
|
"FORMAT_VERSION: 2" |
5568 |
|
|
5569 |
|
"SIZE: 2050871870" |
5570 |
|
|
5571 |
|
"CREATED: 2007-02-05 10:23:12" |
5572 |
|
|
5573 |
|
"MODIFIED: 2007-04-07 12:50:21" |
5574 |
|
|
5575 |
|
"DESCRIPTION: " |
5576 |
|
|
5577 |
|
"IS_DRUM: false" |
5578 |
|
|
5579 |
|
"PRODUCT: GRANDIOSO Bosendorfer 290" |
5580 |
|
|
5581 |
|
"ARTISTS: Post Musical Instruments" |
5582 |
|
|
5583 |
|
"KEYWORDS: Bosendorfer" |
5584 |
|
|
5585 |
|
"." |
5586 |
|
|
5587 |
|
6.8.16. Renaming an instrument |
5588 |
|
|
5589 |
|
The front-end can alter the name of a specific instrument by sending |
5590 |
|
the following command: |
5591 |
|
|
5592 |
|
SET DB_INSTRUMENT NAME <instr> <name> |
5593 |
|
|
5594 |
|
Where <instr> is the absolute path name of the instrument and <name> |
5595 |
|
is the new name for that instrument. |
5596 |
|
|
5597 |
|
|
5598 |
|
|
5599 |
|
Schoenebeck Expires April 17, 2008 [Page 100] |
5600 |
|
|
5601 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5602 |
|
|
5603 |
|
|
5604 |
|
Possible Answers: |
5605 |
|
|
5606 |
|
"OK" - |
5607 |
|
|
5608 |
|
on success |
5609 |
|
|
5610 |
|
"ERR:<error-code>:<error-message>" - |
5611 |
|
|
5612 |
|
in case the given instrument does not exists, or if an |
5613 |
|
instrument with name equal to the new name already exists. |
5614 |
|
|
5615 |
|
Example: |
5616 |
|
|
5617 |
|
C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' |
5618 |
|
'Bosendorfer 290'" |
5619 |
|
|
5620 |
|
S: "OK" |
5621 |
|
|
5622 |
|
6.8.17. Moving an instrument |
5623 |
|
|
5624 |
|
The front-end can move a specific instrument to another directory by |
5625 |
|
sending the following command: |
5626 |
|
|
5627 |
|
MOVE DB_INSTRUMENT <instr> <dst> |
5628 |
|
|
5629 |
|
Where <instr> is the absolute path name of the instrument to move and |
5630 |
|
<dst> is the directory where the instrument will be moved to. |
5631 |
|
|
5632 |
|
Possible Answers: |
5633 |
|
|
5634 |
|
"OK" - |
5635 |
|
|
5636 |
|
on success |
5637 |
|
|
5638 |
|
"ERR:<error-code>:<error-message>" - |
5639 |
|
|
5640 |
|
in case the given instrument does not exists, or if an |
5641 |
|
instrument with name equal to the name of the specified |
5642 |
|
instrument already exists in the destination directory. |
5643 |
|
|
5644 |
|
Example: |
5645 |
|
|
5646 |
|
C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano |
5647 |
|
Collection/Acoustic'" |
5648 |
|
|
5649 |
|
S: "OK" |
5650 |
|
|
5651 |
|
|
5652 |
|
|
5653 |
|
|
5654 |
|
|
5655 |
|
Schoenebeck Expires April 17, 2008 [Page 101] |
5656 |
|
|
5657 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5658 |
|
|
5659 |
|
|
5660 |
|
6.8.18. Copying instruments |
5661 |
|
|
5662 |
|
The front-end can copy a specific instrument to another directory by |
5663 |
|
sending the following command: |
5664 |
|
|
5665 |
|
COPY DB_INSTRUMENT <instr> <dst> |
5666 |
|
|
5667 |
|
Where <instr> is the absolute path name of the instrument to copy and |
5668 |
|
<dst> is the directory where the instrument will be copied to. |
5669 |
|
|
5670 |
|
Possible Answers: |
5671 |
|
|
5672 |
|
"OK" - |
5673 |
|
|
5674 |
|
on success |
5675 |
|
|
5676 |
|
"ERR:<error-code>:<error-message>" - |
5677 |
|
|
5678 |
|
in case the given instrument does not exists, or if an |
5679 |
|
instrument with name equal to the name of the specified |
5680 |
|
instrument already exists in the destination directory. |
5681 |
|
|
5682 |
|
Example: |
5683 |
|
|
5684 |
|
C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' |
5685 |
|
'/Acoustic/Pianos/'" |
5686 |
|
|
5687 |
|
S: "OK" |
5688 |
|
|
5689 |
|
6.8.19. Changing the description of instrument |
5690 |
|
|
5691 |
|
The front-end can alter the description of a specific instrument by |
5692 |
|
sending the following command: |
5693 |
|
|
5694 |
|
SET DB_INSTRUMENT DESCRIPTION <instr> <desc> |
5695 |
|
|
5696 |
|
Where <instr> is the absolute path name of the instrument and <desc> |
5697 |
|
is the new description for the instrument (encapsulated into |
5698 |
|
apostrophes, supporting escape sequences as described in chapter |
5699 |
|
"Character Set and Escape Sequences (Section 7.1)"). |
5700 |
|
|
5701 |
|
Possible Answers: |
5702 |
|
|
5703 |
|
"OK" - |
5704 |
|
|
5705 |
|
on success |
5706 |
|
|
5707 |
|
|
5708 |
|
|
5709 |
|
|
5710 |
|
|
5711 |
|
Schoenebeck Expires April 17, 2008 [Page 102] |
5712 |
|
|
5713 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5714 |
|
|
5715 |
|
|
5716 |
|
"ERR:<error-code>:<error-message>" - |
5717 |
|
|
5718 |
|
in case the given instrument does not exists. |
5719 |
|
|
5720 |
|
Example: |
5721 |
|
|
5722 |
|
C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/ |
5723 |
|
Bosendorfer 290' 'No comment :)'" |
5724 |
|
|
5725 |
|
S: "OK" |
5726 |
|
|
5727 |
|
6.8.20. Finding instruments |
5728 |
|
|
5729 |
|
The front-end can search for instruments in specific directory by |
5730 |
|
sending the following command: |
5731 |
|
|
5732 |
|
FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list> |
5733 |
|
|
5734 |
|
Where <dir> should be replaced by the absolute path name of the |
5735 |
|
directory to search in. If NON_RECURSIVE is specified, the |
5736 |
|
directories located in subdirectories of the specified directory will |
5737 |
|
not be searched. <criteria-list> is a list of search criterias in |
5738 |
|
form of "key1=val1 key2=val2 ...". The following criterias are |
5739 |
|
allowed: |
5740 |
|
|
5741 |
|
NAME='<search-string>' |
5742 |
|
|
5743 |
|
Restricts the search to instruments, which names satisfy the |
5744 |
|
supplied search string (encapsulated into apostrophes, supporting |
5745 |
|
escape sequences as described in chapter "Character Set and Escape |
5746 |
|
Sequences (Section 7.1)"). |
5747 |
|
|
5748 |
|
SIZE=[<min>]..[<max>] |
5749 |
|
|
5750 |
|
Restricts the search to instruments, which size is in the |
5751 |
|
specified range. If <min> is omitted, the search results are |
5752 |
|
restricted to instruments with size less then or equal to <max>. |
5753 |
|
If <max> is omitted, the search is restricted to instruments with |
5754 |
|
size greater then or equal to <min>. |
5755 |
|
|
5756 |
|
CREATED='[<date-after>]..[<date-before>]' |
5757 |
|
|
5758 |
|
Restricts the search to instruments, which creation date satisfies |
5759 |
|
the specified period, where <date-after> and <date-before> are in |
5760 |
|
"YYYY-MM-DD HH:MM:SS" format. If <date-after> is omitted the |
5761 |
|
search is restricted to instruments created before <date-before>. |
5762 |
|
If <date-before> is omitted, the search is restricted to |
5763 |
|
instruments created after <date-after>. |
5764 |
|
|
5765 |
|
|
5766 |
|
|
5767 |
|
Schoenebeck Expires April 17, 2008 [Page 103] |
5768 |
|
|
5769 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5770 |
|
|
5771 |
|
|
5772 |
|
MODIFIED='[<date-after>]..[<date-before>]' |
5773 |
|
|
5774 |
|
Restricts the search to instruments, which date of last |
5775 |
|
modification satisfies the specified period, where <date-after> |
5776 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. If <date- |
5777 |
|
after> is omitted the search is restricted to instruments, which |
5778 |
|
are last modified before <date-before>. If <date-before> is |
5779 |
|
omitted, the search is restricted to instruments, which are last |
5780 |
|
modified after <date-after>. |
5781 |
|
|
5782 |
|
DESCRIPTION='<search-string>' |
5783 |
|
|
5784 |
|
Restricts the search to instruments with description that |
5785 |
|
satisfies the supplied search string (encapsulated into |
5786 |
|
apostrophes, supporting escape sequences as described in chapter |
5787 |
|
"Character Set and Escape Sequences (Section 7.1)"). |
5788 |
|
|
5789 |
|
PRODUCT='<search-string>' |
5790 |
|
|
5791 |
|
Restricts the search to instruments with product info that |
5792 |
|
satisfies the supplied search string (encapsulated into |
5793 |
|
apostrophes, supporting escape sequences as described in chapter |
5794 |
|
"Character Set and Escape Sequences (Section 7.1)"). |
5795 |
|
|
5796 |
|
ARTISTS='<search-string>' |
5797 |
|
|
5798 |
|
Restricts the search to instruments with artists info that |
5799 |
|
satisfies the supplied search string (encapsulated into |
5800 |
|
apostrophes, supporting escape sequences as described in chapter |
5801 |
|
"Character Set and Escape Sequences (Section 7.1)"). |
5802 |
|
|
5803 |
|
KEYWORDS='<search-string>' |
5804 |
|
|
5805 |
|
Restricts the search to instruments with keyword list that |
5806 |
|
satisfies the supplied search string (encapsulated into |
5807 |
|
apostrophes, supporting escape sequences as described in chapter |
5808 |
|
"Character Set and Escape Sequences (Section 7.1)"). |
5809 |
|
|
5810 |
|
IS_DRUM=true | false |
5811 |
|
|
5812 |
|
Either true or false. Restricts the search to drum kits or |
5813 |
|
chromatic instruments. |
5814 |
|
|
5815 |
|
FORMAT_FAMILIES='<format-list>' |
5816 |
|
|
5817 |
|
Restricts the search to instruments of the supplied format |
5818 |
|
families, where <format-list> is a comma separated list of format |
5819 |
|
families. |
5820 |
|
|
5821 |
|
|
5822 |
|
|
5823 |
|
Schoenebeck Expires April 17, 2008 [Page 104] |
5824 |
|
|
5825 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5826 |
|
|
5827 |
|
|
5828 |
|
Where <search-string> is either a regular expression, or a word list |
5829 |
|
separated with spaces for OR search and with '+' for AND search. |
5830 |
|
|
5831 |
|
Possible Answers: |
5832 |
|
|
5833 |
|
A comma separated list with the absolute path names (encapsulated |
5834 |
|
into apostrophes) of all instruments in the specified directory |
5835 |
|
that satisfy the supplied search criterias. |
5836 |
|
|
5837 |
|
"ERR:<error-code>:<error-message>" - |
5838 |
|
|
5839 |
|
if the given directory does not exist. |
5840 |
|
|
5841 |
|
Example: |
5842 |
|
|
5843 |
|
C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+ |
5844 |
|
290'" |
5845 |
|
|
5846 |
|
S: "'/Piano Collection/Bosendorfer 290'" |
5847 |
|
|
5848 |
|
C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 |
5849 |
|
09:30:13..'" |
5850 |
|
|
5851 |
|
S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/ |
5852 |
|
Steinway D'" |
5853 |
|
|
5854 |
|
6.8.21. Getting job status information |
5855 |
|
|
5856 |
|
The front-end can ask for the current status of a particular database |
5857 |
|
instruments job by sending the following command: |
5858 |
|
|
5859 |
|
GET DB_INSTRUMENTS_JOB INFO <job-id> |
5860 |
|
|
5861 |
|
Where <job-id> should be replaced by the numerical ID of the job the |
5862 |
|
front-end is interested in. |
5863 |
|
|
5864 |
|
Possible Answers: |
5865 |
|
|
5866 |
|
LinuxSampler will answer by sending a <CRLF> separated list. Each |
5867 |
|
answer line begins with the settings category name followed by a |
5868 |
|
colon and then a space character <SP> and finally the info |
5869 |
|
character string to that setting category. At the moment the |
5870 |
|
following categories are defined: |
5871 |
|
|
5872 |
|
|
5873 |
|
|
5874 |
|
FILES_TOTAL - |
5875 |
|
|
5876 |
|
|
5877 |
|
|
5878 |
|
|
5879 |
|
Schoenebeck Expires April 17, 2008 [Page 105] |
5880 |
|
|
5881 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5882 |
|
|
5883 |
|
|
5884 |
|
The total number of files scheduled for scanning |
5885 |
|
|
5886 |
|
FILES_SCANNED - |
5887 |
|
|
5888 |
|
The current number of scanned files |
5889 |
|
|
5890 |
|
SCANNING - |
5891 |
|
|
5892 |
|
The absolute path name of the file which is currently being |
5893 |
|
scanned |
5894 |
|
|
5895 |
|
STATUS - |
5896 |
|
|
5897 |
|
An integer value between 0 and 100 indicating the scanning |
5898 |
|
progress percentage of the file which is currently being |
5899 |
|
scanned |
5900 |
|
|
5901 |
|
The mentioned fields above don't have to be in particular order. |
5902 |
|
|
5903 |
|
Example: |
5904 |
|
|
5905 |
|
C: "GET DB_INSTRUMENTS_JOB INFO 2" |
5906 |
|
|
5907 |
|
S: "FILES_TOTAL: 12" |
5908 |
|
|
5909 |
|
"FILES_SCANNED: 7" |
5910 |
|
|
5911 |
|
"SCANNING: /home/me/gigs/Bosendorfer 290.gig" |
5912 |
|
|
5913 |
|
"STATUS: 42" |
5914 |
|
|
5915 |
|
"." |
5916 |
|
|
5917 |
|
6.8.22. Formatting the instruments database |
5918 |
|
|
5919 |
|
The front-end can remove all instruments and directories and re- |
5920 |
|
create the instruments database structure (e.g., in case of a |
5921 |
|
database corruption) by sending the following command: |
5922 |
|
|
5923 |
|
FORMAT INSTRUMENTS_DB |
5924 |
|
|
5925 |
|
Possible Answers: |
5926 |
|
|
5927 |
|
"OK" - |
5928 |
|
|
5929 |
|
on success |
5930 |
|
|
5931 |
|
|
5932 |
|
|
5933 |
|
|
5934 |
|
|
5935 |
|
Schoenebeck Expires April 17, 2008 [Page 106] |
5936 |
|
|
5937 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5938 |
|
|
5939 |
|
|
5940 |
|
"ERR:<error-code>:<error-message>" - |
5941 |
|
|
5942 |
|
If the formatting of the instruments database failed. |
5943 |
|
|
5944 |
|
6.9. Editing Instruments |
5945 |
|
|
5946 |
|
The sampler allows to edit instruments while playing with the sampler |
5947 |
|
by spawning an external (3rd party) instrument editor application for |
5948 |
|
a given instrument. The 3rd party instrument editor applications |
5949 |
|
have to place a respective plugin DLL file into the sampler's plugins |
5950 |
|
directory. The sampler will automatically try to load all plugin |
5951 |
|
DLLs in that directory on startup and only on startup! |
5952 |
|
|
5953 |
|
At the moment there is only one command for this feature set, but |
5954 |
|
this will most probably change in future. |
5955 |
|
|
5956 |
|
6.9.1. Opening an appropriate instrument editor application |
5957 |
|
|
5958 |
|
The front-end can request to open an appropriate instrument editor |
5959 |
|
application by sending the following command: |
5960 |
|
|
5961 |
|
EDIT CHANNEL INSTRUMENT <sampler-channel> |
5962 |
|
|
5963 |
|
Where <sampler-channel> should be replaced by the number of the |
5964 |
|
sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or |
5965 |
|
"LIST CHANNELS" (Section 6.4.4) command. |
5966 |
|
|
5967 |
|
The sampler will try to ask all registered instrument editors (or to |
5968 |
|
be more specific: their sampler plugins) whether they are capable to |
5969 |
|
handle the instrument on the given sampler channel. The sampler will |
5970 |
|
simply use the first instrument editor application which replied with |
5971 |
|
a positive answer and spawn that instrument editor application within |
5972 |
|
the sampler's process and provide that application access to the |
5973 |
|
instrument's data structures, so both applications can share and |
5974 |
|
access the same instruments data at the same time, thus allowing to |
5975 |
|
immediately hear changes with the sampler made by the instrument |
5976 |
|
editor. |
5977 |
|
|
5978 |
|
Note: consequently instrument editors are always spawned locally on |
5979 |
|
the same machine where the sampler is running on! |
5980 |
|
|
5981 |
|
Possible Answers: |
5982 |
|
|
5983 |
|
"OK" - |
5984 |
|
|
5985 |
|
when an appropriate instrument editor was launched |
5986 |
|
|
5987 |
|
|
5988 |
|
|
5989 |
|
|
5990 |
|
|
5991 |
|
Schoenebeck Expires April 17, 2008 [Page 107] |
5992 |
|
|
5993 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
5994 |
|
|
5995 |
|
|
5996 |
|
"WRN:<warning-code>:<warning-message>" - |
5997 |
|
|
5998 |
|
when an appropriate instrument editor was launched, but there |
5999 |
|
are noteworthy issues |
6000 |
|
|
6001 |
|
"ERR:<error-code>:<error-message>" - |
6002 |
|
|
6003 |
|
when an appropriate instrument editor could not be launched |
6004 |
|
|
6005 |
|
Examples: |
6006 |
|
|
6007 |
|
C: "EDIT CHANNEL INSTRUMENT 0" |
6008 |
|
|
6009 |
|
S: "OK" |
6010 |
|
|
6011 |
|
|
6012 |
|
|
6013 |
|
|
6014 |
|
|
6015 |
|
|
6016 |
|
|
6017 |
|
|
6018 |
|
|
6019 |
|
|
6020 |
|
|
6021 |
|
|
6022 |
|
|
6023 |
|
|
6024 |
|
|
6025 |
|
|
6026 |
|
|
6027 |
|
|
6028 |
|
|
6029 |
|
|
6030 |
|
|
6031 |
|
|
6032 |
|
|
6033 |
|
|
6034 |
|
|
6035 |
|
|
6036 |
|
|
6037 |
|
|
6038 |
|
|
6039 |
|
|
6040 |
|
|
6041 |
|
|
6042 |
|
|
6043 |
|
|
6044 |
|
|
6045 |
|
|
6046 |
|
|
6047 |
|
Schoenebeck Expires April 17, 2008 [Page 108] |
6048 |
|
|
6049 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6050 |
|
|
6051 |
|
|
6052 |
7. Command Syntax |
7. Command Syntax |
6100 |
|
|
6101 |
|
|
6102 |
|
|
6103 |
Schoenebeck Expires June 18, 2007 [Page 77] |
Schoenebeck Expires April 17, 2008 [Page 109] |
6104 |
|
|
6105 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
6106 |
|
|
6107 |
|
|
6108 |
/ LIST SP list_instruction |
/ LIST SP list_instruction |
6117 |
|
|
6118 |
/ UNSUBSCRIBE SP unsubscribe_event |
/ UNSUBSCRIBE SP unsubscribe_event |
6119 |
|
|
|
/ SELECT SP text |
|
|
|
|
6120 |
/ RESET SP reset_instruction |
/ RESET SP reset_instruction |
6121 |
|
|
6122 |
/ CLEAR SP clear_instruction |
/ CLEAR SP clear_instruction |
6123 |
|
|
6124 |
|
/ FIND SP find_instruction |
6125 |
|
|
6126 |
|
/ MOVE SP move_instruction |
6127 |
|
|
6128 |
|
/ COPY SP copy_instruction |
6129 |
|
|
6130 |
|
/ EDIT SP edit_instruction |
6131 |
|
|
6132 |
|
/ FORMAT SP format_instruction |
6133 |
|
|
6134 |
/ RESET |
/ RESET |
6135 |
|
|
6136 |
/ QUIT |
/ QUIT |
6139 |
|
|
6140 |
CHANNEL |
CHANNEL |
6141 |
|
|
6142 |
|
/ DB_INSTRUMENT_DIRECTORY SP db_path |
6143 |
|
|
6144 |
|
/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
6145 |
|
|
6146 |
|
/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
6147 |
|
|
6148 |
|
/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
6149 |
|
|
6150 |
|
/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP |
6151 |
|
instrument_index |
6152 |
|
|
6153 |
|
/ DB_INSTRUMENTS SP db_path SP filename |
6154 |
|
|
6155 |
|
|
6156 |
|
|
6157 |
|
|
6158 |
|
|
6159 |
|
Schoenebeck Expires April 17, 2008 [Page 110] |
6160 |
|
|
6161 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6162 |
|
|
6163 |
|
|
6164 |
|
/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
6165 |
|
|
6166 |
/ MIDI_INSTRUMENT_MAP |
/ MIDI_INSTRUMENT_MAP |
6167 |
|
|
6168 |
/ MIDI_INSTRUMENT_MAP SP map_name |
/ MIDI_INSTRUMENT_MAP SP map_name |
6169 |
|
|
6170 |
subscribe_event = |
subscribe_event = |
6171 |
|
|
6172 |
CHANNEL_COUNT |
AUDIO_OUTPUT_DEVICE_COUNT |
6173 |
|
|
6174 |
|
/ AUDIO_OUTPUT_DEVICE_INFO |
6175 |
|
|
6176 |
|
/ MIDI_INPUT_DEVICE_COUNT |
6177 |
|
|
6178 |
|
/ MIDI_INPUT_DEVICE_INFO |
6179 |
|
|
6180 |
|
/ CHANNEL_COUNT |
6181 |
|
|
6182 |
/ VOICE_COUNT |
/ VOICE_COUNT |
6183 |
|
|
6187 |
|
|
6188 |
/ CHANNEL_INFO |
/ CHANNEL_INFO |
6189 |
|
|
6190 |
|
/ FX_SEND_COUNT |
6191 |
|
|
6192 |
|
/ FX_SEND_INFO |
6193 |
|
|
6194 |
|
/ MIDI_INSTRUMENT_MAP_COUNT |
6195 |
|
|
6196 |
|
/ MIDI_INSTRUMENT_MAP_INFO |
6197 |
|
|
6198 |
|
/ MIDI_INSTRUMENT_COUNT |
6199 |
|
|
6200 |
|
/ MIDI_INSTRUMENT_INFO |
6201 |
|
|
6202 |
|
/ DB_INSTRUMENT_DIRECTORY_COUNT |
6203 |
|
|
6204 |
|
/ DB_INSTRUMENT_DIRECTORY_INFO |
6205 |
|
|
6206 |
|
/ DB_INSTRUMENT_COUNT |
6207 |
|
|
6208 |
|
/ DB_INSTRUMENT_INFO |
6209 |
|
|
6210 |
|
/ DB_INSTRUMENTS_JOB_INFO |
6211 |
|
|
6212 |
|
|
6213 |
|
|
6214 |
|
|
6215 |
|
Schoenebeck Expires April 17, 2008 [Page 111] |
6216 |
|
|
6217 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6218 |
|
|
6219 |
|
|
6220 |
/ MISCELLANEOUS |
/ MISCELLANEOUS |
6221 |
|
|
6222 |
/ TOTAL_VOICE_COUNT |
/ TOTAL_VOICE_COUNT |
6223 |
|
|
6224 |
unsubscribe_event = |
/ GLOBAL_INFO |
6225 |
|
|
6226 |
|
unsubscribe_event = |
6227 |
|
|
6228 |
|
AUDIO_OUTPUT_DEVICE_COUNT |
6229 |
|
|
6230 |
|
/ AUDIO_OUTPUT_DEVICE_INFO |
6231 |
|
|
6232 |
Schoenebeck Expires June 18, 2007 [Page 78] |
/ MIDI_INPUT_DEVICE_COUNT |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
6233 |
|
|
6234 |
|
/ MIDI_INPUT_DEVICE_INFO |
6235 |
|
|
6236 |
CHANNEL_COUNT |
/ CHANNEL_COUNT |
6237 |
|
|
6238 |
/ VOICE_COUNT |
/ VOICE_COUNT |
6239 |
|
|
6243 |
|
|
6244 |
/ CHANNEL_INFO |
/ CHANNEL_INFO |
6245 |
|
|
6246 |
|
/ FX_SEND_COUNT |
6247 |
|
|
6248 |
|
/ FX_SEND_INFO |
6249 |
|
|
6250 |
|
/ MIDI_INSTRUMENT_MAP_COUNT |
6251 |
|
|
6252 |
|
/ MIDI_INSTRUMENT_MAP_INFO |
6253 |
|
|
6254 |
|
/ MIDI_INSTRUMENT_COUNT |
6255 |
|
|
6256 |
|
/ MIDI_INSTRUMENT_INFO |
6257 |
|
|
6258 |
|
/ DB_INSTRUMENT_DIRECTORY_COUNT |
6259 |
|
|
6260 |
|
/ DB_INSTRUMENT_DIRECTORY_INFO |
6261 |
|
|
6262 |
|
/ DB_INSTRUMENT_COUNT |
6263 |
|
|
6264 |
|
/ DB_INSTRUMENT_INFO |
6265 |
|
|
6266 |
|
/ DB_INSTRUMENTS_JOB_INFO |
6267 |
|
|
6268 |
|
|
6269 |
|
|
6270 |
|
|
6271 |
|
Schoenebeck Expires April 17, 2008 [Page 112] |
6272 |
|
|
6273 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6274 |
|
|
6275 |
|
|
6276 |
/ MISCELLANEOUS |
/ MISCELLANEOUS |
6277 |
|
|
6278 |
/ TOTAL_VOICE_COUNT |
/ TOTAL_VOICE_COUNT |
6279 |
|
|
6280 |
|
/ GLOBAL_INFO |
6281 |
|
|
6282 |
map_instruction = |
map_instruction = |
6283 |
|
|
6284 |
MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP |
MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP |
6285 |
engine_name SP filename SP instrument_index SP volume_value |
engine_name SP filename SP instrument_index SP volume_value |
6286 |
|
|
6287 |
/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP |
/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog |
6288 |
engine_name SP filename SP instrument_index SP volume_value SP |
SP engine_name SP filename SP instrument_index SP volume_value SP |
6289 |
instr_load_mode |
instr_load_mode |
6290 |
|
|
6291 |
/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP |
/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog |
6292 |
engine_name SP filename SP instrument_index SP volume_value SP |
SP engine_name SP filename SP instrument_index SP volume_value SP |
6293 |
entry_name |
entry_name |
6294 |
|
|
6295 |
/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP |
/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog |
6296 |
engine_name SP filename SP instrument_index SP volume_value SP |
SP engine_name SP filename SP instrument_index SP volume_value SP |
6297 |
instr_load_mode SP entry_name |
instr_load_mode SP entry_name |
6298 |
|
|
6299 |
unmap_instruction = |
unmap_instruction = |
6308 |
|
|
6309 |
/ MIDI_INSTRUMENT_MAP SP ALL |
/ MIDI_INSTRUMENT_MAP SP ALL |
6310 |
|
|
6311 |
|
/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
6312 |
|
|
6313 |
|
/ DB_INSTRUMENT_DIRECTORY SP db_path |
6314 |
|
|
6315 |
|
/ DB_INSTRUMENT SP db_path |
6316 |
|
|
6317 |
get_instruction = |
get_instruction = |
6318 |
|
|
6319 |
AVAILABLE_ENGINES |
AVAILABLE_ENGINES |
6320 |
|
|
6321 |
|
/ AVAILABLE_MIDI_INPUT_DRIVERS |
6322 |
|
|
6323 |
|
|
6324 |
|
|
6325 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 79] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
6326 |
|
|
6327 |
|
Schoenebeck Expires April 17, 2008 [Page 113] |
6328 |
|
|
6329 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6330 |
|
|
|
/ AVAILABLE_MIDI_INPUT_DRIVERS |
|
6331 |
|
|
6332 |
/ MIDI_INPUT_DRIVER SP INFO SP string |
/ MIDI_INPUT_DRIVER SP INFO SP string |
6333 |
|
|
6374 |
|
|
6375 |
/ ENGINE SP INFO SP engine_name |
/ ENGINE SP INFO SP engine_name |
6376 |
|
|
6377 |
|
/ SERVER SP INFO |
6378 |
|
|
6379 |
|
|
6380 |
|
|
6381 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 80] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
6382 |
|
|
6383 |
|
Schoenebeck Expires April 17, 2008 [Page 114] |
6384 |
|
|
6385 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6386 |
|
|
|
/ SERVER SP INFO |
|
6387 |
|
|
6388 |
/ TOTAL_VOICE_COUNT |
/ TOTAL_VOICE_COUNT |
6389 |
|
|
6399 |
|
|
6400 |
/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
6401 |
|
|
6402 |
|
/ FX_SENDS SP sampler_channel |
6403 |
|
|
6404 |
|
/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
6405 |
|
|
6406 |
|
/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6407 |
|
|
6408 |
|
/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6409 |
|
|
6410 |
|
/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
6411 |
|
|
6412 |
|
/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6413 |
|
|
6414 |
|
/ DB_INSTRUMENTS SP db_path |
6415 |
|
|
6416 |
|
/ DB_INSTRUMENT SP INFO SP db_path |
6417 |
|
|
6418 |
|
/ DB_INSTRUMENTS_JOB SP INFO SP number |
6419 |
|
|
6420 |
|
/ VOLUME |
6421 |
|
|
6422 |
set_instruction = |
set_instruction = |
6423 |
|
|
6424 |
AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' |
AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' |
6430 |
/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' |
/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' |
6431 |
param_val_list |
param_val_list |
6432 |
|
|
6433 |
|
/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
6434 |
|
|
6435 |
|
|
6436 |
|
|
6437 |
|
|
6438 |
|
|
6439 |
|
Schoenebeck Expires April 17, 2008 [Page 115] |
6440 |
|
|
6441 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6442 |
|
|
6443 |
|
|
6444 |
/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' |
/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' |
6445 |
param_val_list |
param_val_list |
6446 |
|
|
6448 |
|
|
6449 |
/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
6450 |
|
|
6451 |
|
/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name |
6452 |
|
|
6453 |
|
/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id |
6454 |
|
SP audio_channel_index SP audio_channel_index |
6455 |
|
|
6456 |
|
/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP |
6457 |
|
midi_ctrl |
6458 |
|
|
6459 |
|
/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP |
6460 |
|
volume_value |
6461 |
|
|
6462 |
|
/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
6463 |
|
|
6464 |
|
/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP |
6465 |
|
stringval_escaped |
6466 |
|
|
6467 |
|
/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
6468 |
|
|
6469 |
|
/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
6470 |
|
|
6471 |
/ ECHO SP boolean |
/ ECHO SP boolean |
6472 |
|
|
6473 |
|
/ VOLUME SP volume_value |
6474 |
|
|
6475 |
create_instruction = |
create_instruction = |
6476 |
|
|
6477 |
AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
6482 |
|
|
6483 |
/ MIDI_INPUT_DEVICE SP string |
/ MIDI_INPUT_DEVICE SP string |
6484 |
|
|
6485 |
|
/ FX_SEND SP sampler_channel SP midi_ctrl |
6486 |
|
|
6487 |
|
/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
6488 |
|
|
6489 |
reset_instruction = |
reset_instruction = |
6490 |
|
|
6491 |
|
|
6492 |
|
|
6493 |
|
|
6494 |
Schoenebeck Expires June 18, 2007 [Page 81] |
|
6495 |
|
Schoenebeck Expires April 17, 2008 [Page 116] |
6496 |
|
|
6497 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
6498 |
|
|
6499 |
|
|
6500 |
CHANNEL SP sampler_channel |
CHANNEL SP sampler_channel |
6505 |
|
|
6506 |
/ MIDI_INSTRUMENTS SP ALL |
/ MIDI_INSTRUMENTS SP ALL |
6507 |
|
|
6508 |
|
find_instruction = |
6509 |
|
|
6510 |
|
DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
6511 |
|
|
6512 |
|
/ DB_INSTRUMENTS SP db_path SP query_val_list |
6513 |
|
|
6514 |
|
/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP |
6515 |
|
query_val_list |
6516 |
|
|
6517 |
|
/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
6518 |
|
|
6519 |
|
move_instruction = |
6520 |
|
|
6521 |
|
DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
6522 |
|
|
6523 |
|
/ DB_INSTRUMENT SP db_path SP db_path |
6524 |
|
|
6525 |
|
copy_instruction = |
6526 |
|
|
6527 |
|
DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
6528 |
|
|
6529 |
|
/ DB_INSTRUMENT SP db_path SP db_path |
6530 |
|
|
6531 |
destroy_instruction = |
destroy_instruction = |
6532 |
|
|
6533 |
AUDIO_OUTPUT_DEVICE SP number |
AUDIO_OUTPUT_DEVICE SP number |
6534 |
|
|
6535 |
/ MIDI_INPUT_DEVICE SP number |
/ MIDI_INPUT_DEVICE SP number |
6536 |
|
|
6537 |
|
/ FX_SEND SP sampler_channel SP fx_send_id |
6538 |
|
|
6539 |
load_instruction = |
load_instruction = |
6540 |
|
|
6541 |
INSTRUMENT SP load_instr_args |
INSTRUMENT SP load_instr_args |
6544 |
|
|
6545 |
set_chan_instruction = |
set_chan_instruction = |
6546 |
|
|
6547 |
|
|
6548 |
|
|
6549 |
|
|
6550 |
|
|
6551 |
|
Schoenebeck Expires April 17, 2008 [Page 117] |
6552 |
|
|
6553 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6554 |
|
|
6555 |
|
|
6556 |
AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
6557 |
|
|
6558 |
/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index |
/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index |
6578 |
|
|
6579 |
/ SOLO SP sampler_channel SP boolean |
/ SOLO SP sampler_channel SP boolean |
6580 |
|
|
6581 |
|
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
6582 |
|
|
6583 |
|
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
6584 |
|
|
6585 |
|
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
6586 |
|
|
6587 |
|
edit_instruction = |
6588 |
|
|
6589 |
Schoenebeck Expires June 18, 2007 [Page 82] |
CHANNEL SP INSTRUMENT SP sampler_channel |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
6590 |
|
|
6591 |
|
format_instruction = |
6592 |
|
|
6593 |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
INSTRUMENTS_DB |
6594 |
|
|
6595 |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
modal_arg = |
6596 |
|
|
6597 |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
/* epsilon (empty argument) */ |
6598 |
|
|
6599 |
|
/ NON_MODAL SP |
6600 |
|
|
6601 |
key_val_list = |
key_val_list = |
6602 |
|
|
6603 |
|
|
6604 |
|
|
6605 |
|
|
6606 |
|
|
6607 |
|
Schoenebeck Expires April 17, 2008 [Page 118] |
6608 |
|
|
6609 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6610 |
|
|
6611 |
|
|
6612 |
string '=' param_val_list |
string '=' param_val_list |
6613 |
|
|
6614 |
/ key_val_list SP string '=' param_val_list |
/ key_val_list SP string '=' param_val_list |
6639 |
|
|
6640 |
/ MIDI_INSTRUMENT_MAPS |
/ MIDI_INSTRUMENT_MAPS |
6641 |
|
|
6642 |
|
/ FX_SENDS SP sampler_channel |
6643 |
|
|
6644 |
|
/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
6645 |
|
|
6646 |
|
/ DB_INSTRUMENT_DIRECTORIES SP db_path |
6647 |
|
|
6648 |
|
/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
6649 |
|
|
6650 |
|
/ DB_INSTRUMENTS SP db_path |
6651 |
|
|
6652 |
load_instr_args = |
load_instr_args = |
6653 |
|
|
6654 |
filename SP instrument_index SP sampler_channel |
filename SP instrument_index SP sampler_channel |
6657 |
|
|
6658 |
load_engine_args = |
load_engine_args = |
6659 |
|
|
|
engine_name SP sampler_channel |
|
|
|
|
6660 |
|
|
6661 |
|
|
6662 |
|
|
6663 |
Schoenebeck Expires June 18, 2007 [Page 83] |
Schoenebeck Expires April 17, 2008 [Page 119] |
6664 |
|
|
6665 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
6666 |
|
|
6667 |
|
|
6668 |
|
engine_name SP sampler_channel |
6669 |
|
|
6670 |
instr_load_mode = |
instr_load_mode = |
6671 |
|
|
6672 |
ON_DEMAND |
ON_DEMAND |
6713 |
|
|
6714 |
number |
number |
6715 |
|
|
|
volume_value = |
|
|
|
|
6716 |
|
|
6717 |
|
|
6718 |
|
|
6719 |
Schoenebeck Expires June 18, 2007 [Page 84] |
Schoenebeck Expires April 17, 2008 [Page 120] |
6720 |
|
|
6721 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
6722 |
|
|
6723 |
|
|
6724 |
|
midi_ctrl = |
6725 |
|
|
6726 |
|
number |
6727 |
|
|
6728 |
|
volume_value = |
6729 |
|
|
6730 |
dotnum |
dotnum |
6731 |
|
|
6739 |
|
|
6740 |
number |
number |
6741 |
|
|
6742 |
|
fx_send_id = |
6743 |
|
|
6744 |
|
number |
6745 |
|
|
6746 |
engine_name = |
engine_name = |
6747 |
|
|
6748 |
string |
string |
6749 |
|
|
6750 |
filename = |
filename = |
6751 |
|
|
6752 |
stringval |
path |
6753 |
|
|
6754 |
|
db_path = |
6755 |
|
|
6756 |
|
path |
6757 |
|
|
6758 |
map_name = |
map_name = |
6759 |
|
|
6760 |
stringval |
stringval_escaped |
6761 |
|
|
6762 |
entry_name = |
entry_name = |
6763 |
|
|
6764 |
stringval |
stringval_escaped |
6765 |
|
|
6766 |
|
fx_send_name = |
6767 |
|
|
6768 |
|
stringval_escaped |
6769 |
|
|
6770 |
param_val_list = |
param_val_list = |
6771 |
|
|
6772 |
|
|
6773 |
|
|
6774 |
|
|
6775 |
|
Schoenebeck Expires April 17, 2008 [Page 121] |
6776 |
|
|
6777 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6778 |
|
|
6779 |
|
|
6780 |
param_val |
param_val |
6781 |
|
|
6782 |
/ param_val_list','param_val |
/ param_val_list','param_val |
6791 |
|
|
6792 |
/ dotnum |
/ dotnum |
6793 |
|
|
6794 |
|
query_val_list = |
6795 |
|
|
6796 |
|
string '=' query_val |
6797 |
|
|
6798 |
|
/ query_val_list SP string '=' query_val |
6799 |
|
|
6800 |
|
query_val = |
6801 |
|
|
6802 |
|
text_escaped |
6803 |
|
|
6804 |
|
/ stringval_escaped |
6805 |
|
|
6806 |
|
scan_mode = |
6807 |
|
|
6808 |
|
RECURSIVE |
6809 |
|
|
6810 |
|
/ NON_RECURSIVE |
6811 |
|
|
6812 |
|
/ FLAT |
6813 |
|
|
6814 |
|
7.1. Character Set and Escape Sequences |
6815 |
|
|
6816 |
|
Older versions of this protocol up to and including v1.1 only |
6817 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
6818 |
|
[RFC20], all younger versions of this protocol however support the |
6819 |
|
Extended ASCII character set (ASCII code 0 - 255). The same group of |
6820 |
|
younger protocols also support escape sequences, but only for |
6821 |
|
certain, explicitly declared parts of the protocol. The supported |
6822 |
|
escape sequences are defined as follows: |
6823 |
|
|
6824 |
|
|
6825 |
|
|
6826 |
|
|
6827 |
|
|
6828 |
|
|
6829 |
|
|
6830 |
|
|
6831 |
|
Schoenebeck Expires April 17, 2008 [Page 122] |
6832 |
|
|
6833 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6834 |
|
|
6835 |
|
|
6836 |
|
+------------------------+------------------------------------------+ |
6837 |
|
| ASCII Character | Translated into (Name) | |
6838 |
|
| Sequence | | |
6839 |
|
+------------------------+------------------------------------------+ |
6840 |
|
| \n | new line | |
6841 |
|
| | | |
6842 |
|
| \r | carriage return | |
6843 |
|
| | | |
6844 |
|
| \f | form feed | |
6845 |
|
| | | |
6846 |
|
| \t | horizontal tab | |
6847 |
|
| | | |
6848 |
|
| \v | vertical tab | |
6849 |
|
| | | |
6850 |
|
| \' | apostrophe | |
6851 |
|
| | | |
6852 |
|
| \" | quotation mark | |
6853 |
|
| | | |
6854 |
|
| \\ | backslash | |
6855 |
|
| | | |
6856 |
|
| \OOO | three digit octal ASCII code of the | |
6857 |
|
| | character | |
6858 |
|
| | | |
6859 |
|
| \xHH | two digit hex ASCII code of the | |
6860 |
|
| | character | |
6861 |
|
+------------------------+------------------------------------------+ |
6862 |
|
|
6863 |
|
Notice: due to the transition of certain parts of the protocol which |
6864 |
|
now support escape sequences, a slight backward incompatibility to |
6865 |
|
protocols version v1.1 and younger has been introduced. The only |
6866 |
|
difference is that in parts of the protocol where escape characters |
6867 |
|
are now supported, a backslash characters MUST be escaped as well |
6868 |
|
(that is as double backslash), whereas in the old versions a single |
6869 |
|
backslash was sufficient. |
6870 |
|
|
6871 |
|
The following LSCP commands support escape sequences as part of their |
6872 |
|
filename / path based arguments and / or may contain a filename / |
6873 |
|
path with escape sequences in their response: |
6874 |
|
|
6875 |
|
"LOAD INSTRUMENT" (Section 6.4.1) |
6876 |
|
|
6877 |
|
"GET CHANNEL INFO" (Section 6.4.10) |
6878 |
|
|
6879 |
|
"MAP MIDI_INSTRUMENT" (Section 6.7.7) |
6880 |
|
|
6881 |
|
"GET MIDI_INSTRUMENT INFO" (Section 6.7.11) |
6882 |
|
|
6883 |
|
|
6884 |
Schoenebeck Expires June 18, 2007 [Page 85] |
|
6885 |
|
|
6886 |
|
|
6887 |
|
Schoenebeck Expires April 17, 2008 [Page 123] |
6888 |
|
|
6889 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
6890 |
|
|
6891 |
|
|
6892 |
|
"ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1) |
6893 |
|
|
6894 |
|
"ADD DB_INSTRUMENTS" (Section 6.8.11) |
6895 |
|
|
6896 |
|
"REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2) |
6897 |
|
|
6898 |
|
"REMOVE DB_INSTRUMENT" (Section 6.8.12) |
6899 |
|
|
6900 |
|
"GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3) |
6901 |
|
|
6902 |
|
"LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4) |
6903 |
|
|
6904 |
|
"GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5) |
6905 |
|
|
6906 |
|
"GET DB_INSTRUMENTS" (Section 6.8.13) |
6907 |
|
|
6908 |
|
"LIST DB_INSTRUMENTS" (Section 6.8.14) |
6909 |
|
|
6910 |
|
"GET DB_INSTRUMENT INFO" (Section 6.8.15) |
6911 |
|
|
6912 |
|
"SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6) |
6913 |
|
|
6914 |
|
"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9) |
6915 |
|
|
6916 |
|
"SET DB_INSTRUMENT NAME" (Section 6.8.16) |
6917 |
|
|
6918 |
|
"SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19) |
6919 |
|
|
6920 |
|
"FIND DB_INSTRUMENTS" (Section 6.8.20) |
6921 |
|
|
6922 |
|
"FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10) |
6923 |
|
|
6924 |
|
"MOVE DB_INSTRUMENT" (Section 6.8.17) |
6925 |
|
|
6926 |
|
"MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7) |
6927 |
|
|
6928 |
|
"COPY DB_INSTRUMENT" (Section 6.8.18) |
6929 |
|
|
6930 |
|
"COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8) |
6931 |
|
|
6932 |
|
Note that the forward slash character ('/') has a special meaning in |
6933 |
|
filename / path based arguments: it acts as separator of the nodes in |
6934 |
|
the path, thus if a directory- or filename includes a forward slash |
6935 |
|
(not intended as path node separator), you MUST escape that slash |
6936 |
|
either with the respective hex escape sequence ("\x2f") or with the |
6937 |
|
respective octal escape sequence ("\057"). |
6938 |
|
|
6939 |
|
The following LSCP commands even support escape sequences as part of |
6940 |
|
|
6941 |
|
|
6942 |
|
|
6943 |
|
Schoenebeck Expires April 17, 2008 [Page 124] |
6944 |
|
|
6945 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
6946 |
|
|
6947 |
|
|
6948 |
|
at least one of their text-based arguments (i.e. entity name, |
6949 |
|
description) and / or may contain escape sequences in at least one of |
6950 |
|
their text-based fields in their response: |
6951 |
|
|
6952 |
|
"GET SERVER INFO" (Section 6.6.4) |
6953 |
|
|
6954 |
|
"GET ENGINE INFO" (Section 6.4.9) |
6955 |
|
|
6956 |
|
"GET CHANNEL INFO" (Section 6.4.10) |
6957 |
|
|
6958 |
|
"CREATE FX_SEND" (Section 6.4.25) |
6959 |
|
|
6960 |
|
"GET FX_SEND INFO" (Section 6.4.29) |
6961 |
|
|
6962 |
|
"SET FX_SEND NAME" (Section 6.4.30) |
6963 |
|
|
6964 |
|
"GET MIDI_INSTRUMENT INFO" (Section 6.7.11) |
6965 |
|
|
6966 |
|
"GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5) |
6967 |
|
|
6968 |
|
"ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1) |
6969 |
|
|
6970 |
|
"MAP MIDI_INSTRUMENT" (Section 6.7.7) |
6971 |
|
|
6972 |
|
"SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6) |
6973 |
|
|
6974 |
|
"GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5) |
6975 |
|
|
6976 |
|
"SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6) |
6977 |
|
|
6978 |
|
"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9) |
6979 |
|
|
6980 |
|
"FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10) |
6981 |
|
|
6982 |
|
"GET DB_INSTRUMENT INFO" (Section 6.8.15) |
6983 |
|
|
6984 |
|
"SET DB_INSTRUMENT NAME" (Section 6.8.16) |
6985 |
|
|
6986 |
|
"SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19) |
6987 |
|
|
6988 |
|
"FIND DB_INSTRUMENTS" (Section 6.8.20) |
6989 |
|
|
6990 |
|
Please note that these lists are manually maintained. If you find a |
6991 |
|
command that also supports escape sequences we forgot to mention |
6992 |
|
here, please report it! |
6993 |
|
|
6994 |
|
|
6995 |
|
|
6996 |
|
|
6997 |
|
|
6998 |
|
|
6999 |
|
Schoenebeck Expires April 17, 2008 [Page 125] |
7000 |
|
|
7001 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
7002 |
|
|
7003 |
|
|
7004 |
8. Events |
8. Events |
7006 |
This chapter will describe all currently defined events supported by |
This chapter will describe all currently defined events supported by |
7007 |
LinuxSampler. |
LinuxSampler. |
7008 |
|
|
7009 |
8.1. Number of sampler channels changed |
8.1. Number of audio output devices changed |
7010 |
|
|
7011 |
|
Client may want to be notified when the total number of audio output |
7012 |
|
devices on the back-end changes by issuing the following command: |
7013 |
|
|
7014 |
|
SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT |
7015 |
|
|
7016 |
|
Server will start sending the following notification messages: |
7017 |
|
|
7018 |
|
"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>" |
7019 |
|
|
7020 |
|
where <devices> will be replaced by the new number of audio output |
7021 |
|
devices. |
7022 |
|
|
7023 |
|
8.2. Audio output device's settings changed |
7024 |
|
|
7025 |
|
Client may want to be notified when changes were made to audio output |
7026 |
|
devices on the back-end by issuing the following command: |
7027 |
|
|
7028 |
|
SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO |
7029 |
|
|
7030 |
|
Server will start sending the following notification messages: |
7031 |
|
|
7032 |
|
"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>" |
7033 |
|
|
7034 |
|
where <device-id> will be replaced by the numerical ID of the audio |
7035 |
|
output device, which settings has been changed. The front-end will |
7036 |
|
have to send the respective command to actually get the audio output |
7037 |
|
device info. Because these messages will be triggered by LSCP |
7038 |
|
commands issued by other clients rather than real time events |
7039 |
|
happening on the server, it is believed that an empty notification |
7040 |
|
message is sufficient here. |
7041 |
|
|
7042 |
|
8.3. Number of MIDI input devices changed |
7043 |
|
|
7044 |
|
Client may want to be notified when the total number of MIDI input |
7045 |
|
devices on the back-end changes by issuing the following command: |
7046 |
|
|
7047 |
|
SUBSCRIBE MIDI_INPUT_DEVICE_COUNT |
7048 |
|
|
7049 |
|
Server will start sending the following notification messages: |
7050 |
|
|
7051 |
|
|
7052 |
|
|
7053 |
|
|
7054 |
|
|
7055 |
|
Schoenebeck Expires April 17, 2008 [Page 126] |
7056 |
|
|
7057 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
7058 |
|
|
7059 |
|
|
7060 |
|
"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>" |
7061 |
|
|
7062 |
|
where <devices> will be replaced by the new number of MIDI input |
7063 |
|
devices. |
7064 |
|
|
7065 |
|
8.4. MIDI input device's settings changed |
7066 |
|
|
7067 |
|
Client may want to be notified when changes were made to MIDI input |
7068 |
|
devices on the back-end by issuing the following command: |
7069 |
|
|
7070 |
|
SUBSCRIBE MIDI_INPUT_DEVICE_INFO |
7071 |
|
|
7072 |
|
Server will start sending the following notification messages: |
7073 |
|
|
7074 |
|
"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>" |
7075 |
|
|
7076 |
|
where <device-id> will be replaced by the numerical ID of the MIDI |
7077 |
|
input device, which settings has been changed. The front-end will |
7078 |
|
have to send the respective command to actually get the MIDI input |
7079 |
|
device info. Because these messages will be triggered by LSCP |
7080 |
|
commands issued by other clients rather than real time events |
7081 |
|
happening on the server, it is believed that an empty notification |
7082 |
|
message is sufficient here. |
7083 |
|
|
7084 |
|
8.5. Number of sampler channels changed |
7085 |
|
|
7086 |
Client may want to be notified when the total number of channels on |
Client may want to be notified when the total number of channels on |
7087 |
the back-end changes by issuing the following command: |
the back-end changes by issuing the following command: |
7095 |
where <channels> will be replaced by the new number of sampler |
where <channels> will be replaced by the new number of sampler |
7096 |
channels. |
channels. |
7097 |
|
|
7098 |
8.2. Number of active voices changed |
8.6. Number of active voices changed |
7099 |
|
|
7100 |
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- |
7101 |
end changes by issuing the following command: |
end changes by issuing the following command: |
7104 |
|
|
7105 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
7106 |
|
|
7107 |
"NOTIFY:VOICE_COUNT:<sampler-channel> <voices> |
|
7108 |
|
|
7109 |
|
|
7110 |
|
|
7111 |
|
Schoenebeck Expires April 17, 2008 [Page 127] |
7112 |
|
|
7113 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
7114 |
|
|
7115 |
|
|
7116 |
|
"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>" |
7117 |
|
|
7118 |
where <sampler-channel> will be replaced by the sampler channel the |
where <sampler-channel> will be replaced by the sampler channel the |
7119 |
voice count change occurred and <voices> by the new number of active |
voice count change occurred and <voices> by the new number of active |
7120 |
voices on that channel. |
voices on that channel. |
7121 |
|
|
7122 |
8.3. Number of active disk streams changed |
8.7. Number of active disk streams changed |
7123 |
|
|
7124 |
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 |
7125 |
back-end changes by issuing the following command: SUBSCRIBE |
back-end changes by issuing the following command: SUBSCRIBE |
7133 |
|
|
7134 |
where <sampler-channel> will be replaced by the sampler channel the |
where <sampler-channel> will be replaced by the sampler channel the |
7135 |
stream count change occurred and <streams> by the new number of |
stream count change occurred and <streams> by the new number of |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 86] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
7136 |
active disk streams on that channel. |
active disk streams on that channel. |
7137 |
|
|
7138 |
8.4. Disk stream buffer fill state changed |
8.8. Disk stream buffer fill state changed |
7139 |
|
|
7140 |
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 |
7141 |
stream on the back-end changes by issuing the following command: |
stream on the back-end changes by issuing the following command: |
7152 |
Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" |
Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" |
7153 |
(Section 6.4.13) command was issued on this channel. |
(Section 6.4.13) command was issued on this channel. |
7154 |
|
|
7155 |
8.5. Channel information changed |
8.9. Channel information changed |
7156 |
|
|
7157 |
Client may want to be notified when changes were made to sampler |
Client may want to be notified when changes were made to sampler |
7158 |
channels on the back-end by issuing the following command: |
channels on the back-end by issuing the following command: |
7161 |
|
|
7162 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
7163 |
|
|
7164 |
|
|
7165 |
|
|
7166 |
|
|
7167 |
|
Schoenebeck Expires April 17, 2008 [Page 128] |
7168 |
|
|
7169 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
7170 |
|
|
7171 |
|
|
7172 |
"NOTIFY:CHANNEL_INFO:<sampler-channel>" |
"NOTIFY:CHANNEL_INFO:<sampler-channel>" |
7173 |
|
|
7174 |
where <sampler-channel> will be replaced by the sampler channel the |
where <sampler-channel> will be replaced by the sampler channel the |
7178 |
rather than real time events happening on the server, it is believed |
rather than real time events happening on the server, it is believed |
7179 |
that an empty notification message is sufficient here. |
that an empty notification message is sufficient here. |
7180 |
|
|
7181 |
8.6. Total number of active voices changed |
8.10. Number of effect sends changed |
7182 |
|
|
7183 |
|
Client may want to be notified when the number of effect sends on a |
7184 |
|
particular sampler channel is changed by issuing the following |
7185 |
|
command: |
7186 |
|
|
7187 |
|
SUBSCRIBE FX_SEND_COUNT |
7188 |
|
|
7189 |
|
Server will start sending the following notification messages: |
7190 |
|
|
7191 |
|
"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>" |
7192 |
|
|
7193 |
|
where <channel-id> will be replaced by the numerical ID of the |
7194 |
|
sampler channel, on which the effect sends number is changed and <fx- |
7195 |
|
sends> will be replaced by the new number of effect sends on that |
7196 |
|
channel. |
7197 |
|
|
7198 |
|
8.11. Effect send information changed |
7199 |
|
|
7200 |
|
Client may want to be notified when changes were made to effect sends |
7201 |
|
on a a particular sampler channel by issuing the following command: |
7202 |
|
|
7203 |
|
SUBSCRIBE FX_SEND_INFO |
7204 |
|
|
7205 |
|
Server will start sending the following notification messages: |
7206 |
|
|
7207 |
|
"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>" |
7208 |
|
|
7209 |
|
where <channel-id> will be replaced by the numerical ID of the |
7210 |
|
sampler channel, on which an effect send entity is changed and <fx- |
7211 |
|
send-id> will be replaced by the numerical ID of the changed effect |
7212 |
|
send. |
7213 |
|
|
7214 |
|
8.12. Total number of active voices changed |
7215 |
|
|
7216 |
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 |
7217 |
back-end changes by issuing the following command: |
back-end changes by issuing the following command: |
7218 |
|
|
7219 |
|
|
7220 |
|
|
7221 |
|
|
7222 |
|
|
7223 |
|
Schoenebeck Expires April 17, 2008 [Page 129] |
7224 |
|
|
7225 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
7226 |
|
|
7227 |
|
|
7228 |
SUBSCRIBE TOTAL_VOICE_COUNT |
SUBSCRIBE TOTAL_VOICE_COUNT |
7229 |
|
|
7230 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
7231 |
|
|
7232 |
|
"NOTIFY:TOTAL_VOICE_COUNT:<voices>" |
7233 |
|
|
7234 |
|
where <voices> will be replaced by the new number of all currently |
7235 |
|
active voices. |
7236 |
|
|
7237 |
|
8.13. Number of MIDI instrument maps changed |
7238 |
|
|
7239 |
|
Client may want to be notified when the number of MIDI instrument |
7240 |
|
maps on the back-end changes by issuing the following command: |
7241 |
|
|
7242 |
|
SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT |
7243 |
|
|
7244 |
|
Server will start sending the following notification messages: |
7245 |
|
|
7246 |
|
"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>" |
7247 |
|
|
7248 |
|
where <maps> will be replaced by the new number of MIDI instrument |
7249 |
|
maps. |
7250 |
|
|
7251 |
|
8.14. MIDI instrument map information changed |
7252 |
|
|
7253 |
|
Client may want to be notified when changes were made to MIDI |
7254 |
|
instrument maps on the back-end by issuing the following command: |
7255 |
|
|
7256 |
|
SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO |
7257 |
|
|
7258 |
|
Server will start sending the following notification messages: |
7259 |
|
|
7260 |
|
"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>" |
7261 |
|
|
7262 |
|
where <map-id> will be replaced by the numerical ID of the MIDI |
7263 |
|
instrument map, for which information changes occurred. The front- |
7264 |
|
end will have to send the respective command to actually get the MIDI |
7265 |
|
instrument map info. Because these messages will be triggered by |
7266 |
|
LSCP commands issued by other clients rather than real time events |
7267 |
|
happening on the server, it is believed that an empty notification |
7268 |
|
message is sufficient here. |
7269 |
|
|
7270 |
|
8.15. Number of MIDI instruments changed |
7271 |
|
|
7272 |
|
Client may want to be notified when the number of MIDI instrument |
7273 |
|
maps on the back-end changes by issuing the following command: |
7274 |
|
|
7275 |
|
|
7276 |
|
|
7277 |
|
|
7278 |
|
|
7279 |
Schoenebeck Expires June 18, 2007 [Page 87] |
Schoenebeck Expires April 17, 2008 [Page 130] |
7280 |
|
|
7281 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
7282 |
|
|
7283 |
|
|
7284 |
"NOTIFY:TOTAL_VOICE_COUNT:<voices> |
SUBSCRIBE MIDI_INSTRUMENT_COUNT |
7285 |
|
|
7286 |
where <voices> will be replaced by the new number of all currently |
Server will start sending the following notification messages: |
|
active voices. |
|
7287 |
|
|
7288 |
8.7. Miscellaneous and debugging events |
"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>" |
7289 |
|
|
7290 |
Client may want to be notified of miscellaneous and debugging events |
where <map-id> is the numerical ID of the MIDI instrument map, in |
7291 |
occurring at the server by issuing the following command: |
which the nuber of instruments has changed and <instruments> will be |
7292 |
|
replaced by the new number of MIDI instruments in the specified map. |
7293 |
|
|
7294 |
SUBSCRIBE MISCELLANEOUS |
8.16. MIDI instrument information changed |
7295 |
|
|
7296 |
|
Client may want to be notified when changes were made to MIDI |
7297 |
|
instruments on the back-end by issuing the following command: |
7298 |
|
|
7299 |
|
SUBSCRIBE MIDI_INSTRUMENT_INFO |
7300 |
|
|
7301 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
7302 |
|
|
7303 |
"NOTIFY:MISCELLANEOUS:<string>" |
"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>" |
7304 |
|
|
7305 |
where <string> will be replaced by whatever data server wants to send |
where <map-id> will be replaced by the numerical ID of the MIDI |
7306 |
to the client. Client MAY display this data to the user AS IS to |
instrument map, in which a MIDI instrument is changed. <bank> and |
7307 |
facilitate debugging. |
<program> specifies the location of the changed MIDI instrument in |
7308 |
|
the map. The front-end will have to send the respective command to |
7309 |
|
actually get the MIDI instrument info. Because these messages will |
7310 |
|
be triggered by LSCP commands issued by other clients rather than |
7311 |
|
real time events happening on the server, it is believed that an |
7312 |
|
empty notification message is sufficient here. |
7313 |
|
|
7314 |
|
8.17. Global settings changed |
7315 |
|
|
7316 |
|
Client may want to be notified when changes to the global settings of |
7317 |
|
the sampler were made by issuing the following command: |
7318 |
|
|
7319 |
|
SUBSCRIBE GLOBAL_INFO |
7320 |
|
|
7321 |
|
Server will start sending the following types of notification |
7322 |
|
messages: |
7323 |
|
|
7324 |
|
"NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal |
7325 |
|
volume of the sampler is changed, where <volume> will be replaced |
7326 |
|
by the optional dotted floating point value, reflecting the new |
7327 |
|
global volume parameter. |
7328 |
|
|
7329 |
|
|
7330 |
|
|
7331 |
|
|
7332 |
|
|
7333 |
|
|
7334 |
|
|
7335 |
|
Schoenebeck Expires April 17, 2008 [Page 131] |
7336 |
|
|
7337 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
7338 |
|
|
7339 |
|
|
7340 |
|
8.18. Number of database instrument directories changed |
7341 |
|
|
7342 |
|
Client may want to be notified when the number of instrument |
7343 |
|
directories in a particular directory in the instruments database is |
7344 |
|
changed by issuing the following command: |
7345 |
|
|
7346 |
|
SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT |
7347 |
|
|
7348 |
|
Server will start sending the following notification messages: |
7349 |
|
|
7350 |
|
"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>" |
7351 |
|
|
7352 |
|
where <dir-path> will be replaced by the absolute path name of the |
7353 |
|
directory in the instruments database, in which the number of |
7354 |
|
directories is changed. |
7355 |
|
|
7356 |
|
Note that when a non-empty directory is removed, this event is not |
7357 |
|
sent for the subdirectories in that directory. |
7358 |
|
|
7359 |
|
8.19. Database instrument directory information changed |
7360 |
|
|
7361 |
|
Client may want to be notified when changes were made to directories |
7362 |
|
in the instruments database by issuing the following command: |
7363 |
|
|
7364 |
|
SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO |
7365 |
|
|
7366 |
|
Server will start sending the following notification messages: |
7367 |
|
|
7368 |
|
"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>" |
7369 |
|
|
7370 |
|
where <dir-path> will be replaced by the absolute path name of the |
7371 |
|
directory, for which information changes occurred. The front-end |
7372 |
|
will have to send the respective command to actually get the updated |
7373 |
|
directory info. Because these messages will be triggered by LSCP |
7374 |
|
commands issued by other clients rather than real time events |
7375 |
|
happening on the server, it is believed that an empty notification |
7376 |
|
message is sufficient here. |
7377 |
|
|
7378 |
|
"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new- |
7379 |
|
name>" |
7380 |
|
|
7381 |
|
where <old-dir-path> is the old absolute path name of the directory |
7382 |
|
(encapsulated into apostrophes), which name is changes and <new-name> |
7383 |
|
is the new name of the directory, encapsulated into apostrophes. |
7384 |
|
|
7385 |
|
|
7386 |
|
|
7387 |
|
|
7388 |
|
|
7389 |
|
|
7390 |
|
|
7391 |
|
Schoenebeck Expires April 17, 2008 [Page 132] |
7392 |
|
|
7393 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
7394 |
|
|
7395 |
|
|
7396 |
|
8.20. Number of database instruments changed |
7397 |
|
|
7398 |
|
Client may want to be notified when the number of instruments in a |
7399 |
|
particular directory in the instruments database is changed by |
7400 |
|
issuing the following command: |
7401 |
|
|
7402 |
|
SUBSCRIBE DB_INSTRUMENT_COUNT |
7403 |
|
|
7404 |
|
Server will start sending the following notification messages: |
7405 |
|
|
7406 |
|
"NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>" |
7407 |
|
|
7408 |
|
where <dir-path> will be replaced by the absolute path name of the |
7409 |
|
directory in the instruments database, in which the number of |
7410 |
|
instruments is changed. |
7411 |
|
|
7412 |
|
Note that when a non-empty directory is removed, this event is not |
7413 |
|
sent for the instruments in that directory. |
7414 |
|
|
7415 |
|
8.21. Database instrument information changed |
7416 |
|
|
7417 |
|
Client may want to be notified when changes were made to instruments |
7418 |
|
in the instruments database by issuing the following command: |
7419 |
|
|
7420 |
|
SUBSCRIBE DB_INSTRUMENT_INFO |
7421 |
|
|
7422 |
|
Server will start sending the following notification messages: |
7423 |
|
|
7424 |
|
"NOTIFY:DB_INSTRUMENT_INFO:<instr-path>" |
7425 |
|
|
7426 |
|
where <instr-path> will be replaced by the absolute path name of the |
7427 |
|
instrument, which settings are changed. The front-end will have to |
7428 |
|
send the respective command to actually get the updated directory |
7429 |
|
info. Because these messages will be triggered by LSCP commands |
7430 |
|
issued by other clients rather than real time events happening on the |
7431 |
|
server, it is believed that an empty notification message is |
7432 |
|
sufficient here. |
7433 |
|
|
7434 |
|
"NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>" |
7435 |
|
|
7436 |
|
where <old-instr-path> is the old absolute path name of the |
7437 |
|
instrument (encapsulated into apostrophes), which name is changes and |
7438 |
|
<new-name> is the new name of the instrument, encapsulated into |
7439 |
|
apostrophes. |
7440 |
|
|
7441 |
|
|
7442 |
|
|
7444 |
|
|
7445 |
|
|
7446 |
|
|
7447 |
|
Schoenebeck Expires April 17, 2008 [Page 133] |
7448 |
|
|
7449 |
|
Internet-Draft LinuxSampler Control Protocol October 2007 |
7450 |
|
|
7451 |
|
|
7452 |
|
8.22. Database job status information changed |
7453 |
|
|
7454 |
|
Client may want to be notified when the status of particular database |
7455 |
|
instruments job is changed by issuing the following command: |
7456 |
|
|
7457 |
|
SUBSCRIBE DB_INSTRUMENTS_JOB_INFO |
7458 |
|
|
7459 |
|
Server will start sending the following notification messages: |
7460 |
|
|
7461 |
|
"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>" |
7462 |
|
|
7463 |
|
where <job-id> will be replaced by the numerical ID of the job, which |
7464 |
|
status is changed. The front-end will have to send the respective |
7465 |
|
command to actually get the status info. Because these messages will |
7466 |
|
be triggered by LSCP commands issued by other clients rather than |
7467 |
|
real time events happening on the server, it is believed that an |
7468 |
|
empty notification message is sufficient here. |
7469 |
|
|
7470 |
|
8.23. Miscellaneous and debugging events |
7471 |
|
|
7472 |
|
Client may want to be notified of miscellaneous and debugging events |
7473 |
|
occurring at the server by issuing the following command: |
7474 |
|
|
7475 |
|
SUBSCRIBE MISCELLANEOUS |
7476 |
|
|
7477 |
|
Server will start sending the following notification messages: |
7478 |
|
|
7479 |
|
"NOTIFY:MISCELLANEOUS:<string>" |
7480 |
|
|
7481 |
|
where <string> will be replaced by whatever data server wants to send |
7482 |
|
to the client. Client MAY display this data to the user AS IS to |
7483 |
|
facilitate debugging. |
7484 |
|
|
7485 |
|
|
7486 |
|
|
7500 |
|
|
7501 |
|
|
7502 |
|
|
7503 |
Schoenebeck Expires June 18, 2007 [Page 88] |
Schoenebeck Expires April 17, 2008 [Page 134] |
7504 |
|
|
7505 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
7506 |
|
|
7507 |
|
|
7508 |
9. Security Considerations |
9. Security Considerations |
7556 |
|
|
7557 |
|
|
7558 |
|
|
7559 |
Schoenebeck Expires June 18, 2007 [Page 89] |
Schoenebeck Expires April 17, 2008 [Page 135] |
7560 |
|
|
7561 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
7562 |
|
|
7563 |
|
|
7564 |
10. Acknowledgments |
10. Acknowledgments |
7612 |
|
|
7613 |
|
|
7614 |
|
|
7615 |
Schoenebeck Expires June 18, 2007 [Page 90] |
Schoenebeck Expires April 17, 2008 [Page 136] |
7616 |
|
|
7617 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
7618 |
|
|
7619 |
|
|
7620 |
11. References |
11. References |
7621 |
|
|
7622 |
|
[RFC20] UCLA, "ASCII format for Network Interchange", RFC 20, |
7623 |
|
1969. |
7624 |
|
|
7625 |
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate |
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate |
7626 |
Requirement Levels", RFC 2119, 1997. |
Requirement Levels", RFC 2119, 1997. |
7627 |
|
|
7668 |
|
|
7669 |
|
|
7670 |
|
|
7671 |
|
Schoenebeck Expires April 17, 2008 [Page 137] |
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 91] |
|
7672 |
|
|
7673 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
7674 |
|
|
7675 |
|
|
7676 |
Author's Address |
Author's Address |
7724 |
|
|
7725 |
|
|
7726 |
|
|
7727 |
Schoenebeck Expires June 18, 2007 [Page 92] |
Schoenebeck Expires April 17, 2008 [Page 138] |
7728 |
|
|
7729 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol October 2007 |
7730 |
|
|
7731 |
|
|
7732 |
Full Copyright Statement |
Full Copyright Statement |
7733 |
|
|
7734 |
Copyright (C) The Internet Society (2006). |
Copyright (C) The IETF Trust (2007). |
7735 |
|
|
7736 |
This document is subject to the rights, licenses and restrictions |
This document is subject to the rights, licenses and restrictions |
7737 |
contained in BCP 78, and except as set forth therein, the authors |
contained in BCP 78, and except as set forth therein, the authors |
7739 |
|
|
7740 |
This document and the information contained herein are provided on an |
This document and the information contained herein are provided on an |
7741 |
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS |
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS |
7742 |
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET |
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND |
7743 |
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, |
THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS |
7744 |
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE |
OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF |
7745 |
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED |
THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED |
7746 |
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
7747 |
|
|
7748 |
|
|
7780 |
|
|
7781 |
|
|
7782 |
|
|
7783 |
Schoenebeck Expires June 18, 2007 [Page 93] |
Schoenebeck Expires April 17, 2008 [Page 139] |
7784 |
|
|
7785 |
|
|