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: September 30, 2007 March 29, 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 September 30, 2007. |
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 September 30, 2007 [Page 1] |
56 |
|
|
57 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
58 |
|
|
59 |
|
|
60 |
Abstract |
Abstract |
68 |
|
|
69 |
Table of Contents |
Table of Contents |
70 |
|
|
71 |
1. Requirements notation . . . . . . . . . . . . . . . . . . . . 5 |
1. Requirements notation . . . . . . . . . . . . . . . . . . . . 5 |
72 |
2. Versioning of this specification . . . . . . . . . . . . . . . 6 |
2. Versioning of this specification . . . . . . . . . . . . . . 6 |
73 |
3. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 7 |
3. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 7 |
74 |
4. Focus of this protocol . . . . . . . . . . . . . . . . . . . . 8 |
4. Focus of this protocol . . . . . . . . . . . . . . . . . . . 8 |
75 |
5. Communication Overview . . . . . . . . . . . . . . . . . . . . 9 |
5. Communication Overview . . . . . . . . . . . . . . . . . . . 9 |
76 |
5.1. Request/response communication method . . . . . . . . . . 9 |
5.1. Request/response communication method . . . . . . . . . . 9 |
77 |
5.1.1. Result format . . . . . . . . . . . . . . . . . . . . 10 |
5.1.1. Result format . . . . . . . . . . . . . . . . . . . . 10 |
78 |
5.2. Subscribe/notify communication method . . . . . . . . . . 12 |
5.2. Subscribe/notify communication method . . . . . . . . . . 12 |
79 |
6. Description for control commands . . . . . . . . . . . . . . . 14 |
6. Description for control commands . . . . . . . . . . . . . . 14 |
80 |
6.1. Ignored lines and comments . . . . . . . . . . . . . . . . 14 |
6.1. Ignored lines and comments . . . . . . . . . . . . . . . 14 |
81 |
6.2. Configuring audio drivers . . . . . . . . . . . . . . . . 14 |
6.2. Configuring audio drivers . . . . . . . . . . . . . . . . 14 |
82 |
6.2.1. Getting amount of available audio output drivers . . . 15 |
6.2.1. Getting amount of available audio output drivers . . 15 |
83 |
6.2.2. Getting all available audio output drivers . . . . . . 15 |
6.2.2. Getting all available audio output drivers . . . . . 15 |
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 . . . . . . . . . . . . . . . . . . . . . . . 15 |
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 . . . . . . . . . . . . . . . . . . 16 |
88 |
6.2.5. Creating an audio output device . . . . . . . . . . . 20 |
6.2.5. Creating an audio output device . . . . . . . . . . . 20 |
89 |
6.2.6. Destroying an audio output device . . . . . . . . . . 21 |
6.2.6. Destroying an audio output device . . . . . . . . . . 21 |
90 |
6.2.7. Getting all created audio output device count . . . . 22 |
6.2.7. Getting all created audio output device count . . . . 22 |
91 |
6.2.8. Getting all created audio output device list . . . . . 22 |
6.2.8. Getting all created audio output device list . . . . 22 |
92 |
6.2.9. Getting current settings of an audio output device . . 22 |
6.2.9. Getting current settings of an audio output device . 22 |
93 |
6.2.10. Changing settings of audio output devices . . . . . . 24 |
6.2.10. Changing settings of audio output devices . . . . . . 24 |
94 |
6.2.11. Getting information about an audio channel . . . . . . 25 |
6.2.11. Getting information about an audio channel . . . . . 25 |
95 |
6.2.12. Getting information about specific audio channel |
6.2.12. Getting information about specific audio channel |
96 |
parameter . . . . . . . . . . . . . . . . . . . . . . 26 |
parameter . . . . . . . . . . . . . . . . . . . . . . 26 |
97 |
6.2.13. Changing settings of audio output channels . . . . . . 28 |
6.2.13. Changing settings of audio output channels . . . . . 28 |
98 |
6.3. Configuring MIDI input drivers . . . . . . . . . . . . . . 29 |
6.3. Configuring MIDI input drivers . . . . . . . . . . . . . 29 |
99 |
6.3.1. Getting amount of available MIDI input drivers . . . . 30 |
6.3.1. Getting amount of available MIDI input drivers . . . 30 |
100 |
6.3.2. Getting all available MIDI input drivers . . . . . . . 30 |
6.3.2. Getting all available MIDI input drivers . . . . . . 30 |
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 . . . . . . . . . . . . . . . . . . . . . . . 31 |
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 . . . . . . . . . . . . . . . . . . 32 |
105 |
6.3.5. Creating a MIDI input device . . . . . . . . . . . . . 34 |
6.3.5. Creating a MIDI input device . . . . . . . . . . . . 34 |
106 |
6.3.6. Destroying a MIDI input device . . . . . . . . . . . . 35 |
6.3.6. Destroying a MIDI input device . . . . . . . . . . . 35 |
107 |
6.3.7. Getting all created MIDI input device count . . . . . 36 |
6.3.7. Getting all created MIDI input device count . . . . . 36 |
108 |
|
|
109 |
|
|
110 |
|
|
111 |
Schoenebeck Expires June 18, 2007 [Page 2] |
Schoenebeck Expires September 30, 2007 [Page 2] |
112 |
|
|
113 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 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 . . . . . 36 |
117 |
6.3.9. Getting current settings of a MIDI input device . . . 37 |
6.3.9. Getting current settings of a MIDI input device . . . 37 |
118 |
6.3.10. Changing settings of MIDI input devices . . . . . . . 38 |
6.3.10. Changing settings of MIDI input devices . . . . . . . 38 |
119 |
6.3.11. Getting information about a MIDI port . . . . . . . . 38 |
6.3.11. Getting information about a MIDI port . . . . . . . . 38 |
120 |
6.3.12. Getting information about specific MIDI port |
6.3.12. Getting information about specific MIDI port |
121 |
parameter . . . . . . . . . . . . . . . . . . . . . . 39 |
parameter . . . . . . . . . . . . . . . . . . . . . . 39 |
122 |
6.3.13. Changing settings of MIDI input ports . . . . . . . . 41 |
6.3.13. Changing settings of MIDI input ports . . . . . . . . 41 |
123 |
6.4. Configuring sampler channels . . . . . . . . . . . . . . . 42 |
6.4. Configuring sampler channels . . . . . . . . . . . . . . 42 |
124 |
6.4.1. Loading an instrument . . . . . . . . . . . . . . . . 42 |
6.4.1. Loading an instrument . . . . . . . . . . . . . . . . 42 |
125 |
6.4.2. Loading a sampler engine . . . . . . . . . . . . . . . 43 |
6.4.2. Loading a sampler engine . . . . . . . . . . . . . . 43 |
126 |
6.4.3. Getting all created sampler channel count . . . . . . 44 |
6.4.3. Getting all created sampler channel count . . . . . . 44 |
127 |
6.4.4. Getting all created sampler channel list . . . . . . . 44 |
6.4.4. Getting all created sampler channel list . . . . . . 44 |
128 |
6.4.5. Adding a new sampler channel . . . . . . . . . . . . . 44 |
6.4.5. Adding a new sampler channel . . . . . . . . . . . . 44 |
129 |
6.4.6. Removing a sampler channel . . . . . . . . . . . . . . 45 |
6.4.6. Removing a sampler channel . . . . . . . . . . . . . 45 |
130 |
6.4.7. Getting amount of available engines . . . . . . . . . 46 |
6.4.7. Getting amount of available engines . . . . . . . . . 46 |
131 |
6.4.8. Getting all available engines . . . . . . . . . . . . 46 |
6.4.8. Getting all available engines . . . . . . . . . . . . 46 |
132 |
6.4.9. Getting information about an engine . . . . . . . . . 47 |
6.4.9. Getting information about an engine . . . . . . . . . 47 |
133 |
6.4.10. Getting sampler channel information . . . . . . . . . 48 |
6.4.10. Getting sampler channel information . . . . . . . . . 48 |
134 |
6.4.11. Current number of active voices . . . . . . . . . . . 51 |
6.4.11. Current number of active voices . . . . . . . . . . . 51 |
135 |
6.4.12. Current number of active disk streams . . . . . . . . 51 |
6.4.12. Current number of active disk streams . . . . . . . . 51 |
136 |
6.4.13. Current fill state of disk stream buffers . . . . . . 52 |
6.4.13. Current fill state of disk stream buffers . . . . . . 52 |
137 |
6.4.14. Setting audio output device . . . . . . . . . . . . . 53 |
6.4.14. Setting audio output device . . . . . . . . . . . . . 53 |
138 |
6.4.15. Setting audio output type . . . . . . . . . . . . . . 53 |
6.4.15. Setting audio output type . . . . . . . . . . . . . . 53 |
139 |
6.4.16. Setting audio output channel . . . . . . . . . . . . . 54 |
6.4.16. Setting audio output channel . . . . . . . . . . . . 54 |
140 |
6.4.17. Setting MIDI input device . . . . . . . . . . . . . . 55 |
6.4.17. Setting MIDI input device . . . . . . . . . . . . . . 55 |
141 |
6.4.18. Setting MIDI input type . . . . . . . . . . . . . . . 56 |
6.4.18. Setting MIDI input type . . . . . . . . . . . . . . . 56 |
142 |
6.4.19. Setting MIDI input port . . . . . . . . . . . . . . . 56 |
6.4.19. Setting MIDI input port . . . . . . . . . . . . . . . 56 |
143 |
6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57 |
6.4.20. Setting MIDI input channel . . . . . . . . . . . . . 57 |
144 |
6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 58 |
6.4.21. Setting channel volume . . . . . . . . . . . . . . . 58 |
145 |
6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58 |
6.4.22. Muting a sampler channel . . . . . . . . . . . . . . 58 |
146 |
6.4.23. Soloing a sampler channel . . . . . . . . . . . . . . 59 |
6.4.23. Soloing a sampler channel . . . . . . . . . . . . . . 59 |
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 . . . . . . . . . . . . . . . . . . . . . . . 60 |
149 |
6.4.25. Resetting a sampler channel . . . . . . . . . . . . . 61 |
6.4.25. Adding an effect send to a sampler channel . . . . . 61 |
150 |
6.5. Controlling connection . . . . . . . . . . . . . . . . . . 61 |
6.4.26. Removing an effect send from a sampler channel . . . 62 |
151 |
6.5.1. Register front-end for receiving event messages . . . 61 |
6.4.27. Getting amount of effect sends on a sampler channel . 63 |
152 |
|
6.4.28. Listing all effect sends on a sampler channel . . . . 63 |
153 |
|
6.4.29. Getting effect send information . . . . . . . . . . . 64 |
154 |
|
6.4.30. Changing effect send's name . . . . . . . . . . . . . 65 |
155 |
|
6.4.31. Altering effect send's audio routing . . . . . . . . 66 |
156 |
|
6.4.32. Altering effect send's MIDI controller . . . . . . . 67 |
157 |
|
6.4.33. Altering effect send's send level . . . . . . . . . . 67 |
158 |
|
6.4.34. Resetting a sampler channel . . . . . . . . . . . . . 68 |
159 |
|
6.5. Controlling connection . . . . . . . . . . . . . . . . . 69 |
160 |
|
6.5.1. Register front-end for receiving event messages . . . 69 |
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 . . . . . . . . . . . . . . . . . . . . . . 70 |
163 |
6.5.3. Enable or disable echo of commands . . . . . . . . . . 63 |
6.5.3. Enable or disable echo of commands . . . . . . . . . 70 |
|
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 |
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 3] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
|
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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
164 |
|
|
165 |
|
|
166 |
|
|
167 |
|
Schoenebeck Expires September 30, 2007 [Page 3] |
168 |
|
|
169 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
170 |
|
|
171 |
|
|
172 |
|
6.5.4. Close client connection . . . . . . . . . . . . . . . 71 |
173 |
|
6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 71 |
174 |
|
6.6.1. Current number of active voices . . . . . . . . . . . 71 |
175 |
|
6.6.2. Maximum amount of active voices . . . . . . . . . . . 72 |
176 |
|
6.6.3. Reset sampler . . . . . . . . . . . . . . . . . . . . 72 |
177 |
|
6.6.4. General sampler informations . . . . . . . . . . . . 72 |
178 |
|
6.6.5. Getting global volume attenuation . . . . . . . . . . 73 |
179 |
|
6.6.6. Setting global volume attenuation . . . . . . . . . . 73 |
180 |
|
6.7. MIDI Instrument Mapping . . . . . . . . . . . . . . . . . 74 |
181 |
|
6.7.1. Create a new MIDI instrument map . . . . . . . . . . 74 |
182 |
|
6.7.2. Delete one particular or all MIDI instrument maps . . 75 |
183 |
|
6.7.3. Get amount of existing MIDI instrument maps . . . . . 76 |
184 |
|
6.7.4. Getting all created MIDI instrument maps . . . . . . 76 |
185 |
|
6.7.5. Getting MIDI instrument map information . . . . . . . 77 |
186 |
|
6.7.6. Renaming a MIDI instrument map . . . . . . . . . . . 78 |
187 |
|
6.7.7. Create or replace a MIDI instrument map entry . . . . 78 |
188 |
|
6.7.8. Getting ammount of MIDI instrument map entries . . . 81 |
189 |
|
6.7.9. Getting indeces of all entries of a MIDI |
190 |
|
instrument map . . . . . . . . . . . . . . . . . . . 82 |
191 |
|
6.7.10. Remove an entry from the MIDI instrument map . . . . 82 |
192 |
|
6.7.11. Get current settings of MIDI instrument map entry . . 83 |
193 |
|
6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . . 84 |
194 |
|
7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . 86 |
195 |
|
8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 |
196 |
|
8.1. Number of audio output devices changed . . . . . . . . . 97 |
197 |
|
8.2. Audio output device's settings changed . . . . . . . . . 97 |
198 |
|
8.3. Number of MIDI input devices changed . . . . . . . . . . 97 |
199 |
|
8.4. MIDI input device's settings changed . . . . . . . . . . 98 |
200 |
|
8.5. Number of sampler channels changed . . . . . . . . . . . 98 |
201 |
|
8.6. Number of active voices changed . . . . . . . . . . . . . 98 |
202 |
|
8.7. Number of active disk streams changed . . . . . . . . . . 99 |
203 |
|
8.8. Disk stream buffer fill state changed . . . . . . . . . . 99 |
204 |
|
8.9. Channel information changed . . . . . . . . . . . . . . . 99 |
205 |
|
8.10. Number of effect sends changed . . . . . . . . . . . . . 100 |
206 |
|
8.11. Effect send information changed . . . . . . . . . . . . . 100 |
207 |
|
8.12. Total number of active voices changed . . . . . . . . . . 100 |
208 |
|
8.13. Number of MIDI instrument maps changed . . . . . . . . . 101 |
209 |
|
8.14. MIDI instrument map information changed . . . . . . . . . 101 |
210 |
|
8.15. Number of MIDI instruments changed . . . . . . . . . . . 101 |
211 |
|
8.16. MIDI instrument information changed . . . . . . . . . . . 102 |
212 |
|
8.17. Global settings changed . . . . . . . . . . . . . . . . . 102 |
213 |
|
8.18. Miscellaneous and debugging events . . . . . . . . . . . 103 |
214 |
|
9. Security Considerations . . . . . . . . . . . . . . . . . . . 104 |
215 |
|
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 105 |
216 |
|
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 106 |
217 |
|
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 107 |
218 |
|
Intellectual Property and Copyright Statements . . . . . . . . . 108 |
219 |
|
|
220 |
|
|
221 |
|
|
222 |
|
|
223 |
Schoenebeck Expires June 18, 2007 [Page 4] |
Schoenebeck Expires September 30, 2007 [Page 4] |
224 |
|
|
225 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
226 |
|
|
227 |
|
|
228 |
1. Requirements notation |
1. Requirements notation |
276 |
|
|
277 |
|
|
278 |
|
|
279 |
Schoenebeck Expires June 18, 2007 [Page 5] |
Schoenebeck Expires September 30, 2007 [Page 5] |
280 |
|
|
281 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
282 |
|
|
283 |
|
|
284 |
2. Versioning of this specification |
2. Versioning of this specification |
332 |
|
|
333 |
|
|
334 |
|
|
335 |
Schoenebeck Expires June 18, 2007 [Page 6] |
Schoenebeck Expires September 30, 2007 [Page 6] |
336 |
|
|
337 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
338 |
|
|
339 |
|
|
340 |
3. Introduction |
3. Introduction |
388 |
|
|
389 |
|
|
390 |
|
|
391 |
Schoenebeck Expires June 18, 2007 [Page 7] |
Schoenebeck Expires September 30, 2007 [Page 7] |
392 |
|
|
393 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
394 |
|
|
395 |
|
|
396 |
4. Focus of this protocol |
4. Focus of this protocol |
444 |
|
|
445 |
|
|
446 |
|
|
447 |
Schoenebeck Expires June 18, 2007 [Page 8] |
Schoenebeck Expires September 30, 2007 [Page 8] |
448 |
|
|
449 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
450 |
|
|
451 |
|
|
452 |
5. Communication Overview |
5. Communication Overview |
500 |
|
|
501 |
|
|
502 |
|
|
503 |
Schoenebeck Expires June 18, 2007 [Page 9] |
Schoenebeck Expires September 30, 2007 [Page 9] |
504 |
|
|
505 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
506 |
|
|
507 |
|
|
508 |
5.1.1. Result format |
5.1.1. Result format |
556 |
|
|
557 |
|
|
558 |
|
|
559 |
Schoenebeck Expires June 18, 2007 [Page 10] |
Schoenebeck Expires September 30, 2007 [Page 10] |
560 |
|
|
561 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
562 |
|
|
563 |
|
|
564 |
set has the following format: |
set has the following format: |
612 |
|
|
613 |
|
|
614 |
|
|
615 |
Schoenebeck Expires June 18, 2007 [Page 11] |
Schoenebeck Expires September 30, 2007 [Page 11] |
616 |
|
|
617 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
618 |
|
|
619 |
|
|
620 |
Each line of the result set MUST end with <CRLF>. |
Each line of the result set MUST end with <CRLF>. |
668 |
|
|
669 |
|
|
670 |
|
|
671 |
Schoenebeck Expires June 18, 2007 [Page 12] |
Schoenebeck Expires September 30, 2007 [Page 12] |
672 |
|
|
673 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
674 |
|
|
675 |
|
|
676 |
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 |
724 |
|
|
725 |
|
|
726 |
|
|
727 |
Schoenebeck Expires June 18, 2007 [Page 13] |
Schoenebeck Expires September 30, 2007 [Page 13] |
728 |
|
|
729 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
730 |
|
|
731 |
|
|
732 |
6. Description for control commands |
6. Description for control commands |
780 |
|
|
781 |
|
|
782 |
|
|
783 |
Schoenebeck Expires June 18, 2007 [Page 14] |
Schoenebeck Expires September 30, 2007 [Page 14] |
784 |
|
|
785 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
786 |
|
|
787 |
|
|
788 |
6.2.1. Getting amount of available audio output drivers |
6.2.1. Getting amount of available audio output drivers |
836 |
|
|
837 |
|
|
838 |
|
|
839 |
Schoenebeck Expires June 18, 2007 [Page 15] |
Schoenebeck Expires September 30, 2007 [Page 15] |
840 |
|
|
841 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
842 |
|
|
843 |
|
|
844 |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
LinuxSampler will answer by sending a <CRLF> separated list. Each |
892 |
|
|
893 |
|
|
894 |
|
|
895 |
Schoenebeck Expires June 18, 2007 [Page 16] |
Schoenebeck Expires September 30, 2007 [Page 16] |
896 |
|
|
897 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
898 |
|
|
899 |
|
|
900 |
obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" |
obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" |
948 |
|
|
949 |
|
|
950 |
|
|
951 |
Schoenebeck Expires June 18, 2007 [Page 17] |
Schoenebeck Expires September 30, 2007 [Page 17] |
952 |
|
|
953 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
954 |
|
|
955 |
|
|
956 |
MULTIPLICITY - |
MULTIPLICITY - |
1004 |
|
|
1005 |
|
|
1006 |
|
|
1007 |
Schoenebeck Expires June 18, 2007 [Page 18] |
Schoenebeck Expires September 30, 2007 [Page 18] |
1008 |
|
|
1009 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1010 |
|
|
1011 |
|
|
1012 |
returned, dependent to driver parameter) |
returned, dependent to driver parameter) |
1060 |
|
|
1061 |
|
|
1062 |
|
|
1063 |
Schoenebeck Expires June 18, 2007 [Page 19] |
Schoenebeck Expires September 30, 2007 [Page 19] |
1064 |
|
|
1065 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1066 |
|
|
1067 |
|
|
1068 |
"TYPE: INT" |
"TYPE: INT" |
1116 |
|
|
1117 |
|
|
1118 |
|
|
1119 |
Schoenebeck Expires June 18, 2007 [Page 20] |
Schoenebeck Expires September 30, 2007 [Page 20] |
1120 |
|
|
1121 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1122 |
|
|
1123 |
|
|
1124 |
providing an appropriate warning code and warning message |
providing an appropriate warning code and warning message |
1172 |
|
|
1173 |
|
|
1174 |
|
|
1175 |
Schoenebeck Expires June 18, 2007 [Page 21] |
Schoenebeck Expires September 30, 2007 [Page 21] |
1176 |
|
|
1177 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1178 |
|
|
1179 |
|
|
1180 |
C: "DESTROY AUDIO_OUTPUT_DEVICE 0" |
C: "DESTROY AUDIO_OUTPUT_DEVICE 0" |
1228 |
|
|
1229 |
|
|
1230 |
|
|
1231 |
Schoenebeck Expires June 18, 2007 [Page 22] |
Schoenebeck Expires September 30, 2007 [Page 22] |
1232 |
|
|
1233 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1234 |
|
|
1235 |
|
|
1236 |
Possible Answers: |
Possible Answers: |
1284 |
|
|
1285 |
|
|
1286 |
|
|
1287 |
Schoenebeck Expires June 18, 2007 [Page 23] |
Schoenebeck Expires September 30, 2007 [Page 23] |
1288 |
|
|
1289 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1290 |
|
|
1291 |
|
|
1292 |
"FRAGMENTS: 2" |
"FRAGMENTS: 2" |
1340 |
|
|
1341 |
|
|
1342 |
|
|
1343 |
Schoenebeck Expires June 18, 2007 [Page 24] |
Schoenebeck Expires September 30, 2007 [Page 24] |
1344 |
|
|
1345 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1346 |
|
|
1347 |
|
|
1348 |
6.2.11. Getting information about an audio channel |
6.2.11. Getting information about an audio channel |
1396 |
|
|
1397 |
|
|
1398 |
|
|
1399 |
Schoenebeck Expires June 18, 2007 [Page 25] |
Schoenebeck Expires September 30, 2007 [Page 25] |
1400 |
|
|
1401 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1402 |
|
|
1403 |
|
|
1404 |
Examples: |
Examples: |
1452 |
|
|
1453 |
|
|
1454 |
|
|
1455 |
Schoenebeck Expires June 18, 2007 [Page 26] |
Schoenebeck Expires September 30, 2007 [Page 26] |
1456 |
|
|
1457 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1458 |
|
|
1459 |
|
|
1460 |
channel number and <param> a specific channel parameter name for |
channel number and <param> a specific channel parameter name for |
1508 |
|
|
1509 |
|
|
1510 |
|
|
1511 |
Schoenebeck Expires June 18, 2007 [Page 27] |
Schoenebeck Expires September 30, 2007 [Page 27] |
1512 |
|
|
1513 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1514 |
|
|
1515 |
|
|
1516 |
RANGE_MAX - |
RANGE_MAX - |
1564 |
|
|
1565 |
|
|
1566 |
|
|
1567 |
Schoenebeck Expires June 18, 2007 [Page 28] |
Schoenebeck Expires September 30, 2007 [Page 28] |
1568 |
|
|
1569 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1570 |
|
|
1571 |
|
|
1572 |
"OK" - |
"OK" - |
1620 |
|
|
1621 |
|
|
1622 |
|
|
1623 |
Schoenebeck Expires June 18, 2007 [Page 29] |
Schoenebeck Expires September 30, 2007 [Page 29] |
1624 |
|
|
1625 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1626 |
|
|
1627 |
|
|
1628 |
Note: examples in this chapter showing particular parameters of |
Note: examples in this chapter showing particular parameters of |
1676 |
|
|
1677 |
|
|
1678 |
|
|
1679 |
Schoenebeck Expires June 18, 2007 [Page 30] |
Schoenebeck Expires September 30, 2007 [Page 30] |
1680 |
|
|
1681 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1682 |
|
|
1683 |
|
|
1684 |
6.3.3. Getting information about a specific MIDI input driver |
6.3.3. Getting information about a specific MIDI input driver |
1732 |
|
|
1733 |
|
|
1734 |
|
|
1735 |
Schoenebeck Expires June 18, 2007 [Page 31] |
Schoenebeck Expires September 30, 2007 [Page 31] |
1736 |
|
|
1737 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1738 |
|
|
1739 |
|
|
1740 |
6.3.4. Getting information about specific MIDI input driver parameter |
6.3.4. Getting information about specific MIDI input driver parameter |
1788 |
|
|
1789 |
|
|
1790 |
|
|
1791 |
Schoenebeck Expires June 18, 2007 [Page 32] |
Schoenebeck Expires September 30, 2007 [Page 32] |
1792 |
|
|
1793 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1794 |
|
|
1795 |
|
|
1796 |
FIX - |
FIX - |
1844 |
|
|
1845 |
|
|
1846 |
|
|
1847 |
Schoenebeck Expires June 18, 2007 [Page 33] |
Schoenebeck Expires September 30, 2007 [Page 33] |
1848 |
|
|
1849 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1850 |
|
|
1851 |
|
|
1852 |
may also appear without (optionally returned, dependent to |
may also appear without (optionally returned, dependent to |
1900 |
|
|
1901 |
|
|
1902 |
|
|
1903 |
Schoenebeck Expires June 18, 2007 [Page 34] |
Schoenebeck Expires September 30, 2007 [Page 34] |
1904 |
|
|
1905 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1906 |
|
|
1907 |
|
|
1908 |
"OK[<device-id>]" - |
"OK[<device-id>]" - |
1956 |
|
|
1957 |
|
|
1958 |
|
|
1959 |
Schoenebeck Expires June 18, 2007 [Page 35] |
Schoenebeck Expires September 30, 2007 [Page 35] |
1960 |
|
|
1961 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
1962 |
|
|
1963 |
|
|
1964 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
2012 |
|
|
2013 |
|
|
2014 |
|
|
2015 |
Schoenebeck Expires June 18, 2007 [Page 36] |
Schoenebeck Expires September 30, 2007 [Page 36] |
2016 |
|
|
2017 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2018 |
|
|
2019 |
|
|
2020 |
6.3.9. Getting current settings of a MIDI input device |
6.3.9. Getting current settings of a MIDI input device |
2068 |
|
|
2069 |
|
|
2070 |
|
|
2071 |
Schoenebeck Expires June 18, 2007 [Page 37] |
Schoenebeck Expires September 30, 2007 [Page 37] |
2072 |
|
|
2073 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2074 |
|
|
2075 |
|
|
2076 |
"ACTIVE: true" |
"ACTIVE: true" |
2124 |
|
|
2125 |
|
|
2126 |
|
|
2127 |
Schoenebeck Expires June 18, 2007 [Page 38] |
Schoenebeck Expires September 30, 2007 [Page 38] |
2128 |
|
|
2129 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2130 |
|
|
2131 |
|
|
2132 |
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 |
2180 |
|
|
2181 |
|
|
2182 |
|
|
2183 |
Schoenebeck Expires June 18, 2007 [Page 39] |
Schoenebeck Expires September 30, 2007 [Page 39] |
2184 |
|
|
2185 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2186 |
|
|
2187 |
|
|
2188 |
character string to that info category. There is information |
character string to that info category. There is information |
2236 |
|
|
2237 |
|
|
2238 |
|
|
2239 |
Schoenebeck Expires June 18, 2007 [Page 40] |
Schoenebeck Expires September 30, 2007 [Page 40] |
2240 |
|
|
2241 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2242 |
|
|
2243 |
|
|
2244 |
returned, dependent to device and port parameter) |
returned, dependent to device and port parameter) |
2292 |
|
|
2293 |
|
|
2294 |
|
|
2295 |
Schoenebeck Expires June 18, 2007 [Page 41] |
Schoenebeck Expires September 30, 2007 [Page 41] |
2296 |
|
|
2297 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2298 |
|
|
2299 |
|
|
2300 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
2348 |
|
|
2349 |
|
|
2350 |
|
|
2351 |
Schoenebeck Expires June 18, 2007 [Page 42] |
Schoenebeck Expires September 30, 2007 [Page 42] |
2352 |
|
|
2353 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2354 |
|
|
2355 |
|
|
2356 |
or more patch parameters provided by the loaded instrument |
or more patch parameters provided by the loaded instrument |
2404 |
|
|
2405 |
|
|
2406 |
|
|
2407 |
Schoenebeck Expires June 18, 2007 [Page 43] |
Schoenebeck Expires September 30, 2007 [Page 43] |
2408 |
|
|
2409 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2410 |
|
|
2411 |
|
|
2412 |
Example: |
Example: |
2460 |
|
|
2461 |
|
|
2462 |
|
|
2463 |
Schoenebeck Expires June 18, 2007 [Page 44] |
Schoenebeck Expires September 30, 2007 [Page 44] |
2464 |
|
|
2465 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2466 |
|
|
2467 |
|
|
2468 |
ADD CHANNEL |
ADD CHANNEL |
2516 |
|
|
2517 |
|
|
2518 |
|
|
2519 |
Schoenebeck Expires June 18, 2007 [Page 45] |
Schoenebeck Expires September 30, 2007 [Page 45] |
2520 |
|
|
2521 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2522 |
|
|
2523 |
|
|
2524 |
"OK" - |
"OK" - |
2572 |
|
|
2573 |
|
|
2574 |
|
|
2575 |
Schoenebeck Expires June 18, 2007 [Page 46] |
Schoenebeck Expires September 30, 2007 [Page 46] |
2576 |
|
|
2577 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2578 |
|
|
2579 |
|
|
2580 |
LinuxSampler will answer by sending a comma separated list of the |
LinuxSampler will answer by sending a comma separated list of the |
2628 |
|
|
2629 |
|
|
2630 |
|
|
2631 |
Schoenebeck Expires June 18, 2007 [Page 47] |
Schoenebeck Expires September 30, 2007 [Page 47] |
2632 |
|
|
2633 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2634 |
|
|
2635 |
|
|
2636 |
"VERSION: testing-1.0" |
"VERSION: testing-1.0" |
2684 |
|
|
2685 |
|
|
2686 |
|
|
2687 |
Schoenebeck Expires June 18, 2007 [Page 48] |
Schoenebeck Expires September 30, 2007 [Page 48] |
2688 |
|
|
2689 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2690 |
|
|
2691 |
|
|
2692 |
output channel 0 is routed to channel 0 of the audio output |
output channel 0 is routed to channel 0 of the audio output |
2740 |
|
|
2741 |
|
|
2742 |
|
|
2743 |
Schoenebeck Expires June 18, 2007 [Page 49] |
Schoenebeck Expires September 30, 2007 [Page 49] |
2744 |
|
|
2745 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2746 |
|
|
2747 |
|
|
2748 |
MUTE - |
MUTE - |
2796 |
|
|
2797 |
|
|
2798 |
|
|
2799 |
Schoenebeck Expires June 18, 2007 [Page 50] |
Schoenebeck Expires September 30, 2007 [Page 50] |
2800 |
|
|
2801 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2802 |
|
|
2803 |
|
|
2804 |
"MIDI_INPUT_CHANNEL: 5" |
"MIDI_INPUT_CHANNEL: 5" |
2852 |
|
|
2853 |
|
|
2854 |
|
|
2855 |
Schoenebeck Expires June 18, 2007 [Page 51] |
Schoenebeck Expires September 30, 2007 [Page 51] |
2856 |
|
|
2857 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2858 |
|
|
2859 |
|
|
2860 |
return "NA" for not available. |
return "NA" for not available. |
2908 |
|
|
2909 |
|
|
2910 |
|
|
2911 |
Schoenebeck Expires June 18, 2007 [Page 52] |
Schoenebeck Expires September 30, 2007 [Page 52] |
2912 |
|
|
2913 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2914 |
|
|
2915 |
|
|
2916 |
S: "" |
S: "" |
2964 |
|
|
2965 |
|
|
2966 |
|
|
2967 |
Schoenebeck Expires June 18, 2007 [Page 53] |
Schoenebeck Expires September 30, 2007 [Page 53] |
2968 |
|
|
2969 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
2970 |
|
|
2971 |
|
|
2972 |
Where <audio-output-type> is currently either "ALSA" or "JACK" and |
Where <audio-output-type> is currently either "ALSA" or "JACK" and |
3020 |
|
|
3021 |
|
|
3022 |
|
|
3023 |
Schoenebeck Expires June 18, 2007 [Page 54] |
Schoenebeck Expires September 30, 2007 [Page 54] |
3024 |
|
|
3025 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
3026 |
|
|
3027 |
|
|
3028 |
if audio output channel was set, but there are noteworthy |
if audio output channel was set, but there are noteworthy |
3076 |
|
|
3077 |
|
|
3078 |
|
|
3079 |
Schoenebeck Expires June 18, 2007 [Page 55] |
Schoenebeck Expires September 30, 2007 [Page 55] |
3080 |
|
|
3081 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
3082 |
|
|
3083 |
|
|
3084 |
6.4.18. Setting MIDI input type |
6.4.18. Setting MIDI input type |
3132 |
|
|
3133 |
|
|
3134 |
|
|
3135 |
Schoenebeck Expires June 18, 2007 [Page 56] |
Schoenebeck Expires September 30, 2007 [Page 56] |
3136 |
|
|
3137 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
3138 |
|
|
3139 |
|
|
3140 |
on success |
on success |
3188 |
|
|
3189 |
|
|
3190 |
|
|
3191 |
Schoenebeck Expires June 18, 2007 [Page 57] |
Schoenebeck Expires September 30, 2007 [Page 57] |
3192 |
|
|
3193 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
3194 |
|
|
3195 |
|
|
3196 |
|
|
3244 |
|
|
3245 |
|
|
3246 |
|
|
3247 |
Schoenebeck Expires June 18, 2007 [Page 58] |
Schoenebeck Expires September 30, 2007 [Page 58] |
3248 |
|
|
3249 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
3250 |
|
|
3251 |
|
|
3252 |
"OK" - |
"OK" - |
3300 |
|
|
3301 |
|
|
3302 |
|
|
3303 |
Schoenebeck Expires June 18, 2007 [Page 59] |
Schoenebeck Expires September 30, 2007 [Page 59] |
3304 |
|
|
3305 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
3306 |
|
|
3307 |
|
|
3308 |
Examples: |
Examples: |
3356 |
|
|
3357 |
|
|
3358 |
|
|
3359 |
Schoenebeck Expires June 18, 2007 [Page 60] |
Schoenebeck Expires September 30, 2007 [Page 60] |
3360 |
|
|
3361 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3362 |
|
|
3363 |
|
|
3364 |
|
Examples: |
3365 |
|
|
3366 |
|
|
3367 |
|
|
3368 |
|
6.4.25. Adding an effect send to a sampler channel |
3369 |
|
|
3370 |
|
The front-end can create an additional effect send on a specific |
3371 |
|
sampler channel by sending the following command: |
3372 |
|
|
3373 |
|
CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>] |
3374 |
|
|
3375 |
|
Where <sampler-channel> is the respective sampler channel number as |
3376 |
|
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3377 |
|
(Section 6.4.4) command, that is the sampler channel on which the |
3378 |
|
effect send should be created on, <midi-ctrl> is a number between |
3379 |
|
0..127 defining the MIDI controller which can alter the effect send |
3380 |
|
level and <name> is an optional argument defining a name for the |
3381 |
|
effect send entity. The name does not have to be unique. |
3382 |
|
|
3383 |
|
By default, that is as initial routing, the effect send's audio |
3384 |
|
channels are automatically routed to the last audio channels of the |
3385 |
|
sampler channel's audio output device, that way you can i.e. first |
3386 |
|
increase the amount of audio channels on the audio output device for |
3387 |
|
having dedicated effect send output channels and when "CREATE |
3388 |
|
FX_SEND" is called, those channels will automatically be picked. You |
3389 |
|
can alter the destination channels however with "SET FX_SEND |
3390 |
|
AUDIO_OUTPUT_CHANNEL" (Section 6.4.31). |
3391 |
|
|
3392 |
|
Note: Create effect sends on a sampler channel only when needed, |
3393 |
|
because having effect sends on a sampler channel will decrease |
3394 |
|
runtime performance, because for implementing channel effect sends, |
3395 |
|
separate (sampler channel local) audio buffers are needed to render |
3396 |
|
and mix the voices and route the audio signal afterwards to the |
3397 |
|
master outputs and effect send outputs (along with their respective |
3398 |
|
effect send levels). A sampler channel without effect sends however |
3399 |
|
can mix its voices directly into the audio output devices's audio |
3400 |
|
buffers and is thus faster. |
3401 |
|
|
3402 |
|
Possible Answers: |
3403 |
|
|
3404 |
|
"OK[<fx-send-id>]" - |
3405 |
|
|
3406 |
|
in case a new effect send could be added to the sampler |
3407 |
|
channel, where <fx-send-id> reflects the unique ID of the newly |
3408 |
|
created effect send entity |
3409 |
|
|
3410 |
|
|
3411 |
|
|
3412 |
|
|
3413 |
|
|
3414 |
|
|
3415 |
|
Schoenebeck Expires September 30, 2007 [Page 61] |
3416 |
|
|
3417 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3418 |
|
|
3419 |
|
|
3420 |
|
"ERR:<error-code>:<error-message>" - |
3421 |
|
|
3422 |
|
when a new effect send could not be added, i.e. due to invalid |
3423 |
|
parameters |
3424 |
|
|
3425 |
|
Examples: |
3426 |
|
|
3427 |
|
C: "CREATE FX_SEND 0 91 'Reverb Send'" |
3428 |
|
|
3429 |
|
S: "OK[0]" |
3430 |
|
|
3431 |
|
C: "CREATE FX_SEND 0 93" |
3432 |
|
|
3433 |
|
S: "OK[1]" |
3434 |
|
|
3435 |
|
6.4.26. Removing an effect send from a sampler channel |
3436 |
|
|
3437 |
|
The front-end can remove an existing effect send on a specific |
3438 |
|
sampler channel by sending the following command: |
3439 |
|
|
3440 |
|
DESTROY FX_SEND <sampler-channel> <fx-send-id> |
3441 |
|
|
3442 |
|
Where <sampler-channel> is the respective sampler channel number as |
3443 |
|
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3444 |
|
(Section 6.4.4) command, that is the sampler channel from which the |
3445 |
|
effect send should be removed from and <fx-send-id> is the respective |
3446 |
|
effect send number as returned by the "CREATE FX_SEND" |
3447 |
|
(Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command. |
3448 |
|
|
3449 |
|
Possible Answers: |
3450 |
|
|
3451 |
|
"OK" - |
3452 |
|
|
3453 |
|
on success |
3454 |
|
|
3455 |
|
"ERR:<error-code>:<error-message>" - |
3456 |
|
|
3457 |
|
in case it failed, providing an appropriate error code and |
3458 |
|
error message |
3459 |
|
|
3460 |
|
Example: |
3461 |
|
|
3462 |
|
C: "DESTROY FX_SEND 0 0" |
3463 |
|
|
3464 |
|
S: "OK" |
3465 |
|
|
3466 |
|
|
3467 |
|
|
3468 |
|
|
3469 |
|
|
3470 |
|
|
3471 |
|
Schoenebeck Expires September 30, 2007 [Page 62] |
3472 |
|
|
3473 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
3474 |
|
|
3475 |
|
|
3476 |
|
6.4.27. Getting amount of effect sends on a sampler channel |
3477 |
|
|
3478 |
|
The front-end can ask for the amount of effect sends on a specific |
3479 |
|
sampler channel by sending the following command: |
3480 |
|
|
3481 |
|
GET FX_SENDS <sampler-channel> |
3482 |
|
|
3483 |
|
Where <sampler-channel> is the respective sampler channel number as |
3484 |
|
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3485 |
|
(Section 6.4.4) command. |
3486 |
|
|
3487 |
|
Possible Answers: |
3488 |
|
|
3489 |
|
The sampler will answer by returning the number of effect sends on |
3490 |
|
the given sampler channel. |
3491 |
|
|
3492 |
|
Example: |
3493 |
|
|
3494 |
|
C: "GET FX_SENDS 0" |
3495 |
|
|
3496 |
|
S: "2" |
3497 |
|
|
3498 |
|
6.4.28. Listing all effect sends on a sampler channel |
3499 |
|
|
3500 |
|
The front-end can ask for a list of effect sends on a specific |
3501 |
|
sampler channel by sending the following command: |
3502 |
|
|
3503 |
|
LIST FX_SENDS <sampler-channel> |
3504 |
|
|
3505 |
|
Where <sampler-channel> is the respective sampler channel number as |
3506 |
|
returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" |
3507 |
|
(Section 6.4.4) command. |
3508 |
|
|
3509 |
|
Possible Answers: |
3510 |
|
|
3511 |
|
The sampler will answer by returning a comma separated list with |
3512 |
|
all effect sends' numerical IDs on the given sampler channel. |
3513 |
|
|
3514 |
Examples: |
Examples: |
3515 |
|
|
3516 |
|
C: "LIST FX_SENDS 0" |
3517 |
|
|
3518 |
|
S: "0,1" |
3519 |
|
|
3520 |
|
C: "LIST FX_SENDS 1" |
3521 |
|
|
3522 |
|
S: "" |
3523 |
|
|
3524 |
|
|
3525 |
|
|
3526 |
|
|
3527 |
|
Schoenebeck Expires September 30, 2007 [Page 63] |
3528 |
|
|
3529 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3530 |
|
|
3531 |
|
|
3532 |
|
6.4.29. Getting effect send information |
3533 |
|
|
3534 |
|
The front-end can ask for the current settings of an effect send |
3535 |
|
entity by sending the following command: |
3536 |
|
|
3537 |
|
GET FX_SEND INFO <sampler-channel> <fx-send-id> |
3538 |
|
|
3539 |
|
Where <sampler-channel> is the sampler channel number as returned by |
3540 |
|
the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3541 |
|
command and <fx-send-id> reflects the numerical ID of the effect send |
3542 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3543 |
|
FX_SENDS" (Section 6.4.28) command. |
3544 |
|
|
3545 |
|
Possible Answers: |
3546 |
|
|
3547 |
|
The sampler will answer by sending a <CRLF> separated list. Each |
3548 |
|
answer line begins with the settings category name followed by a |
3549 |
|
colon and then a space character <SP> and finally the info |
3550 |
|
character string to that setting category. At the moment the |
3551 |
|
following categories are defined: |
3552 |
|
|
3553 |
|
|
3554 |
|
|
3555 |
|
NAME - |
3556 |
|
|
3557 |
|
name of the effect send entity |
3558 |
|
|
3559 |
|
MIDI_CONTROLLER - |
3560 |
|
|
3561 |
|
a value between 0 and 127 reflecting the MIDI controller |
3562 |
|
which is able to modify the effect send's send level |
3563 |
|
|
3564 |
|
LEVEL - |
3565 |
|
|
3566 |
|
optionally dotted number reflecting the effect send's |
3567 |
|
current send level (where a value < 1.0 means attenuation |
3568 |
|
and a value > 1.0 means amplification) |
3569 |
|
|
3570 |
|
AUDIO_OUTPUT_ROUTING - |
3571 |
|
|
3572 |
|
comma separated list which reflects to which audio channel |
3573 |
|
of the selected audio output device each effect send output |
3574 |
|
channel is routed to, e.g. "0,3" would mean the effect |
3575 |
|
send's output channel 0 is routed to channel 0 of the audio |
3576 |
|
output device and the effect send's output channel 1 is |
3577 |
|
routed to the channel 3 of the audio output device (see "SET |
3578 |
|
FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details) |
3579 |
|
|
3580 |
|
|
3581 |
|
|
3582 |
|
|
3583 |
|
Schoenebeck Expires September 30, 2007 [Page 64] |
3584 |
|
|
3585 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3586 |
|
|
3587 |
|
|
3588 |
|
The mentioned fields above don't have to be in particular order. |
3589 |
|
|
3590 |
|
Example: |
3591 |
|
|
3592 |
|
C: "GET FX_SEND INFO 0 0" |
3593 |
|
|
3594 |
|
S: "NAME: Reverb Send" |
3595 |
|
|
3596 |
|
"MIDI_CONTROLLER: 91" |
3597 |
|
|
3598 |
|
"LEVEL: 0.3" |
3599 |
|
|
3600 |
|
"AUDIO_OUTPUT_ROUTING: 2,3" |
3601 |
|
|
3602 |
|
"." |
3603 |
|
|
3604 |
|
6.4.30. Changing effect send's name |
3605 |
|
|
3606 |
|
The front-end can alter the current name of an effect send entity by |
3607 |
|
sending the following command: |
3608 |
|
|
3609 |
|
SET FX_SEND NAME <sampler-chan> <fx-send-id> <name> |
3610 |
|
|
3611 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3612 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3613 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3614 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3615 |
|
FX_SENDS" (Section 6.4.28) command and <name> is the new name of the |
3616 |
|
effect send entity, which does not have to be unique. |
3617 |
|
|
3618 |
|
Possible Answers: |
3619 |
|
|
3620 |
|
"OK" - |
3621 |
|
|
3622 |
|
on success |
3623 |
|
|
3624 |
|
"ERR:<error-code>:<error-message>" - |
3625 |
|
|
3626 |
|
in case it failed, providing an appropriate error code and |
3627 |
|
error message |
3628 |
|
|
3629 |
|
Example: |
3630 |
|
|
3631 |
|
C: "SET FX_SEND NAME 0 0 'Fx Send 1'" |
3632 |
|
|
3633 |
|
S: "OK" |
3634 |
|
|
3635 |
|
|
3636 |
|
|
3637 |
|
|
3638 |
|
|
3639 |
|
Schoenebeck Expires September 30, 2007 [Page 65] |
3640 |
|
|
3641 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3642 |
|
|
3643 |
|
|
3644 |
|
6.4.31. Altering effect send's audio routing |
3645 |
|
|
3646 |
|
The front-end can alter the destination of an effect send's audio |
3647 |
|
channel on a specific sampler channel by sending the following |
3648 |
|
command: |
3649 |
|
|
3650 |
|
SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> |
3651 |
|
<audio-src> <audio-dst> |
3652 |
|
|
3653 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3654 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3655 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3656 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3657 |
|
FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID |
3658 |
|
of the effect send's audio channel which should be rerouted and |
3659 |
|
<audio-dst> is the numerical ID of the audio channel of the selected |
3660 |
|
audio output device where <audio-src> should be routed to. |
3661 |
|
|
3662 |
|
Note that effect sends can only route audio to the same audio output |
3663 |
|
device as assigned to the effect send's sampler channel. Also note |
3664 |
|
that an effect send entity does always have exactly as much audio |
3665 |
|
channels as its sampler channel. So if the sampler channel is |
3666 |
|
stereo, the effect send does have two audio channels as well. Also |
3667 |
|
keep in mind that the amount of audio channels on a sampler channel |
3668 |
|
might be dependant not only to the deployed sampler engine on the |
3669 |
|
sampler channel, but also dependant to the instrument currently |
3670 |
|
loaded. However you can (effectively) turn an i.e. stereo effect |
3671 |
|
send into a mono one by simply altering its audio routing |
3672 |
|
appropriately. |
3673 |
|
|
3674 |
|
Possible Answers: |
3675 |
|
|
3676 |
|
"OK" - |
3677 |
|
|
3678 |
|
on success |
3679 |
|
|
3680 |
|
"WRN:<warning-code>:<warning-message>" - |
3681 |
|
|
3682 |
|
if audio output channel was set, but there are noteworthy |
3683 |
|
issue(s) related, providing an appropriate warning code and |
3684 |
|
warning message |
3685 |
|
|
3686 |
|
"ERR:<error-code>:<error-message>" - |
3687 |
|
|
3688 |
|
in case it failed, providing an appropriate error code and |
3689 |
|
error message |
3690 |
|
|
3691 |
|
Example: |
3692 |
|
|
3693 |
|
|
3694 |
|
|
3695 |
|
Schoenebeck Expires September 30, 2007 [Page 66] |
3696 |
|
|
3697 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3698 |
|
|
3699 |
|
|
3700 |
|
C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2" |
3701 |
|
|
3702 |
|
S: "OK" |
3703 |
|
|
3704 |
|
6.4.32. Altering effect send's MIDI controller |
3705 |
|
|
3706 |
|
The front-end can alter the MIDI controller of an effect send entity |
3707 |
|
by sending the following command: |
3708 |
|
|
3709 |
|
SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi- |
3710 |
|
ctrl> |
3711 |
|
|
3712 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3713 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3714 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3715 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3716 |
|
FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI |
3717 |
|
controller which shall be able to modify the effect send's send |
3718 |
|
level. |
3719 |
|
|
3720 |
|
Possible Answers: |
3721 |
|
|
3722 |
|
"OK" - |
3723 |
|
|
3724 |
|
on success |
3725 |
|
|
3726 |
|
"WRN:<warning-code>:<warning-message>" - |
3727 |
|
|
3728 |
|
if MIDI controller was set, but there are noteworthy issue(s) |
3729 |
|
related, providing an appropriate warning code and warning |
3730 |
|
message |
3731 |
|
|
3732 |
|
"ERR:<error-code>:<error-message>" - |
3733 |
|
|
3734 |
|
in case it failed, providing an appropriate error code and |
3735 |
|
error message |
3736 |
|
|
3737 |
|
Example: |
3738 |
|
|
3739 |
|
C: "SET FX_SEND MIDI_CONTROLLER 0 0 91" |
3740 |
|
|
3741 |
|
S: "OK" |
3742 |
|
|
3743 |
|
6.4.33. Altering effect send's send level |
3744 |
|
|
3745 |
|
The front-end can alter the current send level of an effect send |
3746 |
|
entity by sending the following command: |
3747 |
|
|
3748 |
|
|
3749 |
|
|
3750 |
|
|
3751 |
|
Schoenebeck Expires September 30, 2007 [Page 67] |
3752 |
|
|
3753 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3754 |
|
|
3755 |
|
|
3756 |
|
SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume> |
3757 |
|
|
3758 |
|
Where <sampler-chan> is the sampler channel number as returned by the |
3759 |
|
"ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4) |
3760 |
|
command, <fx-send-id> reflects the numerical ID of the effect send |
3761 |
|
entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST |
3762 |
|
FX_SENDS" (Section 6.4.28) command and <volume> is an optionally |
3763 |
|
dotted positive number (a value smaller than 1.0 means attenuation, |
3764 |
|
whereas a value greater than 1.0 means amplification) reflecting the |
3765 |
|
new send level. |
3766 |
|
|
3767 |
|
Possible Answers: |
3768 |
|
|
3769 |
|
"OK" - |
3770 |
|
|
3771 |
|
on success |
3772 |
|
|
3773 |
|
"WRN:<warning-code>:<warning-message>" - |
3774 |
|
|
3775 |
|
if new send level was set, but there are noteworthy issue(s) |
3776 |
|
related, providing an appropriate warning code and warning |
3777 |
|
message |
3778 |
|
|
3779 |
|
"ERR:<error-code>:<error-message>" - |
3780 |
|
|
3781 |
|
in case it failed, providing an appropriate error code and |
3782 |
|
error message |
3783 |
|
|
3784 |
|
Example: |
3785 |
|
|
3786 |
|
C: "SET FX_SEND LEVEL 0 0 0.15" |
3787 |
|
|
3788 |
|
S: "OK" |
3789 |
|
|
3790 |
6.4.25. Resetting a sampler channel |
6.4.34. Resetting a sampler channel |
3791 |
|
|
3792 |
The front-end can reset a particular sampler channel by sending the |
The front-end can reset a particular sampler channel by sending the |
3793 |
following command: |
following command: |
3801 |
|
|
3802 |
Possible Answers: |
Possible Answers: |
3803 |
|
|
3804 |
|
|
3805 |
|
|
3806 |
|
|
3807 |
|
Schoenebeck Expires September 30, 2007 [Page 68] |
3808 |
|
|
3809 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3810 |
|
|
3811 |
|
|
3812 |
"OK" - |
"OK" - |
3813 |
|
|
3814 |
on success |
on success |
3838 |
The front-end can register itself to the LinuxSampler application to |
The front-end can register itself to the LinuxSampler application to |
3839 |
be informed about noteworthy events by sending this command: |
be informed about noteworthy events by sending this command: |
3840 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 61] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3841 |
SUBSCRIBE <event-id> |
SUBSCRIBE <event-id> |
3842 |
|
|
3843 |
where <event-id> will be replaced by the respective event that client |
where <event-id> will be replaced by the respective event that client |
3855 |
related, providing an appropriate warning code and warning |
related, providing an appropriate warning code and warning |
3856 |
message |
message |
3857 |
|
|
3858 |
|
|
3859 |
|
|
3860 |
|
|
3861 |
|
|
3862 |
|
|
3863 |
|
Schoenebeck Expires September 30, 2007 [Page 69] |
3864 |
|
|
3865 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3866 |
|
|
3867 |
|
|
3868 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
3869 |
|
|
3870 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3896 |
related, providing an appropriate warning code and warning |
related, providing an appropriate warning code and warning |
3897 |
message |
message |
3898 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 62] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3899 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
3900 |
|
|
3901 |
in case it failed, providing an appropriate error code and |
in case it failed, providing an appropriate error code and |
3913 |
SET ECHO <value> |
SET ECHO <value> |
3914 |
|
|
3915 |
Where <value> should be replaced either by "1" to enable echo mode or |
Where <value> should be replaced either by "1" to enable echo mode or |
3916 |
|
|
3917 |
|
|
3918 |
|
|
3919 |
|
Schoenebeck Expires September 30, 2007 [Page 70] |
3920 |
|
|
3921 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3922 |
|
|
3923 |
|
|
3924 |
"0" to disable echo mode. When echo mode is enabled, all commands |
"0" to disable echo mode. When echo mode is enabled, all commands |
3925 |
send to LinuxSampler will be immediately send back and after this |
send to LinuxSampler will be immediately send back and after this |
3926 |
echo the actual response to the command will be returned. Echo mode |
echo the actual response to the command will be returned. Echo mode |
3951 |
This is probably more interesting for manual telnet connections to |
This is probably more interesting for manual telnet connections to |
3952 |
LinuxSampler than really useful for a front-end implementation. |
LinuxSampler than really useful for a front-end implementation. |
3953 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 63] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
3954 |
6.6. Global commands |
6.6. Global commands |
3955 |
|
|
3956 |
The following commands have global impact on the sampler. |
The following commands have global impact on the sampler. |
3967 |
LinuxSampler will answer by returning the number of all active |
LinuxSampler will answer by returning the number of all active |
3968 |
voices on the sampler. |
voices on the sampler. |
3969 |
|
|
3970 |
|
|
3971 |
|
|
3972 |
|
|
3973 |
|
|
3974 |
|
|
3975 |
|
Schoenebeck Expires September 30, 2007 [Page 71] |
3976 |
|
|
3977 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
3978 |
|
|
3979 |
|
|
3980 |
6.6.2. Maximum amount of active voices |
6.6.2. Maximum amount of active voices |
3981 |
|
|
3982 |
The front-end can ask for the maximum number of active voices by |
The front-end can ask for the maximum number of active voices by |
4006 |
|
|
4007 |
|
|
4008 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 64] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4009 |
6.6.4. General sampler informations |
6.6.4. General sampler informations |
4010 |
|
|
4011 |
The client can ask for general informations about the LinuxSampler |
The client can ask for general informations about the LinuxSampler |
4025 |
|
|
4026 |
DESCRIPTION - |
DESCRIPTION - |
4027 |
|
|
4028 |
|
|
4029 |
|
|
4030 |
|
|
4031 |
|
Schoenebeck Expires September 30, 2007 [Page 72] |
4032 |
|
|
4033 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4034 |
|
|
4035 |
|
|
4036 |
arbitrary textual description about the sampler |
arbitrary textual description about the sampler |
4037 |
|
|
4038 |
VERSION - |
VERSION - |
4047 |
The mentioned fields above don't have to be in particular order. |
The mentioned fields above don't have to be in particular order. |
4048 |
Other fields might be added in future. |
Other fields might be added in future. |
4049 |
|
|
4050 |
|
6.6.5. Getting global volume attenuation |
4051 |
|
|
4052 |
|
The client can ask for the current global sampler-wide volume |
4053 |
|
attenuation by sending the following command: |
4054 |
|
|
4055 |
|
GET VOLUME |
4056 |
|
|
4057 |
|
Possible Answers: |
4058 |
|
|
4059 |
|
The sampler will always answer by returning the optional dotted |
4060 |
|
floating point coefficient, reflecting the current global volume |
4061 |
|
attenuation. |
4062 |
|
|
4063 |
|
Note: it is up to the respective sampler engine whether to obey that |
4064 |
|
global volume parameter or not, but in general all engines SHOULD use |
4065 |
|
this parameter. |
4066 |
|
|
4067 |
|
6.6.6. Setting global volume attenuation |
4068 |
|
|
4069 |
|
The client can alter the current global sampler-wide volume |
4070 |
|
attenuation by sending the following command: |
4071 |
|
|
4072 |
|
SET VOLUME <volume> |
4073 |
|
|
4074 |
|
Where <volume> should be replaced by the optional dotted floating |
4075 |
|
point value, reflecting the new global volume parameter. This value |
4076 |
|
might usually be in the range between 0.0 and 1.0, that is for |
4077 |
|
attenuating the overall volume. |
4078 |
|
|
4079 |
|
Possible Answers: |
4080 |
|
|
4081 |
|
"OK" - |
4082 |
|
|
4083 |
|
|
4084 |
|
|
4085 |
|
|
4086 |
|
|
4087 |
|
Schoenebeck Expires September 30, 2007 [Page 73] |
4088 |
|
|
4089 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4090 |
|
|
4091 |
|
|
4092 |
|
on success |
4093 |
|
|
4094 |
|
"WRN:<warning-code>:<warning-message>" - |
4095 |
|
|
4096 |
|
if the global volume was set, but there are noteworthy issue(s) |
4097 |
|
related, providing an appropriate warning code and warning |
4098 |
|
message |
4099 |
|
|
4100 |
|
"ERR:<error-code>:<error-message>" - |
4101 |
|
|
4102 |
|
in case it failed, providing an appropriate error code and |
4103 |
|
error message |
4104 |
|
|
4105 |
6.7. MIDI Instrument Mapping |
6.7. MIDI Instrument Mapping |
4106 |
|
|
4107 |
The MIDI protocol provides a way to switch between instruments by |
The MIDI protocol provides a way to switch between instruments by |
4117 |
By default, that is when the sampler is launched, there is no map, |
By default, that is when the sampler is launched, there is no map, |
4118 |
thus the sampler will simply ignore all program change messages. The |
thus the sampler will simply ignore all program change messages. The |
4119 |
front-end has to explicitly create at least one map, add entries to |
front-end has to explicitly create at least one map, add entries to |
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 65] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4120 |
the map and tell the respective sampler channel(s) which MIDI |
the map and tell the respective sampler channel(s) which MIDI |
4121 |
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 |
4122 |
program change message on the respective sampler channel, that is by |
program change message on the respective sampler channel, that is by |
4137 |
The front-end can add a new MIDI instrument map by sending the |
The front-end can add a new MIDI instrument map by sending the |
4138 |
following command: |
following command: |
4139 |
|
|
4140 |
|
|
4141 |
|
|
4142 |
|
|
4143 |
|
Schoenebeck Expires September 30, 2007 [Page 74] |
4144 |
|
|
4145 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4146 |
|
|
4147 |
|
|
4148 |
ADD MIDI_INSTRUMENT_MAP [<name>] |
ADD MIDI_INSTRUMENT_MAP [<name>] |
4149 |
|
|
4150 |
Where <name> is an optional argument allowing to assign a custom name |
Where <name> is an optional argument allowing to assign a custom name |
4172 |
|
|
4173 |
S: "OK[1]" |
S: "OK[1]" |
4174 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 66] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4175 |
C: "ADD MIDI_INSTRUMENT_MAP" |
C: "ADD MIDI_INSTRUMENT_MAP" |
4176 |
|
|
4177 |
S: "OK[5]" |
S: "OK[5]" |
4193 |
|
|
4194 |
Possible Answers: |
Possible Answers: |
4195 |
|
|
4196 |
|
|
4197 |
|
|
4198 |
|
|
4199 |
|
Schoenebeck Expires September 30, 2007 [Page 75] |
4200 |
|
|
4201 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4202 |
|
|
4203 |
|
|
4204 |
"OK" - |
"OK" - |
4205 |
|
|
4206 |
in case the map(s) could be deleted |
in case the map(s) could be deleted |
4228 |
|
|
4229 |
Possible Answers: |
Possible Answers: |
4230 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 67] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
4231 |
The sampler will answer by returning the current number of MIDI |
The sampler will answer by returning the current number of MIDI |
4232 |
instrument maps. |
instrument maps. |
4233 |
|
|
4247 |
|
|
4248 |
Possible Answers: |
Possible Answers: |
4249 |
|
|
4250 |
|
|
4251 |
|
|
4252 |
|
|
4253 |
|
|
4254 |
|
|
4255 |
|
Schoenebeck Expires September 30, 2007 [Page 76] |
4256 |
|
|
4257 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4258 |
|
|
4259 |
|
|
4260 |
The sampler will answer by returning a comma separated list with |
The sampler will answer by returning a comma separated list with |
4261 |
all MIDI instrument maps' numerical IDs. |
all MIDI instrument maps' numerical IDs. |
4262 |
|
|
4287 |
|
|
4288 |
|
|
4289 |
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 68] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
|
|
|
|
|
|
4290 |
NAME - |
NAME - |
4291 |
|
|
4292 |
custom name of the given map, which does not have to be |
custom name of the given map, which does not have to be |
4293 |
unique |
unique |
4294 |
|
|
4295 |
|
DEFAULT - |
4296 |
|
|
4297 |
|
either true or false, defines whether this map is the |
4298 |
|
default map |
4299 |
|
|
4300 |
The mentioned fields above don't have to be in particular order. |
The mentioned fields above don't have to be in particular order. |
4301 |
|
|
4302 |
Example: |
Example: |
4305 |
|
|
4306 |
S: "NAME: Standard Map" |
S: "NAME: Standard Map" |
4307 |
|
|
4308 |
|
|
4309 |
|
|
4310 |
|
|
4311 |
|
Schoenebeck Expires September 30, 2007 [Page 77] |
4312 |
|
|
4313 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4314 |
|
|
4315 |
|
|
4316 |
|
"DEFAULT: true" |
4317 |
|
|
4318 |
"." |
"." |
4319 |
|
|
4320 |
6.7.6. Renaming a MIDI instrument map |
6.7.6. Renaming a MIDI instrument map |
4348 |
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 |
4349 |
sampler's MIDI instrument map by sending the following command: |
sampler's MIDI instrument map by sending the following command: |
4350 |
|
|
4351 |
|
MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog> |
4352 |
|
<engine_name> <filename> <instrument_index> <volume_value> |
4353 |
|
[<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>] |
|
4354 |
|
|
4355 |
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 |
4356 |
integer value between 0..16383 reflecting the MIDI bank select index, |
integer value between 0..16383 reflecting the MIDI bank select index, |
4361 |
instrument's file to be deployed (encapsulated into apostrophes), |
instrument's file to be deployed (encapsulated into apostrophes), |
4362 |
<instrument_index> the index (integer value) of the instrument within |
<instrument_index> the index (integer value) of the instrument within |
4363 |
the given file, <volume_value> reflects the master volume of the |
the given file, <volume_value> reflects the master volume of the |
4364 |
|
|
4365 |
|
|
4366 |
|
|
4367 |
|
Schoenebeck Expires September 30, 2007 [Page 78] |
4368 |
|
|
4369 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4370 |
|
|
4371 |
|
|
4372 |
instrument as optionally dotted number (where a value < 1.0 means |
instrument as optionally dotted number (where a value < 1.0 means |
4373 |
attenuation and a value > 1.0 means amplification). This parameter |
attenuation and a value > 1.0 means amplification). This parameter |
4374 |
easily allows to adjust the volume of all intruments within a custom |
easily allows to adjust the volume of all intruments within a custom |
4396 |
|
|
4397 |
"PERSISTENT" - |
"PERSISTENT" - |
4398 |
|
|
4399 |
The instrument will immediately be loaded into memory in the |
The instrument will immediately be loaded into memory when this |
4400 |
background when this mapping command is sent and the instrument |
mapping command is sent and the instrument is kept all the |
4401 |
is kept all the time. Instruments with this mode are only |
time. Instruments with this mode are only freed when the |
4402 |
freed when the sampler is reset or all mapping entries with |
sampler is reset or all mapping entries with this mode (and |
4403 |
this mode (and respective instrument) are explicitly changed to |
respective instrument) are explicitly changed to "ON_DEMAND" |
4404 |
"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 |
|
|
|
|
4405 |
|
|
4406 |
not supplied - |
not supplied - |
4407 |
|
|
4417 |
strategy (low memory consumption vs. fast instrument switching) for |
strategy (low memory consumption vs. fast instrument switching) for |
4418 |
each instrument individually. Note, the following restrictions apply |
each instrument individually. Note, the following restrictions apply |
4419 |
to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be |
to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be |
4420 |
|
|
4421 |
|
|
4422 |
|
|
4423 |
|
Schoenebeck Expires September 30, 2007 [Page 79] |
4424 |
|
|
4425 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4426 |
|
|
4427 |
|
|
4428 |
supported by the respective sampler engine (which is technically the |
supported by the respective sampler engine (which is technically the |
4429 |
case when the engine provides an InstrumentManager for its format). |
case when the engine provides an InstrumentManager for its format). |
4430 |
If this is not the case the argument will automatically fall back to |
If this is not the case the argument will automatically fall back to |
4440 |
displaying an appropriate name for mapped instruments (using "GET |
displaying an appropriate name for mapped instruments (using "GET |
4441 |
MIDI_INSTRUMENT INFO" (Section 6.7.11)). |
MIDI_INSTRUMENT INFO" (Section 6.7.11)). |
4442 |
|
|
4443 |
The "MAP MIDI_INSTRUMENT" command will immediately return, thus it |
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
4444 |
will not block when an instrument is to be loaded due to a |
completely established in the sampler. The OPTIONAL "NON_MODAL" |
4445 |
"PERSISTENT" type entry as instruments are loaded in the background. |
argument however causes the respective "MAP MIDI_INSTRUMENT" command |
4446 |
As a consequence this command may not necessarily return an error |
to return immediately, that is to let the sampler establish the |
4447 |
i.e. when the given instrument file does not exist or may turn out to |
mapping in the background. So this argument might be especially |
4448 |
be corrupt. |
useful for mappings with a "PERSISTENT" type, because these have to |
4449 |
|
load the respective instruments immediately and might thus block for |
4450 |
|
a very long time. It is recommended however to use the OPTIONAL |
4451 |
|
"NON_MODAL" argument only if really necessary, because it has the |
4452 |
|
following drawbacks: as "NON_MODAL" instructions return immediately, |
4453 |
|
they may not necessarily return an error i.e. when the given |
4454 |
|
instrument file turns out to be corrupt, beside that subsequent |
4455 |
|
commands in a LSCP instruction sequence might fail, because mandatory |
4456 |
|
mappings are not yet completed. |
4457 |
|
|
4458 |
Possible Answers: |
Possible Answers: |
4459 |
|
|
4468 |
|
|
4469 |
Examples: |
Examples: |
4470 |
|
|
4471 |
|
C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 |
4472 |
|
0.8 PERSISTENT" |
4473 |
|
|
4474 |
|
S: "OK" |
4475 |
|
|
4476 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 71] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
4477 |
|
|
4478 |
|
|
4479 |
C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 |
Schoenebeck Expires September 30, 2007 [Page 80] |
4480 |
0.8 PERSISTENT" |
|
4481 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4482 |
|
|
|
S: "OK" |
|
4483 |
|
|
4484 |
C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 |
C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 |
4485 |
1.0" |
1.0" |
4496 |
|
|
4497 |
S: "OK" |
S: "OK" |
4498 |
|
|
4499 |
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/ |
4500 |
PERSISTENT 'Foo Drumkit'" |
foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'" |
4501 |
|
|
4502 |
S: "OK" |
S: "OK" |
4503 |
|
|
4524 |
|
|
4525 |
S: "234" |
S: "234" |
4526 |
|
|
4527 |
|
C: "GET MIDI_INSTRUMENTS ALL" |
4528 |
|
|
4529 |
|
S: "954" |
4530 |
|
|
4531 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 72] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
4532 |
|
|
4533 |
|
|
|
C: "GET MIDI_INSTRUMENTS ALL" |
|
4534 |
|
|
4535 |
S: "954" |
Schoenebeck Expires September 30, 2007 [Page 81] |
4536 |
|
|
4537 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4538 |
|
|
4539 |
|
|
4540 |
6.7.9. Getting indeces of all entries of a MIDI instrument map |
6.7.9. Getting indeces of all entries of a MIDI instrument map |
4541 |
|
|
4581 |
|
|
4582 |
Possible Answers: |
Possible Answers: |
4583 |
|
|
4584 |
|
"OK" - |
4585 |
|
|
4586 |
|
usually |
4587 |
|
|
4588 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 73] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
4589 |
|
|
4590 |
|
|
4591 |
"OK" - |
Schoenebeck Expires September 30, 2007 [Page 82] |
4592 |
|
|
4593 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4594 |
|
|
|
usually |
|
4595 |
|
|
4596 |
"ERR:<error-code>:<error-message>" - |
"ERR:<error-code>:<error-message>" - |
4597 |
|
|
4636 |
|
|
4637 |
Name of the engine to be deployed for this instrument. |
Name of the engine to be deployed for this instrument. |
4638 |
|
|
4639 |
|
"INSTRUMENT_FILE" - |
4640 |
|
|
4641 |
|
File name of the instrument. |
4642 |
|
|
4643 |
|
|
4644 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 74] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
4645 |
|
|
4646 |
|
|
4647 |
"INSTRUMENT_FILE" - |
Schoenebeck Expires September 30, 2007 [Page 83] |
4648 |
|
|
4649 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4650 |
|
|
|
File name of the instrument. |
|
4651 |
|
|
4652 |
"INSTRUMENT_NR" - |
"INSTRUMENT_NR" - |
4653 |
|
|
4692 |
|
|
4693 |
"." |
"." |
4694 |
|
|
4695 |
|
6.7.12. Clear MIDI instrument map |
4696 |
|
|
4697 |
|
The front-end can clear a whole MIDI instrument map, that is delete |
4698 |
|
all its entries by sending the following command: |
4699 |
|
|
4700 |
|
|
4701 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 75] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
4702 |
|
|
4703 |
6.7.12. Clear MIDI instrument map |
Schoenebeck Expires September 30, 2007 [Page 84] |
4704 |
|
|
4705 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4706 |
|
|
|
The front-end can clear a whole MIDI instrument map, that is delete |
|
|
all its entries by sending the following command: |
|
4707 |
|
|
4708 |
CLEAR MIDI_INSTRUMENTS <map> |
CLEAR MIDI_INSTRUMENTS <map> |
4709 |
|
|
4751 |
|
|
4752 |
|
|
4753 |
|
|
4754 |
Schoenebeck Expires June 18, 2007 [Page 76] |
|
4755 |
|
|
4756 |
|
|
4757 |
|
|
4758 |
|
|
4759 |
|
Schoenebeck Expires September 30, 2007 [Page 85] |
4760 |
|
|
4761 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
4762 |
|
|
4763 |
|
|
4764 |
7. Command Syntax |
7. Command Syntax |
4812 |
|
|
4813 |
|
|
4814 |
|
|
4815 |
Schoenebeck Expires June 18, 2007 [Page 77] |
Schoenebeck Expires September 30, 2007 [Page 86] |
4816 |
|
|
4817 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
4818 |
|
|
4819 |
|
|
4820 |
/ LIST SP list_instruction |
/ LIST SP list_instruction |
4849 |
|
|
4850 |
subscribe_event = |
subscribe_event = |
4851 |
|
|
4852 |
CHANNEL_COUNT |
AUDIO_OUTPUT_DEVICE_COUNT |
4853 |
|
|
4854 |
|
/ AUDIO_OUTPUT_DEVICE_INFO |
4855 |
|
|
4856 |
|
/ MIDI_INPUT_DEVICE_COUNT |
4857 |
|
|
4858 |
|
/ MIDI_INPUT_DEVICE_INFO |
4859 |
|
|
4860 |
|
/ CHANNEL_COUNT |
4861 |
|
|
4862 |
/ VOICE_COUNT |
/ VOICE_COUNT |
4863 |
|
|
4865 |
|
|
4866 |
/ BUFFER_FILL |
/ BUFFER_FILL |
4867 |
|
|
4868 |
|
|
4869 |
|
|
4870 |
|
|
4871 |
|
Schoenebeck Expires September 30, 2007 [Page 87] |
4872 |
|
|
4873 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4874 |
|
|
4875 |
|
|
4876 |
/ CHANNEL_INFO |
/ CHANNEL_INFO |
4877 |
|
|
4878 |
|
/ FX_SEND_COUNT |
4879 |
|
|
4880 |
|
/ FX_SEND_INFO |
4881 |
|
|
4882 |
|
/ MIDI_INSTRUMENT_MAP_COUNT |
4883 |
|
|
4884 |
|
/ MIDI_INSTRUMENT_MAP_INFO |
4885 |
|
|
4886 |
|
/ MIDI_INSTRUMENT_COUNT |
4887 |
|
|
4888 |
|
/ MIDI_INSTRUMENT_INFO |
4889 |
|
|
4890 |
/ MISCELLANEOUS |
/ MISCELLANEOUS |
4891 |
|
|
4892 |
/ TOTAL_VOICE_COUNT |
/ TOTAL_VOICE_COUNT |
4893 |
|
|
4894 |
unsubscribe_event = |
/ GLOBAL_INFO |
4895 |
|
|
4896 |
|
unsubscribe_event = |
4897 |
|
|
4898 |
|
AUDIO_OUTPUT_DEVICE_COUNT |
4899 |
|
|
4900 |
|
/ AUDIO_OUTPUT_DEVICE_INFO |
4901 |
|
|
4902 |
Schoenebeck Expires June 18, 2007 [Page 78] |
/ MIDI_INPUT_DEVICE_COUNT |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
4903 |
|
|
4904 |
|
/ MIDI_INPUT_DEVICE_INFO |
4905 |
|
|
4906 |
CHANNEL_COUNT |
/ CHANNEL_COUNT |
4907 |
|
|
4908 |
/ VOICE_COUNT |
/ VOICE_COUNT |
4909 |
|
|
4913 |
|
|
4914 |
/ CHANNEL_INFO |
/ CHANNEL_INFO |
4915 |
|
|
4916 |
|
/ FX_SEND_COUNT |
4917 |
|
|
4918 |
|
/ FX_SEND_INFO |
4919 |
|
|
4920 |
|
/ MIDI_INSTRUMENT_MAP_COUNT |
4921 |
|
|
4922 |
|
/ MIDI_INSTRUMENT_MAP_INFO |
4923 |
|
|
4924 |
|
|
4925 |
|
|
4926 |
|
|
4927 |
|
Schoenebeck Expires September 30, 2007 [Page 88] |
4928 |
|
|
4929 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4930 |
|
|
4931 |
|
|
4932 |
|
/ MIDI_INSTRUMENT_COUNT |
4933 |
|
|
4934 |
|
/ MIDI_INSTRUMENT_INFO |
4935 |
|
|
4936 |
/ MISCELLANEOUS |
/ MISCELLANEOUS |
4937 |
|
|
4938 |
/ TOTAL_VOICE_COUNT |
/ TOTAL_VOICE_COUNT |
4939 |
|
|
4940 |
|
/ GLOBAL_INFO |
4941 |
|
|
4942 |
map_instruction = |
map_instruction = |
4943 |
|
|
4944 |
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 |
4945 |
engine_name SP filename SP instrument_index SP volume_value |
engine_name SP filename SP instrument_index SP volume_value |
4946 |
|
|
4947 |
/ 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 |
4948 |
engine_name SP filename SP instrument_index SP volume_value SP |
SP engine_name SP filename SP instrument_index SP volume_value SP |
4949 |
instr_load_mode |
instr_load_mode |
4950 |
|
|
4951 |
/ 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 |
4952 |
engine_name SP filename SP instrument_index SP volume_value SP |
SP engine_name SP filename SP instrument_index SP volume_value SP |
4953 |
entry_name |
entry_name |
4954 |
|
|
4955 |
/ 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 |
4956 |
engine_name SP filename SP instrument_index SP volume_value SP |
SP engine_name SP filename SP instrument_index SP volume_value SP |
4957 |
instr_load_mode SP entry_name |
instr_load_mode SP entry_name |
4958 |
|
|
4959 |
unmap_instruction = |
unmap_instruction = |
4972 |
|
|
4973 |
AVAILABLE_ENGINES |
AVAILABLE_ENGINES |
4974 |
|
|
4975 |
|
/ AVAILABLE_MIDI_INPUT_DRIVERS |
4976 |
|
|
4977 |
|
/ MIDI_INPUT_DRIVER SP INFO SP string |
4978 |
|
|
4979 |
|
|
4980 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 79] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
4981 |
|
|
4982 |
|
|
4983 |
/ AVAILABLE_MIDI_INPUT_DRIVERS |
Schoenebeck Expires September 30, 2007 [Page 89] |
4984 |
|
|
4985 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
4986 |
|
|
|
/ MIDI_INPUT_DRIVER SP INFO SP string |
|
4987 |
|
|
4988 |
/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string |
/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string |
4989 |
|
|
5028 |
|
|
5029 |
/ ENGINE SP INFO SP engine_name |
/ ENGINE SP INFO SP engine_name |
5030 |
|
|
5031 |
|
/ SERVER SP INFO |
5032 |
|
|
5033 |
|
/ TOTAL_VOICE_COUNT |
5034 |
|
|
5035 |
|
|
5036 |
|
|
|
Schoenebeck Expires June 18, 2007 [Page 80] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
5037 |
|
|
5038 |
|
|
5039 |
/ SERVER SP INFO |
Schoenebeck Expires September 30, 2007 [Page 90] |
5040 |
|
|
5041 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5042 |
|
|
|
/ TOTAL_VOICE_COUNT |
|
5043 |
|
|
5044 |
/ TOTAL_VOICE_COUNT_MAX |
/ TOTAL_VOICE_COUNT_MAX |
5045 |
|
|
5053 |
|
|
5054 |
/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
5055 |
|
|
5056 |
|
/ FX_SENDS SP sampler_channel |
5057 |
|
|
5058 |
|
/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
5059 |
|
|
5060 |
|
/ VOLUME |
5061 |
|
|
5062 |
set_instruction = |
set_instruction = |
5063 |
|
|
5064 |
AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' |
AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' |
5077 |
|
|
5078 |
/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
5079 |
|
|
5080 |
|
/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name |
5081 |
|
|
5082 |
|
/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id |
5083 |
|
SP audio_channel_index SP audio_channel_index |
5084 |
|
|
5085 |
|
/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP |
5086 |
|
midi_ctrl |
5087 |
|
|
5088 |
|
/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP |
5089 |
|
volume_value |
5090 |
|
|
5091 |
|
|
5092 |
|
|
5093 |
|
|
5094 |
|
|
5095 |
|
Schoenebeck Expires September 30, 2007 [Page 91] |
5096 |
|
|
5097 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5098 |
|
|
5099 |
|
|
5100 |
/ ECHO SP boolean |
/ ECHO SP boolean |
5101 |
|
|
5102 |
|
/ VOLUME SP volume_value |
5103 |
|
|
5104 |
create_instruction = |
create_instruction = |
5105 |
|
|
5106 |
AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
5111 |
|
|
5112 |
/ MIDI_INPUT_DEVICE SP string |
/ MIDI_INPUT_DEVICE SP string |
5113 |
|
|
5114 |
reset_instruction = |
/ FX_SEND SP sampler_channel SP midi_ctrl |
|
|
|
|
|
|
5115 |
|
|
5116 |
|
/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
5117 |
|
|
5118 |
Schoenebeck Expires June 18, 2007 [Page 81] |
reset_instruction = |
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
5119 |
|
|
5120 |
CHANNEL SP sampler_channel |
CHANNEL SP sampler_channel |
5121 |
|
|
5131 |
|
|
5132 |
/ MIDI_INPUT_DEVICE SP number |
/ MIDI_INPUT_DEVICE SP number |
5133 |
|
|
5134 |
|
/ FX_SEND SP sampler_channel SP fx_send_id |
5135 |
|
|
5136 |
load_instruction = |
load_instruction = |
5137 |
|
|
5138 |
INSTRUMENT SP load_instr_args |
INSTRUMENT SP load_instr_args |
5146 |
/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index |
/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index |
5147 |
SP audio_channel_index |
SP audio_channel_index |
5148 |
|
|
5149 |
|
|
5150 |
|
|
5151 |
|
Schoenebeck Expires September 30, 2007 [Page 92] |
5152 |
|
|
5153 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5154 |
|
|
5155 |
|
|
5156 |
/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name |
/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name |
5157 |
|
|
5158 |
/ MIDI_INPUT SP sampler_channel SP device_index SP |
/ MIDI_INPUT SP sampler_channel SP device_index SP |
5173 |
|
|
5174 |
/ SOLO SP sampler_channel SP boolean |
/ SOLO SP sampler_channel SP boolean |
5175 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 82] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
5176 |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
5177 |
|
|
5178 |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
5179 |
|
|
5180 |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
5181 |
|
|
5182 |
|
modal_arg = |
5183 |
|
|
5184 |
|
/* epsilon (empty argument) */ |
5185 |
|
|
5186 |
|
/ NON_MODAL SP |
5187 |
|
|
5188 |
key_val_list = |
key_val_list = |
5189 |
|
|
5190 |
string '=' param_val_list |
string '=' param_val_list |
5201 |
|
|
5202 |
AUDIO_OUTPUT_DEVICES |
AUDIO_OUTPUT_DEVICES |
5203 |
|
|
5204 |
|
|
5205 |
|
|
5206 |
|
|
5207 |
|
Schoenebeck Expires September 30, 2007 [Page 93] |
5208 |
|
|
5209 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5210 |
|
|
5211 |
|
|
5212 |
/ MIDI_INPUT_DEVICES |
/ MIDI_INPUT_DEVICES |
5213 |
|
|
5214 |
/ CHANNELS |
/ CHANNELS |
5225 |
|
|
5226 |
/ MIDI_INSTRUMENT_MAPS |
/ MIDI_INSTRUMENT_MAPS |
5227 |
|
|
5228 |
|
/ FX_SENDS SP sampler_channel |
5229 |
|
|
5230 |
load_instr_args = |
load_instr_args = |
5231 |
|
|
5232 |
filename SP instrument_index SP sampler_channel |
filename SP instrument_index SP sampler_channel |
5237 |
|
|
5238 |
engine_name SP sampler_channel |
engine_name SP sampler_channel |
5239 |
|
|
|
|
|
|
|
|
|
|
|
|
Schoenebeck Expires June 18, 2007 [Page 83] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
|
|
|
5240 |
instr_load_mode = |
instr_load_mode = |
5241 |
|
|
5242 |
ON_DEMAND |
ON_DEMAND |
5257 |
|
|
5258 |
string |
string |
5259 |
|
|
5260 |
|
|
5261 |
|
|
5262 |
|
|
5263 |
|
Schoenebeck Expires September 30, 2007 [Page 94] |
5264 |
|
|
5265 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5266 |
|
|
5267 |
|
|
5268 |
midi_input_port_index = |
midi_input_port_index = |
5269 |
|
|
5270 |
number |
number |
5291 |
|
|
5292 |
number |
number |
5293 |
|
|
5294 |
volume_value = |
midi_ctrl = |
|
|
|
5295 |
|
|
5296 |
|
number |
5297 |
|
|
5298 |
|
volume_value = |
|
Schoenebeck Expires June 18, 2007 [Page 84] |
|
|
|
|
|
Internet-Draft LinuxSampler Control Protocol December 2006 |
|
|
|
|
5299 |
|
|
5300 |
dotnum |
dotnum |
5301 |
|
|
5309 |
|
|
5310 |
number |
number |
5311 |
|
|
5312 |
|
fx_send_id = |
5313 |
|
|
5314 |
|
number |
5315 |
|
|
5316 |
|
|
5317 |
|
|
5318 |
|
|
5319 |
|
Schoenebeck Expires September 30, 2007 [Page 95] |
5320 |
|
|
5321 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5322 |
|
|
5323 |
|
|
5324 |
engine_name = |
engine_name = |
5325 |
|
|
5326 |
string |
string |
5337 |
|
|
5338 |
stringval |
stringval |
5339 |
|
|
5340 |
|
fx_send_name = |
5341 |
|
|
5342 |
|
stringval |
5343 |
|
|
5344 |
param_val_list = |
param_val_list = |
5345 |
|
|
5346 |
param_val |
param_val |
5364 |
|
|
5365 |
|
|
5366 |
|
|
5367 |
Schoenebeck Expires June 18, 2007 [Page 85] |
|
5368 |
|
|
5369 |
|
|
5370 |
|
|
5371 |
|
|
5372 |
|
|
5373 |
|
|
5374 |
|
|
5375 |
|
Schoenebeck Expires September 30, 2007 [Page 96] |
5376 |
|
|
5377 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
5378 |
|
|
5379 |
|
|
5380 |
8. Events |
8. Events |
5382 |
This chapter will describe all currently defined events supported by |
This chapter will describe all currently defined events supported by |
5383 |
LinuxSampler. |
LinuxSampler. |
5384 |
|
|
5385 |
8.1. Number of sampler channels changed |
8.1. Number of audio output devices changed |
5386 |
|
|
5387 |
|
Client may want to be notified when the total number of audio output |
5388 |
|
devices on the back-end changes by issuing the following command: |
5389 |
|
|
5390 |
|
SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT |
5391 |
|
|
5392 |
|
Server will start sending the following notification messages: |
5393 |
|
|
5394 |
|
"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>" |
5395 |
|
|
5396 |
|
where <devices> will be replaced by the new number of audio output |
5397 |
|
devices. |
5398 |
|
|
5399 |
|
8.2. Audio output device's settings changed |
5400 |
|
|
5401 |
|
Client may want to be notified when changes were made to audio output |
5402 |
|
devices on the back-end by issuing the following command: |
5403 |
|
|
5404 |
|
SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO |
5405 |
|
|
5406 |
|
Server will start sending the following notification messages: |
5407 |
|
|
5408 |
|
"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>" |
5409 |
|
|
5410 |
|
where <device-id> will be replaced by the numerical ID of the audio |
5411 |
|
output device, which settings has been changed. The front-end will |
5412 |
|
have to send the respective command to actually get the audio output |
5413 |
|
device info. Because these messages will be triggered by LSCP |
5414 |
|
commands issued by other clients rather than real time events |
5415 |
|
happening on the server, it is believed that an empty notification |
5416 |
|
message is sufficient here. |
5417 |
|
|
5418 |
|
8.3. Number of MIDI input devices changed |
5419 |
|
|
5420 |
|
Client may want to be notified when the total number of MIDI input |
5421 |
|
devices on the back-end changes by issuing the following command: |
5422 |
|
|
5423 |
|
SUBSCRIBE MIDI_INPUT_DEVICE_COUNT |
5424 |
|
|
5425 |
|
Server will start sending the following notification messages: |
5426 |
|
|
5427 |
|
|
5428 |
|
|
5429 |
|
|
5430 |
|
|
5431 |
|
Schoenebeck Expires September 30, 2007 [Page 97] |
5432 |
|
|
5433 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5434 |
|
|
5435 |
|
|
5436 |
|
"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>" |
5437 |
|
|
5438 |
|
where <devices> will be replaced by the new number of MIDI input |
5439 |
|
devices. |
5440 |
|
|
5441 |
|
8.4. MIDI input device's settings changed |
5442 |
|
|
5443 |
|
Client may want to be notified when changes were made to MIDI input |
5444 |
|
devices on the back-end by issuing the following command: |
5445 |
|
|
5446 |
|
SUBSCRIBE MIDI_INPUT_DEVICE_INFO |
5447 |
|
|
5448 |
|
Server will start sending the following notification messages: |
5449 |
|
|
5450 |
|
"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>" |
5451 |
|
|
5452 |
|
where <device-id> will be replaced by the numerical ID of the MIDI |
5453 |
|
input device, which settings has been changed. The front-end will |
5454 |
|
have to send the respective command to actually get the MIDI input |
5455 |
|
device info. Because these messages will be triggered by LSCP |
5456 |
|
commands issued by other clients rather than real time events |
5457 |
|
happening on the server, it is believed that an empty notification |
5458 |
|
message is sufficient here. |
5459 |
|
|
5460 |
|
8.5. Number of sampler channels changed |
5461 |
|
|
5462 |
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 |
5463 |
the back-end changes by issuing the following command: |
the back-end changes by issuing the following command: |
5471 |
where <channels> will be replaced by the new number of sampler |
where <channels> will be replaced by the new number of sampler |
5472 |
channels. |
channels. |
5473 |
|
|
5474 |
8.2. Number of active voices changed |
8.6. Number of active voices changed |
5475 |
|
|
5476 |
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- |
5477 |
end changes by issuing the following command: |
end changes by issuing the following command: |
5480 |
|
|
5481 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
5482 |
|
|
5483 |
"NOTIFY:VOICE_COUNT:<sampler-channel> <voices> |
|
5484 |
|
|
5485 |
|
|
5486 |
|
|
5487 |
|
Schoenebeck Expires September 30, 2007 [Page 98] |
5488 |
|
|
5489 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5490 |
|
|
5491 |
|
|
5492 |
|
"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>" |
5493 |
|
|
5494 |
where <sampler-channel> will be replaced by the sampler channel the |
where <sampler-channel> will be replaced by the sampler channel the |
5495 |
voice count change occurred and <voices> by the new number of active |
voice count change occurred and <voices> by the new number of active |
5496 |
voices on that channel. |
voices on that channel. |
5497 |
|
|
5498 |
8.3. Number of active disk streams changed |
8.7. Number of active disk streams changed |
5499 |
|
|
5500 |
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 |
5501 |
back-end changes by issuing the following command: SUBSCRIBE |
back-end changes by issuing the following command: SUBSCRIBE |
5509 |
|
|
5510 |
where <sampler-channel> will be replaced by the sampler channel the |
where <sampler-channel> will be replaced by the sampler channel the |
5511 |
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 |
|
|
|
|
|
|
|
5512 |
active disk streams on that channel. |
active disk streams on that channel. |
5513 |
|
|
5514 |
8.4. Disk stream buffer fill state changed |
8.8. Disk stream buffer fill state changed |
5515 |
|
|
5516 |
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 |
5517 |
stream on the back-end changes by issuing the following command: |
stream on the back-end changes by issuing the following command: |
5528 |
Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" |
Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" |
5529 |
(Section 6.4.13) command was issued on this channel. |
(Section 6.4.13) command was issued on this channel. |
5530 |
|
|
5531 |
8.5. Channel information changed |
8.9. Channel information changed |
5532 |
|
|
5533 |
Client may want to be notified when changes were made to sampler |
Client may want to be notified when changes were made to sampler |
5534 |
channels on the back-end by issuing the following command: |
channels on the back-end by issuing the following command: |
5537 |
|
|
5538 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
5539 |
|
|
5540 |
|
|
5541 |
|
|
5542 |
|
|
5543 |
|
Schoenebeck Expires September 30, 2007 [Page 99] |
5544 |
|
|
5545 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5546 |
|
|
5547 |
|
|
5548 |
"NOTIFY:CHANNEL_INFO:<sampler-channel>" |
"NOTIFY:CHANNEL_INFO:<sampler-channel>" |
5549 |
|
|
5550 |
where <sampler-channel> will be replaced by the sampler channel the |
where <sampler-channel> will be replaced by the sampler channel the |
5554 |
rather than real time events happening on the server, it is believed |
rather than real time events happening on the server, it is believed |
5555 |
that an empty notification message is sufficient here. |
that an empty notification message is sufficient here. |
5556 |
|
|
5557 |
8.6. Total number of active voices changed |
8.10. Number of effect sends changed |
5558 |
|
|
5559 |
|
Client may want to be notified when the number of effect sends on a |
5560 |
|
particular sampler channel is changed by issuing the following |
5561 |
|
command: |
5562 |
|
|
5563 |
|
SUBSCRIBE FX_SEND_COUNT |
5564 |
|
|
5565 |
|
Server will start sending the following notification messages: |
5566 |
|
|
5567 |
|
"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>" |
5568 |
|
|
5569 |
|
where <channel-id> will be replaced by the numerical ID of the |
5570 |
|
sampler channel, on which the effect sends number is changed and <fx- |
5571 |
|
sends> will be replaced by the new number of effect sends on that |
5572 |
|
channel. |
5573 |
|
|
5574 |
|
8.11. Effect send information changed |
5575 |
|
|
5576 |
|
Client may want to be notified when changes were made to effect sends |
5577 |
|
on a a particular sampler channel by issuing the following command: |
5578 |
|
|
5579 |
|
SUBSCRIBE FX_SEND_INFO |
5580 |
|
|
5581 |
|
Server will start sending the following notification messages: |
5582 |
|
|
5583 |
|
"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>" |
5584 |
|
|
5585 |
|
where <channel-id> will be replaced by the numerical ID of the |
5586 |
|
sampler channel, on which an effect send entity is changed and <fx- |
5587 |
|
send-id> will be replaced by the numerical ID of the changed effect |
5588 |
|
send. |
5589 |
|
|
5590 |
|
8.12. Total number of active voices changed |
5591 |
|
|
5592 |
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 |
5593 |
back-end changes by issuing the following command: |
back-end changes by issuing the following command: |
5594 |
|
|
5595 |
|
|
5596 |
|
|
5597 |
|
|
5598 |
|
|
5599 |
|
Schoenebeck Expires September 30, 2007 [Page 100] |
5600 |
|
|
5601 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5602 |
|
|
5603 |
|
|
5604 |
SUBSCRIBE TOTAL_VOICE_COUNT |
SUBSCRIBE TOTAL_VOICE_COUNT |
5605 |
|
|
5606 |
Server will start sending the following notification messages: |
Server will start sending the following notification messages: |
5607 |
|
|
5608 |
|
"NOTIFY:TOTAL_VOICE_COUNT:<voices>" |
5609 |
|
|
5610 |
|
where <voices> will be replaced by the new number of all currently |
5611 |
|
active voices. |
5612 |
|
|
5613 |
|
8.13. Number of MIDI instrument maps changed |
5614 |
|
|
5615 |
|
Client may want to be notified when the number of MIDI instrument |
5616 |
|
maps on the back-end changes by issuing the following command: |
5617 |
|
|
5618 |
|
SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT |
5619 |
|
|
5620 |
Schoenebeck Expires June 18, 2007 [Page 87] |
Server will start sending the following notification messages: |
5621 |
|
|
5622 |
|
"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>" |
5623 |
|
|
5624 |
|
where <maps> will be replaced by the new number of MIDI instrument |
5625 |
|
maps. |
5626 |
|
|
5627 |
|
8.14. MIDI instrument map information changed |
5628 |
|
|
5629 |
|
Client may want to be notified when changes were made to MIDI |
5630 |
|
instrument maps on the back-end by issuing the following command: |
5631 |
|
|
5632 |
|
SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO |
5633 |
|
|
5634 |
|
Server will start sending the following notification messages: |
5635 |
|
|
5636 |
|
"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>" |
5637 |
|
|
5638 |
|
where <map-id> will be replaced by the numerical ID of the MIDI |
5639 |
|
instrument map, for which information changes occurred. The front- |
5640 |
|
end will have to send the respective command to actually get the MIDI |
5641 |
|
instrument map info. Because these messages will be triggered by |
5642 |
|
LSCP commands issued by other clients rather than real time events |
5643 |
|
happening on the server, it is believed that an empty notification |
5644 |
|
message is sufficient here. |
5645 |
|
|
5646 |
|
8.15. Number of MIDI instruments changed |
5647 |
|
|
5648 |
|
Client may want to be notified when the number of MIDI instrument |
5649 |
|
maps on the back-end changes by issuing the following command: |
5650 |
|
|
5651 |
|
|
5652 |
|
|
5653 |
|
|
5654 |
|
|
5655 |
|
Schoenebeck Expires September 30, 2007 [Page 101] |
5656 |
|
|
5657 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
5658 |
|
|
5659 |
|
|
5660 |
"NOTIFY:TOTAL_VOICE_COUNT:<voices> |
SUBSCRIBE MIDI_INSTRUMENT_COUNT |
5661 |
|
|
5662 |
where <voices> will be replaced by the new number of all currently |
Server will start sending the following notification messages: |
5663 |
active voices. |
|
5664 |
|
"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>" |
5665 |
|
|
5666 |
|
where <map-id> is the numerical ID of the MIDI instrument map, in |
5667 |
|
which the nuber of instruments has changed and <instruments> will be |
5668 |
|
replaced by the new number of MIDI instruments in the specified map. |
5669 |
|
|
5670 |
8.7. Miscellaneous and debugging events |
8.16. MIDI instrument information changed |
5671 |
|
|
5672 |
|
Client may want to be notified when changes were made to MIDI |
5673 |
|
instruments on the back-end by issuing the following command: |
5674 |
|
|
5675 |
|
SUBSCRIBE MIDI_INSTRUMENT_INFO |
5676 |
|
|
5677 |
|
Server will start sending the following notification messages: |
5678 |
|
|
5679 |
|
"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>" |
5680 |
|
|
5681 |
|
where <map-id> will be replaced by the numerical ID of the MIDI |
5682 |
|
instrument map, in which a MIDI instrument is changed. <bank> and |
5683 |
|
<program> specifies the location of the changed MIDI instrument in |
5684 |
|
the map. The front-end will have to send the respective command to |
5685 |
|
actually get the MIDI instrument info. Because these messages will |
5686 |
|
be triggered by LSCP commands issued by other clients rather than |
5687 |
|
real time events happening on the server, it is believed that an |
5688 |
|
empty notification message is sufficient here. |
5689 |
|
|
5690 |
|
8.17. Global settings changed |
5691 |
|
|
5692 |
|
Client may want to be notified when changes to the global settings of |
5693 |
|
the sampler were made by issuing the following command: |
5694 |
|
|
5695 |
|
SUBSCRIBE GLOBAL_INFO |
5696 |
|
|
5697 |
|
Server will start sending the following types of notification |
5698 |
|
messages: |
5699 |
|
|
5700 |
|
"NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal |
5701 |
|
volume of the sampler is changed, where <volume> will be replaced |
5702 |
|
by the optional dotted floating point value, reflecting the new |
5703 |
|
global volume parameter. |
5704 |
|
|
5705 |
|
|
5706 |
|
|
5707 |
|
|
5708 |
|
|
5709 |
|
|
5710 |
|
|
5711 |
|
Schoenebeck Expires September 30, 2007 [Page 102] |
5712 |
|
|
5713 |
|
Internet-Draft LinuxSampler Control Protocol March 2007 |
5714 |
|
|
5715 |
|
|
5716 |
|
8.18. Miscellaneous and debugging events |
5717 |
|
|
5718 |
Client may want to be notified of miscellaneous and debugging events |
Client may want to be notified of miscellaneous and debugging events |
5719 |
occurring at the server by issuing the following command: |
occurring at the server by issuing the following command: |
5759 |
|
|
5760 |
|
|
5761 |
|
|
5762 |
Schoenebeck Expires June 18, 2007 [Page 88] |
|
5763 |
|
|
5764 |
|
|
5765 |
|
|
5766 |
|
|
5767 |
|
Schoenebeck Expires September 30, 2007 [Page 103] |
5768 |
|
|
5769 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
5770 |
|
|
5771 |
|
|
5772 |
9. Security Considerations |
9. Security Considerations |
5820 |
|
|
5821 |
|
|
5822 |
|
|
5823 |
Schoenebeck Expires June 18, 2007 [Page 89] |
Schoenebeck Expires September 30, 2007 [Page 104] |
5824 |
|
|
5825 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
5826 |
|
|
5827 |
|
|
5828 |
10. Acknowledgments |
10. Acknowledgments |
5876 |
|
|
5877 |
|
|
5878 |
|
|
5879 |
Schoenebeck Expires June 18, 2007 [Page 90] |
Schoenebeck Expires September 30, 2007 [Page 105] |
5880 |
|
|
5881 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
5882 |
|
|
5883 |
|
|
5884 |
11. References |
11. References |
5932 |
|
|
5933 |
|
|
5934 |
|
|
5935 |
Schoenebeck Expires June 18, 2007 [Page 91] |
Schoenebeck Expires September 30, 2007 [Page 106] |
5936 |
|
|
5937 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
5938 |
|
|
5939 |
|
|
5940 |
Author's Address |
Author's Address |
5988 |
|
|
5989 |
|
|
5990 |
|
|
5991 |
Schoenebeck Expires June 18, 2007 [Page 92] |
Schoenebeck Expires September 30, 2007 [Page 107] |
5992 |
|
|
5993 |
Internet-Draft LinuxSampler Control Protocol December 2006 |
Internet-Draft LinuxSampler Control Protocol March 2007 |
5994 |
|
|
5995 |
|
|
5996 |
Full Copyright Statement |
Full Copyright Statement |
5997 |
|
|
5998 |
Copyright (C) The Internet Society (2006). |
Copyright (C) The IETF Trust (2007). |
5999 |
|
|
6000 |
This document is subject to the rights, licenses and restrictions |
This document is subject to the rights, licenses and restrictions |
6001 |
contained in BCP 78, and except as set forth therein, the authors |
contained in BCP 78, and except as set forth therein, the authors |
6003 |
|
|
6004 |
This document and the information contained herein are provided on an |
This document and the information contained herein are provided on an |
6005 |
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS |
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS |
6006 |
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 |
6007 |
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, |
THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS |
6008 |
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 |
6009 |
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED |
THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED |
6010 |
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
6011 |
|
|
6012 |
|
|
6044 |
|
|
6045 |
|
|
6046 |
|
|
6047 |
Schoenebeck Expires June 18, 2007 [Page 93] |
Schoenebeck Expires September 30, 2007 [Page 108] |
6048 |
|
|