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

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

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

revision 1696 by schoenebeck, Sat Feb 16 01:16:39 2008 UTC revision 1773 by iliev, Wed Sep 10 15:14:31 2008 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: August 19, 2008                               February 16, 2008  Expires: March 14, 2009                               September 10, 2008
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
# Line 33  Status of this Memo Line 33  Status of this Memo
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 August 19, 2008.     This Internet-Draft will expire on March 14, 2009.
37    
38  Copyright Notice  Copyright Notice
39    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck              Expires August 19, 2008                [Page 1]  Schoenebeck              Expires March 14, 2009                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck              Expires August 19, 2008                [Page 2]  Schoenebeck              Expires March 14, 2009                 [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.  Getting all created MIDI input device list  . . . . .  37
# Line 155  Internet-Draft        LinuxSampler Contr Line 155  Internet-Draft        LinuxSampler Contr
155         6.4.31. Altering effect send's audio routing  . . . . . . . .  67         6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157         6.4.33. Altering effect send's send level . . . . . . . . . .  69         6.4.33. Altering effect send's send level . . . . . . . . . .  69
158         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70         6.4.34. Sending MIDI messages to sampler channel  . . . . . .  70
159       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  71         6.4.35. Resetting a sampler channel . . . . . . . . . . . . .  71
160         6.5.1.  Register front-end for receiving event messages . . .  71       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  72
161           6.5.1.  Register front-end for receiving event messages . . .  72
162         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
163                 messages  . . . . . . . . . . . . . . . . . . . . . .  71                 messages  . . . . . . . . . . . . . . . . . . . . . .  72
        6.5.3.  Enable or disable echo of commands  . . . . . . . . .  72  
164    
165    
166    
167  Schoenebeck              Expires August 19, 2008                [Page 3]  Schoenebeck              Expires March 14, 2009                 [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
170    
171    
172         6.5.4.  Close client connection . . . . . . . . . . . . . . .  73         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  73
173       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  73         6.5.4.  Close client connection . . . . . . . . . . . . . . .  74
174         6.6.1.  Current number of active voices . . . . . . . . . . .  73       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  74
175         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73         6.6.1.  Current number of active voices . . . . . . . . . . .  74
176           6.6.2.  Maximum amount of active voices . . . . . . . . . . .  74
177         6.6.3.  Current number of active disk streams . . . . . . . .  74         6.6.3.  Current number of active disk streams . . . . . . . .  74
178         6.6.4.  Reset sampler . . . . . . . . . . . . . . . . . . . .  74         6.6.4.  Reset sampler . . . . . . . . . . . . . . . . . . . .  75
179         6.6.5.  General sampler informations  . . . . . . . . . . . .  74         6.6.5.  General sampler informations  . . . . . . . . . . . .  75
180         6.6.6.  Getting global volume attenuation . . . . . . . . . .  75         6.6.6.  Getting global volume attenuation . . . . . . . . . .  76
181         6.6.7.  Setting global volume attenuation . . . . . . . . . .  75         6.6.7.  Setting global volume attenuation . . . . . . . . . .  76
182       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  76       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  77
183         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  77         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  77
184         6.7.2.  Delete one particular or all MIDI instrument maps . .  77         6.7.2.  Delete one particular or all MIDI instrument maps . .  78
185         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  78         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  79
186         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  79
187         6.7.5.  Getting MIDI instrument map information . . . . . . .  79         6.7.5.  Getting MIDI instrument map information . . . . . . .  80
188         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  80         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  81
189         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80         6.7.7.  Create or replace a MIDI instrument map entry . . . .  81
190         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  83         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  84
191         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
192                 instrument map  . . . . . . . . . . . . . . . . . . .  84                 instrument map  . . . . . . . . . . . . . . . . . . .  85
193         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84         6.7.10. Remove an entry from the MIDI instrument map  . . . .  85
194         6.7.11. Get current settings of MIDI instrument map entry . .  85         6.7.11. Get current settings of MIDI instrument map entry . .  86
195         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  87         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  88
196       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  88       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  89
197         6.8.1.  Creating a new instrument directory . . . . . . . . .  88         6.8.1.  Creating a new instrument directory . . . . . . . . .  89
198         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  89
199         6.8.3.  Getting amount of instrument directories  . . . . . .  89         6.8.3.  Getting amount of instrument directories  . . . . . .  90
200         6.8.4.  Listing all directories in specific directory . . . .  90         6.8.4.  Listing all directories in specific directory . . . .  91
201         6.8.5.  Getting instrument directory information  . . . . . .  90         6.8.5.  Getting instrument directory information  . . . . . .  91
202         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  92
203         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  92         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  93
204         6.8.8.  Copying instrument directories  . . . . . . . . . . .  93         6.8.8.  Copying instrument directories  . . . . . . . . . . .  94
205         6.8.9.  Changing the description of directory . . . . . . . .  93         6.8.9.  Changing the description of directory . . . . . . . .  94
206         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  94         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  95
207         6.8.11. Adding instruments to the instruments database  . . .  95         6.8.11. Adding instruments to the instruments database  . . .  96
208         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  97         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  98
209         6.8.13. Getting amount of instruments . . . . . . . . . . . .  97         6.8.13. Getting amount of instruments . . . . . . . . . . . .  98
210         6.8.14. Listing all instruments in specific directory . . . .  98         6.8.14. Listing all instruments in specific directory . . . .  99
211         6.8.15. Getting instrument information  . . . . . . . . . . .  99         6.8.15. Getting instrument information  . . . . . . . . . . . 100
212         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 101         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 102
213         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 102         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 103
214         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 103
215         6.8.19. Changing the description of instrument  . . . . . . . 103         6.8.19. Changing the description of instrument  . . . . . . . 104
216         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 104
217         6.8.21. Getting job status information  . . . . . . . . . . . 106         6.8.21. Getting job status information  . . . . . . . . . . . 107
218         6.8.22. Formatting the instruments database . . . . . . . . . 107         6.8.22. Formatting the instruments database . . . . . . . . . 108
219       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107         6.8.23. Checking for lost instrument files  . . . . . . . . . 108
        6.9.1.  Opening an appropriate instrument editor  
220    
221    
222    
223  Schoenebeck              Expires August 19, 2008                [Page 4]  Schoenebeck              Expires March 14, 2009                 [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
226    
227    
228                 application . . . . . . . . . . . . . . . . . . . . . 107         6.8.24. Replacing an instrument file  . . . . . . . . . . . . 109
229       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 108       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 109
230         6.10.1. Retrieving amount of instruments of a file  . . . . . 109         6.9.1.  Opening an appropriate instrument editor
231         6.10.2. Retrieving all instruments of a file  . . . . . . . . 109                 application . . . . . . . . . . . . . . . . . . . . . 110
232         6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 111
233           6.10.1. Retrieving amount of instruments of a file  . . . . . 111
234           6.10.2. Retrieving all instruments of a file  . . . . . . . . 111
235         6.10.3. Retrieving informations about one instrument in a         6.10.3. Retrieving informations about one instrument in a
236                 file  . . . . . . . . . . . . . . . . . . . . . . . . 110                 file  . . . . . . . . . . . . . . . . . . . . . . . . 112
237     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 112     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 115
238       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 126       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 129
239     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 130     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
240       8.1.  Number of audio output devices changed  . . . . . . . . . 130       8.1.  Number of audio output devices changed  . . . . . . . . . 133
241       8.2.  Audio output device's settings changed  . . . . . . . . . 130       8.2.  Audio output device's settings changed  . . . . . . . . . 133
242       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 130       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 133
243       8.4.  MIDI input device's settings changed  . . . . . . . . . . 131       8.4.  MIDI input device's settings changed  . . . . . . . . . . 134
244       8.5.  Number of sampler channels changed  . . . . . . . . . . . 131       8.5.  Number of sampler channels changed  . . . . . . . . . . . 134
245       8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 131       8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 134
246       8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 132       8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 135
247       8.8.  Number of active voices changed . . . . . . . . . . . . . 132       8.8.  Number of active voices changed . . . . . . . . . . . . . 135
248       8.9.  Number of active disk streams changed . . . . . . . . . . 133       8.9.  Number of active disk streams changed . . . . . . . . . . 136
249       8.10. Disk stream buffer fill state changed . . . . . . . . . . 133       8.10. Disk stream buffer fill state changed . . . . . . . . . . 136
250       8.11. Channel information changed . . . . . . . . . . . . . . . 133       8.11. Channel information changed . . . . . . . . . . . . . . . 136
251       8.12. Number of effect sends changed  . . . . . . . . . . . . . 134       8.12. Number of effect sends changed  . . . . . . . . . . . . . 137
252       8.13. Effect send information changed . . . . . . . . . . . . . 134       8.13. Effect send information changed . . . . . . . . . . . . . 137
253       8.14. Total number of active voices changed . . . . . . . . . . 135       8.14. Total number of active voices changed . . . . . . . . . . 138
254       8.15. Total number of active disk streams changed . . . . . . . 135       8.15. Total number of active disk streams changed . . . . . . . 138
255       8.16. Number of MIDI instrument maps changed  . . . . . . . . . 135       8.16. Number of MIDI instrument maps changed  . . . . . . . . . 138
256       8.17. MIDI instrument map information changed . . . . . . . . . 135       8.17. MIDI instrument map information changed . . . . . . . . . 138
257       8.18. Number of MIDI instruments changed  . . . . . . . . . . . 136       8.18. Number of MIDI instruments changed  . . . . . . . . . . . 139
258       8.19. MIDI instrument information changed . . . . . . . . . . . 136       8.19. MIDI instrument information changed . . . . . . . . . . . 139
259       8.20. Global settings changed . . . . . . . . . . . . . . . . . 137       8.20. Global settings changed . . . . . . . . . . . . . . . . . 140
260       8.21. Number of database instrument directories changed . . . . 137       8.21. Number of database instrument directories changed . . . . 140
261       8.22. Database instrument directory information changed . . . . 137       8.22. Database instrument directory information changed . . . . 140
262       8.23. Number of database instruments changed  . . . . . . . . . 138       8.23. Number of database instruments changed  . . . . . . . . . 141
263       8.24. Database instrument information changed . . . . . . . . . 138       8.24. Database instrument information changed . . . . . . . . . 141
264       8.25. Database job status information changed . . . . . . . . . 139       8.25. Database job status information changed . . . . . . . . . 142
265       8.26. Miscellaneous and debugging events  . . . . . . . . . . . 139       8.26. Miscellaneous and debugging events  . . . . . . . . . . . 142
266     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 140     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 143
267     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 141     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 144
268     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 142     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 145
269     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 143     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 146
270     Intellectual Property and Copyright Statements  . . . . . . . . . 144     Intellectual Property and Copyright Statements  . . . . . . . . . 147
   
   
271    
272    
273    
# Line 275  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279    Schoenebeck              Expires March 14, 2009                 [Page 5]
 Schoenebeck              Expires August 19, 2008                [Page 5]  
280    
281  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck              Expires August 19, 2008                [Page 6]  Schoenebeck              Expires March 14, 2009                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck              Expires August 19, 2008                [Page 7]  Schoenebeck              Expires March 14, 2009                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck              Expires August 19, 2008                [Page 8]  Schoenebeck              Expires March 14, 2009                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck              Expires August 19, 2008                [Page 9]  Schoenebeck              Expires March 14, 2009                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck              Expires August 19, 2008               [Page 10]  Schoenebeck              Expires March 14, 2009                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck              Expires August 19, 2008               [Page 11]  Schoenebeck              Expires March 14, 2009                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck              Expires August 19, 2008               [Page 12]  Schoenebeck              Expires March 14, 2009                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck              Expires August 19, 2008               [Page 13]  Schoenebeck              Expires March 14, 2009                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck              Expires August 19, 2008               [Page 14]  Schoenebeck              Expires March 14, 2009                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck              Expires August 19, 2008               [Page 15]  Schoenebeck              Expires March 14, 2009                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck              Expires August 19, 2008               [Page 16]  Schoenebeck              Expires March 14, 2009                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck              Expires August 19, 2008               [Page 17]  Schoenebeck              Expires March 14, 2009                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck              Expires August 19, 2008               [Page 18]  Schoenebeck              Expires March 14, 2009                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck              Expires August 19, 2008               [Page 19]  Schoenebeck              Expires March 14, 2009                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck              Expires August 19, 2008               [Page 20]  Schoenebeck              Expires March 14, 2009                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck              Expires August 19, 2008               [Page 21]  Schoenebeck              Expires March 14, 2009                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck              Expires August 19, 2008               [Page 22]  Schoenebeck              Expires March 14, 2009                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck              Expires August 19, 2008               [Page 23]  Schoenebeck              Expires March 14, 2009                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck              Expires August 19, 2008               [Page 24]  Schoenebeck              Expires March 14, 2009                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck              Expires August 19, 2008               [Page 25]  Schoenebeck              Expires March 14, 2009                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck              Expires August 19, 2008               [Page 26]  Schoenebeck              Expires March 14, 2009                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck              Expires August 19, 2008               [Page 27]  Schoenebeck              Expires March 14, 2009                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck              Expires August 19, 2008               [Page 28]  Schoenebeck              Expires March 14, 2009                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck              Expires August 19, 2008               [Page 29]  Schoenebeck              Expires March 14, 2009                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck              Expires August 19, 2008               [Page 30]  Schoenebeck              Expires March 14, 2009                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck              Expires August 19, 2008               [Page 31]  Schoenebeck              Expires March 14, 2009                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck              Expires August 19, 2008               [Page 32]  Schoenebeck              Expires March 14, 2009                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck              Expires August 19, 2008               [Page 33]  Schoenebeck              Expires March 14, 2009                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck              Expires August 19, 2008               [Page 34]  Schoenebeck              Expires March 14, 2009                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck              Expires August 19, 2008               [Page 35]  Schoenebeck              Expires March 14, 2009                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck              Expires August 19, 2008               [Page 36]  Schoenebeck              Expires March 14, 2009                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck              Expires August 19, 2008               [Page 37]  Schoenebeck              Expires March 14, 2009                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck              Expires August 19, 2008               [Page 38]  Schoenebeck              Expires March 14, 2009                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck              Expires August 19, 2008               [Page 39]  Schoenebeck              Expires March 14, 2009                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck              Expires August 19, 2008               [Page 40]  Schoenebeck              Expires March 14, 2009                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck              Expires August 19, 2008               [Page 41]  Schoenebeck              Expires March 14, 2009                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck              Expires August 19, 2008               [Page 42]  Schoenebeck              Expires March 14, 2009                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2354    
2355    
2356        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck              Expires August 19, 2008               [Page 43]  Schoenebeck              Expires March 14, 2009                [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2410    
2411    
2412     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck              Expires August 19, 2008               [Page 44]  Schoenebeck              Expires March 14, 2009                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2466    
2467    
2468     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck              Expires August 19, 2008               [Page 45]  Schoenebeck              Expires March 14, 2009                [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2522    
2523    
2524  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck              Expires August 19, 2008               [Page 46]  Schoenebeck              Expires March 14, 2009                [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2578    
2579    
2580           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck              Expires August 19, 2008               [Page 47]  Schoenebeck              Expires March 14, 2009                [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2634    
2635    
2636  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck              Expires August 19, 2008               [Page 48]  Schoenebeck              Expires March 14, 2009                [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2690    
2691    
2692     Possible Answers:     Possible Answers:
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck              Expires August 19, 2008               [Page 49]  Schoenebeck              Expires March 14, 2009                [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2746    
2747    
2748        following categories are defined:        following categories are defined:
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck              Expires August 19, 2008               [Page 50]  Schoenebeck              Expires March 14, 2009                [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2802    
2803    
2804           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
# Line 2852  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855  Schoenebeck              Expires August 19, 2008               [Page 51]  Schoenebeck              Expires March 14, 2009                [Page 51]
2856    
2857  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2858    
2859    
2860     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 2908  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911  Schoenebeck              Expires August 19, 2008               [Page 52]  Schoenebeck              Expires March 14, 2009                [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2914    
2915    
2916     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
# Line 2964  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck              Expires August 19, 2008               [Page 53]  Schoenebeck              Expires March 14, 2009                [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
2970    
2971    
2972     command.     command.
# Line 3020  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck              Expires August 19, 2008               [Page 54]  Schoenebeck              Expires March 14, 2009                [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3026    
3027    
3028        "OK" -        "OK" -
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck              Expires August 19, 2008               [Page 55]  Schoenebeck              Expires March 14, 2009                [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3082    
3083    
3084     Examples:     Examples:
# Line 3132  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck              Expires August 19, 2008               [Page 56]  Schoenebeck              Expires March 14, 2009                [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3138    
3139    
3140     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
# Line 3188  Internet-Draft        LinuxSampler Contr Line 3188  Internet-Draft        LinuxSampler Contr
3188    
3189    
3190    
3191  Schoenebeck              Expires August 19, 2008               [Page 57]  Schoenebeck              Expires March 14, 2009                [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3194    
3195    
3196           message           message
# Line 3244  Internet-Draft        LinuxSampler Contr Line 3244  Internet-Draft        LinuxSampler Contr
3244    
3245    
3246    
3247  Schoenebeck              Expires August 19, 2008               [Page 58]  Schoenebeck              Expires March 14, 2009                [Page 58]
3248    
3249  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3250    
3251    
3252        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
# Line 3300  Internet-Draft        LinuxSampler Contr Line 3300  Internet-Draft        LinuxSampler Contr
3300    
3301    
3302    
3303  Schoenebeck              Expires August 19, 2008               [Page 59]  Schoenebeck              Expires March 14, 2009                [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3306    
3307    
3308           if channel volume was set, but there are noteworthy issue(s)           if channel volume was set, but there are noteworthy issue(s)
# Line 3356  Internet-Draft        LinuxSampler Contr Line 3356  Internet-Draft        LinuxSampler Contr
3356    
3357    
3358    
3359  Schoenebeck              Expires August 19, 2008               [Page 60]  Schoenebeck              Expires March 14, 2009                [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3362    
3363    
3364  6.4.23.  Soloing a sampler channel  6.4.23.  Soloing a sampler channel
# Line 3412  Internet-Draft        LinuxSampler Contr Line 3412  Internet-Draft        LinuxSampler Contr
3412    
3413    
3414    
3415  Schoenebeck              Expires August 19, 2008               [Page 61]  Schoenebeck              Expires March 14, 2009                [Page 61]
3416    
3417  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3418    
3419    
3420           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
# Line 3468  Internet-Draft        LinuxSampler Contr Line 3468  Internet-Draft        LinuxSampler Contr
3468    
3469    
3470    
3471  Schoenebeck              Expires August 19, 2008               [Page 62]  Schoenebeck              Expires March 14, 2009                [Page 62]
3472    
3473  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3474    
3475    
3476     effect send entity.  The name does not have to be unique, but MUST be     effect send entity.  The name does not have to be unique, but MUST be
# Line 3524  Internet-Draft        LinuxSampler Contr Line 3524  Internet-Draft        LinuxSampler Contr
3524    
3525    
3526    
3527  Schoenebeck              Expires August 19, 2008               [Page 63]  Schoenebeck              Expires March 14, 2009                [Page 63]
3528    
3529  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3530    
3531    
3532  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
# Line 3580  Internet-Draft        LinuxSampler Contr Line 3580  Internet-Draft        LinuxSampler Contr
3580    
3581    
3582    
3583  Schoenebeck              Expires August 19, 2008               [Page 64]  Schoenebeck              Expires March 14, 2009                [Page 64]
3584    
3585  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3586    
3587    
3588        C: "GET FX_SENDS 0"        C: "GET FX_SENDS 0"
# Line 3636  Internet-Draft        LinuxSampler Contr Line 3636  Internet-Draft        LinuxSampler Contr
3636    
3637    
3638    
3639  Schoenebeck              Expires August 19, 2008               [Page 65]  Schoenebeck              Expires March 14, 2009                [Page 65]
3640    
3641  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3642    
3643    
3644        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
# Line 3692  Internet-Draft        LinuxSampler Contr Line 3692  Internet-Draft        LinuxSampler Contr
3692    
3693    
3694    
3695  Schoenebeck              Expires August 19, 2008               [Page 66]  Schoenebeck              Expires March 14, 2009                [Page 66]
3696    
3697  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3698    
3699    
3700  6.4.30.  Changing effect send's name  6.4.30.  Changing effect send's name
# Line 3748  Internet-Draft        LinuxSampler Contr Line 3748  Internet-Draft        LinuxSampler Contr
3748    
3749    
3750    
3751  Schoenebeck              Expires August 19, 2008               [Page 67]  Schoenebeck              Expires March 14, 2009                [Page 67]
3752    
3753  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3754    
3755    
3756     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
# Line 3804  Internet-Draft        LinuxSampler Contr Line 3804  Internet-Draft        LinuxSampler Contr
3804    
3805    
3806    
3807  Schoenebeck              Expires August 19, 2008               [Page 68]  Schoenebeck              Expires March 14, 2009                [Page 68]
3808    
3809  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3810    
3811    
3812     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
# Line 3860  Internet-Draft        LinuxSampler Contr Line 3860  Internet-Draft        LinuxSampler Contr
3860    
3861    
3862    
3863  Schoenebeck              Expires August 19, 2008               [Page 69]  Schoenebeck              Expires March 14, 2009                [Page 69]
3864    
3865  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
3866    
3867    
3868        "OK" -        "OK" -
# Line 3886  Internet-Draft        LinuxSampler Contr Line 3886  Internet-Draft        LinuxSampler Contr
3886    
3887        S: "OK"        S: "OK"
3888    
3889  6.4.34.  Resetting a sampler channel  6.4.34.  Sending MIDI messages to sampler channel
3890    
3891       The front-end can send MIDI events to specific sampler channel by
3892       sending the following command:
3893    
3894          SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>
3895    
3896       Where <sampler-chan> is the sampler channel number as returned by the
3897       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3898       command, <arg1> and <arg2> arguments depend on the <midi-msg>
3899       argument, which specifies the MIDI message type.  Currently, the
3900       following MIDI messages are supported:
3901    
3902          "NOTE_ON" -
3903    
3904             For turning on MIDI notes, where <arg1> specifies the key
3905             number and <arg2> the velocity as described in the MIDI
3906             specification.
3907    
3908          "NOTE_OFF" -
3909    
3910             For turning a currently playing MIDI note off, where <arg1>
3911             specifies the key number and <arg2> the velocity as described
3912             in the MIDI specification.
3913    
3914       CAUTION: This command is provided for implementations of virtual MIDI
3915       keyboards and no realtime guarantee whatsoever will be made!
3916    
3917    
3918    
3919    Schoenebeck              Expires March 14, 2009                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol       September 2008
3922    
3923    
3924       Possible Answers:
3925    
3926          "OK" -
3927    
3928             on success
3929    
3930          "ERR:<error-code>:<error-message>" -
3931    
3932             in case it failed, providing an appropriate error code and
3933             error message
3934    
3935       Example:
3936    
3937          C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
3938    
3939          S: "OK"
3940    
3941    6.4.35.  Resetting a sampler channel
3942    
3943     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3944     following command:     following command:
# Line 3912  Internet-Draft        LinuxSampler Contr Line 3964  Internet-Draft        LinuxSampler Contr
3964    
3965        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3966    
3967             in case it failed, providing an appropriate error code and
3968             error message
3969    
3970       Examples:
3971    
3972    
3973    
 Schoenebeck              Expires August 19, 2008               [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
3974    
3975           in case it failed, providing an appropriate error code and  Schoenebeck              Expires March 14, 2009                [Page 71]
3976           error message  
3977    Internet-Draft        LinuxSampler Control Protocol       September 2008
3978    
    Examples:  
3979    
3980    
3981    
# Line 3969  Internet-Draft        LinuxSampler Contr Line 4020  Internet-Draft        LinuxSampler Contr
4020     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
4021     event messages anymore by sending the following command:     event messages anymore by sending the following command:
4022    
4023          UNSUBSCRIBE <event-id>
4024    
4025       Where <event-id> will be replaced by the respective event that client
4026       doesn't want to receive anymore.
4027    
4028    
 Schoenebeck              Expires August 19, 2008               [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
4029    
4030    
4031        UNSUBSCRIBE <event-id>  Schoenebeck              Expires March 14, 2009                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol       September 2008
4034    
    Where <event-id> will be replaced by the respective event that client  
    doesn't want to receive anymore.  
4035    
4036     Possible Answers:     Possible Answers:
4037    
# Line 4023  Internet-Draft        LinuxSampler Contr Line 4074  Internet-Draft        LinuxSampler Contr
4074    
4075           usually           usually
4076    
4077          "ERR:<error-code>:<error-message>" -
4078    
4079             on syntax error, e.g. non boolean value
4080    
4081       Examples:
4082    
4083    
4084    
 Schoenebeck              Expires August 19, 2008               [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
4085    
       "ERR:<error-code>:<error-message>" -  
4086    
4087           on syntax error, e.g. non boolean value  Schoenebeck              Expires March 14, 2009                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol       September 2008
4090    
    Examples:  
4091    
4092    
4093    
# Line 4079  Internet-Draft        LinuxSampler Contr Line 4129  Internet-Draft        LinuxSampler Contr
4129        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4130        voices.        voices.
4131    
   
   
   
   
   
 Schoenebeck              Expires August 19, 2008               [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
4132  6.6.3.  Current number of active disk streams  6.6.3.  Current number of active disk streams
4133    
4134     The front-end can ask for the current number of active disk streams     The front-end can ask for the current number of active disk streams
# Line 4098  Internet-Draft        LinuxSampler Contr Line 4138  Internet-Draft        LinuxSampler Contr
4138    
4139     Possible Answers:     Possible Answers:
4140    
4141    
4142    
4143    Schoenebeck              Expires March 14, 2009                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol       September 2008
4146    
4147    
4148        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4149        disk streams on the sampler.        disk streams on the sampler.
4150    
# Line 4137  Internet-Draft        LinuxSampler Contr Line 4184  Internet-Draft        LinuxSampler Contr
4184    
4185           DESCRIPTION -           DESCRIPTION -
4186    
   
   
   
 Schoenebeck              Expires August 19, 2008               [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
4187              arbitrary textual description about the sampler (note that              arbitrary textual description about the sampler (note that
4188              the character string may contain escape sequences              the character string may contain escape sequences
4189              (Section 7.1))              (Section 7.1))
# Line 4153  Internet-Draft        LinuxSampler Contr Line 4192  Internet-Draft        LinuxSampler Contr
4192    
4193              version of the sampler              version of the sampler
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck              Expires March 14, 2009                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol       September 2008
4202    
4203    
4204           PROTOCOL_VERSION -           PROTOCOL_VERSION -
4205    
4206              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
# Line 4193  Internet-Draft        LinuxSampler Contr Line 4241  Internet-Draft        LinuxSampler Contr
4241     Where <volume> should be replaced by the optional dotted floating     Where <volume> should be replaced by the optional dotted floating
4242     point value, reflecting the new global volume parameter.  This value     point value, reflecting the new global volume parameter.  This value
4243     might usually be in the range between 0.0 and 1.0, that is for     might usually be in the range between 0.0 and 1.0, that is for
4244       attenuating the overall volume.
4245    
4246       Possible Answers:
4247    
4248          "OK" -
4249    
4250  Schoenebeck              Expires August 19, 2008               [Page 75]           on success
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
4251    
4252    
    attenuating the overall volume.  
4253    
    Possible Answers:  
4254    
4255        "OK" -  Schoenebeck              Expires March 14, 2009                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol       September 2008
4258    
          on success  
4259    
4260        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4261    
# Line 4250  Internet-Draft        LinuxSampler Contr Line 4298  Internet-Draft        LinuxSampler Contr
4298     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4299     current MIDI instrument map.     current MIDI instrument map.
4300    
4301    6.7.1.  Create a new MIDI instrument map
4302    
4303       The front-end can add a new MIDI instrument map by sending the
4304       following command:
4305    
4306    
 Schoenebeck              Expires August 19, 2008               [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
4307    
4308    
 6.7.1.  Create a new MIDI instrument map  
4309    
4310     The front-end can add a new MIDI instrument map by sending the  
4311     following command:  Schoenebeck              Expires March 14, 2009                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol       September 2008
4314    
4315    
4316        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4317    
# Line 4306  Internet-Draft        LinuxSampler Contr Line 4357  Internet-Draft        LinuxSampler Contr
4357     Where <map> reflects the unique ID of the map to delete as returned     Where <map> reflects the unique ID of the map to delete as returned
4358     by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.     by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4359    
4360       The front-end can delete all MIDI instrument maps by sending the
4361       following command:
4362    
4363    
 Schoenebeck              Expires August 19, 2008               [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
4364    
4365    
4366     The front-end can delete all MIDI instrument maps by sending the  
4367     following command:  Schoenebeck              Expires March 14, 2009                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol       September 2008
4370    
4371    
4372        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4373    
# Line 4364  Internet-Draft        LinuxSampler Contr Line 4417  Internet-Draft        LinuxSampler Contr
4417    
4418    
4419    
4420  Schoenebeck              Expires August 19, 2008               [Page 78]  
4421    
4422    
4423    Schoenebeck              Expires March 14, 2009                [Page 79]
4424    
4425  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4426    
4427    
4428        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
# Line 4420  Internet-Draft        LinuxSampler Contr Line 4476  Internet-Draft        LinuxSampler Contr
4476    
4477    
4478    
4479  Schoenebeck              Expires August 19, 2008               [Page 79]  Schoenebeck              Expires March 14, 2009                [Page 80]
4480    
4481  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4482    
4483    
4484        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
# Line 4476  Internet-Draft        LinuxSampler Contr Line 4532  Internet-Draft        LinuxSampler Contr
4532    
4533    
4534    
4535  Schoenebeck              Expires August 19, 2008               [Page 80]  Schoenebeck              Expires March 14, 2009                [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4538    
4539    
4540     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
# Line 4532  Internet-Draft        LinuxSampler Contr Line 4588  Internet-Draft        LinuxSampler Contr
4588    
4589    
4590    
4591  Schoenebeck              Expires August 19, 2008               [Page 81]  Schoenebeck              Expires March 14, 2009                [Page 82]
4592    
4593  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4594    
4595    
4596           instrument does not exist in the InstrumentManager's list yet,           instrument does not exist in the InstrumentManager's list yet,
# Line 4588  Internet-Draft        LinuxSampler Contr Line 4644  Internet-Draft        LinuxSampler Contr
4644    
4645    
4646    
4647  Schoenebeck              Expires August 19, 2008               [Page 82]  Schoenebeck              Expires March 14, 2009                [Page 83]
4648    
4649  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4650    
4651    
4652        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 4644  Internet-Draft        LinuxSampler Contr Line 4700  Internet-Draft        LinuxSampler Contr
4700    
4701    
4702    
4703  Schoenebeck              Expires August 19, 2008               [Page 83]  Schoenebeck              Expires March 14, 2009                [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4706    
4707    
4708        The sampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
# Line 4700  Internet-Draft        LinuxSampler Contr Line 4756  Internet-Draft        LinuxSampler Contr
4756    
4757    
4758    
4759  Schoenebeck              Expires August 19, 2008               [Page 84]  Schoenebeck              Expires March 14, 2009                [Page 85]
4760    
4761  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4762    
4763    
4764        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
# Line 4756  Internet-Draft        LinuxSampler Contr Line 4812  Internet-Draft        LinuxSampler Contr
4812    
4813    
4814    
4815  Schoenebeck              Expires August 19, 2008               [Page 85]  Schoenebeck              Expires March 14, 2009                [Page 86]
4816    
4817  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4818    
4819    
4820           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
# Line 4812  Internet-Draft        LinuxSampler Contr Line 4868  Internet-Draft        LinuxSampler Contr
4868    
4869    
4870    
4871  Schoenebeck              Expires August 19, 2008               [Page 86]  Schoenebeck              Expires March 14, 2009                [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4874    
4875    
4876           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
# Line 4868  Internet-Draft        LinuxSampler Contr Line 4924  Internet-Draft        LinuxSampler Contr
4924    
4925    
4926    
4927  Schoenebeck              Expires August 19, 2008               [Page 87]  Schoenebeck              Expires March 14, 2009                [Page 88]
4928    
4929  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4930    
4931    
4932  6.8.  Managing Instruments Database  6.8.  Managing Instruments Database
# Line 4924  Internet-Draft        LinuxSampler Contr Line 4980  Internet-Draft        LinuxSampler Contr
4980    
4981    
4982    
4983  Schoenebeck              Expires August 19, 2008               [Page 88]  Schoenebeck              Expires March 14, 2009                [Page 89]
4984    
4985  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
4986    
4987    
4988        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
# Line 4980  Internet-Draft        LinuxSampler Contr Line 5036  Internet-Draft        LinuxSampler Contr
5036    
5037    
5038    
5039  Schoenebeck              Expires August 19, 2008               [Page 89]  Schoenebeck              Expires March 14, 2009                [Page 90]
5040    
5041  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5042    
5043    
5044        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
# Line 5036  Internet-Draft        LinuxSampler Contr Line 5092  Internet-Draft        LinuxSampler Contr
5092    
5093    
5094    
5095  Schoenebeck              Expires August 19, 2008               [Page 90]  Schoenebeck              Expires March 14, 2009                [Page 91]
5096    
5097  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5098    
5099    
5100        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 5092  Internet-Draft        LinuxSampler Contr Line 5148  Internet-Draft        LinuxSampler Contr
5148    
5149    
5150    
5151  Schoenebeck              Expires August 19, 2008               [Page 91]  Schoenebeck              Expires March 14, 2009                [Page 92]
5152    
5153  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5154    
5155    
5156     Possible Answers:     Possible Answers:
# Line 5148  Internet-Draft        LinuxSampler Contr Line 5204  Internet-Draft        LinuxSampler Contr
5204    
5205    
5206    
5207  Schoenebeck              Expires August 19, 2008               [Page 92]  Schoenebeck              Expires March 14, 2009                [Page 93]
5208    
5209  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5210    
5211    
5212  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
# Line 5204  Internet-Draft        LinuxSampler Contr Line 5260  Internet-Draft        LinuxSampler Contr
5260    
5261    
5262    
5263  Schoenebeck              Expires August 19, 2008               [Page 93]  Schoenebeck              Expires March 14, 2009                [Page 94]
5264    
5265  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5266    
5267    
5268        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5260  Internet-Draft        LinuxSampler Contr Line 5316  Internet-Draft        LinuxSampler Contr
5316    
5317    
5318    
5319  Schoenebeck              Expires August 19, 2008               [Page 94]  Schoenebeck              Expires March 14, 2009                [Page 95]
5320    
5321  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5322    
5323    
5324        are last modified before <date-before>.  If <date-before> is        are last modified before <date-before>.  If <date-before> is
# Line 5316  Internet-Draft        LinuxSampler Contr Line 5372  Internet-Draft        LinuxSampler Contr
5372    
5373    
5374    
5375  Schoenebeck              Expires August 19, 2008               [Page 95]  Schoenebeck              Expires March 14, 2009                [Page 96]
5376    
5377  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5378    
5379    
5380     file is supplied, only the instruments in the specified file will be     file is supplied, only the instruments in the specified file will be
# Line 5372  Internet-Draft        LinuxSampler Contr Line 5428  Internet-Draft        LinuxSampler Contr
5428    
5429    
5430    
5431  Schoenebeck              Expires August 19, 2008               [Page 96]  Schoenebeck              Expires March 14, 2009                [Page 97]
5432    
5433  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5434    
5435    
5436           if an invalid path is specified.           if an invalid path is specified.
# Line 5428  Internet-Draft        LinuxSampler Contr Line 5484  Internet-Draft        LinuxSampler Contr
5484    
5485    
5486    
5487  Schoenebeck              Expires August 19, 2008               [Page 97]  Schoenebeck              Expires March 14, 2009                [Page 98]
5488    
5489  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5490    
5491    
5492        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
# Line 5484  Internet-Draft        LinuxSampler Contr Line 5540  Internet-Draft        LinuxSampler Contr
5540    
5541    
5542    
5543  Schoenebeck              Expires August 19, 2008               [Page 98]  Schoenebeck              Expires March 14, 2009                [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5546    
5547    
5548  6.8.15.  Getting instrument information  6.8.15.  Getting instrument information
# Line 5540  Internet-Draft        LinuxSampler Contr Line 5596  Internet-Draft        LinuxSampler Contr
5596    
5597    
5598    
5599  Schoenebeck              Expires August 19, 2008               [Page 99]  Schoenebeck              Expires March 14, 2009               [Page 100]
5600    
5601  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5602    
5603    
5604           MODIFIED -           MODIFIED -
# Line 5596  Internet-Draft        LinuxSampler Contr Line 5652  Internet-Draft        LinuxSampler Contr
5652    
5653    
5654    
5655  Schoenebeck              Expires August 19, 2008              [Page 100]  Schoenebeck              Expires March 14, 2009               [Page 101]
5656    
5657  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5658    
5659    
5660           "SIZE: 2050871870"           "SIZE: 2050871870"
# Line 5652  Internet-Draft        LinuxSampler Contr Line 5708  Internet-Draft        LinuxSampler Contr
5708    
5709    
5710    
5711  Schoenebeck              Expires August 19, 2008              [Page 101]  Schoenebeck              Expires March 14, 2009               [Page 102]
5712    
5713  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5714    
5715    
5716  6.8.17.  Moving an instrument  6.8.17.  Moving an instrument
# Line 5708  Internet-Draft        LinuxSampler Contr Line 5764  Internet-Draft        LinuxSampler Contr
5764    
5765    
5766    
5767  Schoenebeck              Expires August 19, 2008              [Page 102]  Schoenebeck              Expires March 14, 2009               [Page 103]
5768    
5769  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5770    
5771    
5772           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
# Line 5764  Internet-Draft        LinuxSampler Contr Line 5820  Internet-Draft        LinuxSampler Contr
5820    
5821    
5822    
5823  Schoenebeck              Expires August 19, 2008              [Page 103]  Schoenebeck              Expires March 14, 2009               [Page 104]
5824    
5825  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5826    
5827    
5828     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
# Line 5820  Internet-Draft        LinuxSampler Contr Line 5876  Internet-Draft        LinuxSampler Contr
5876    
5877    
5878    
5879  Schoenebeck              Expires August 19, 2008              [Page 104]  Schoenebeck              Expires March 14, 2009               [Page 105]
5880    
5881  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5882    
5883    
5884        Restricts the search to instruments with product info that        Restricts the search to instruments with product info that
# Line 5876  Internet-Draft        LinuxSampler Contr Line 5932  Internet-Draft        LinuxSampler Contr
5932    
5933    
5934    
5935  Schoenebeck              Expires August 19, 2008              [Page 105]  Schoenebeck              Expires March 14, 2009               [Page 106]
5936    
5937  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5938    
5939    
5940        S: "'/Piano Collection/Bosendorfer 290'"        S: "'/Piano Collection/Bosendorfer 290'"
# Line 5932  Internet-Draft        LinuxSampler Contr Line 5988  Internet-Draft        LinuxSampler Contr
5988    
5989    
5990    
5991  Schoenebeck              Expires August 19, 2008              [Page 106]  Schoenebeck              Expires March 14, 2009               [Page 107]
5992    
5993  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
5994    
5995    
5996     Example:     Example:
# Line 5969  Internet-Draft        LinuxSampler Contr Line 6025  Internet-Draft        LinuxSampler Contr
6025    
6026           If the formatting of the instruments database failed.           If the formatting of the instruments database failed.
6027    
6028    6.8.23.  Checking for lost instrument files
6029    
6030       The front-end can retrieve the list of all instrument files in the
6031       instruments database that don't exist in the filesystem by sending
6032       the following command:
6033    
6034          FIND LOST DB_INSTRUMENT_FILES
6035    
6036       Possible Answers:
6037    
6038          A comma separated list with the absolute path names (encapsulated
6039          into apostrophes) of all lost instrument files.
6040    
6041          "ERR:<error-code>:<error-message>" -
6042    
6043    
6044    
6045    
6046    
6047    Schoenebeck              Expires March 14, 2009               [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol       September 2008
6050    
6051    
6052             in case it failed, providing an appropriate error code and
6053             error message.
6054    
6055       Example:
6056    
6057          C: "FIND LOST DB_INSTRUMENT_FILES"
6058    
6059          S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
6060          Piano.gig'"
6061    
6062    6.8.24.  Replacing an instrument file
6063    
6064       The front-end can substitute all occurrences of an instrument file in
6065       the instruments database with a new one by sending the following
6066       command:
6067    
6068          SET DB_INSTRUMENT FILE_PATH <old_path> <new_path>
6069    
6070       Where <old_path> is the absolute path name of the instrument file to
6071       substitute with <new_path>.
6072    
6073       Possible Answers:
6074    
6075          "OK" -
6076    
6077             on success
6078    
6079          "ERR:<error-code>:<error-message>" -
6080    
6081             in case it failed, providing an appropriate error code and
6082             error message.
6083    
6084       Example:
6085    
6086          C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig'
6087          '/gigs/pianos/Bosendorfer 290.gig'"
6088    
6089          S: "OK"
6090    
6091  6.9.  Editing Instruments  6.9.  Editing Instruments
6092    
6093     The sampler allows to edit instruments while playing with the sampler     The sampler allows to edit instruments while playing with the sampler
# Line 5978  Internet-Draft        LinuxSampler Contr Line 6097  Internet-Draft        LinuxSampler Contr
6097     directory.  The sampler will automatically try to load all plugin     directory.  The sampler will automatically try to load all plugin
6098     DLLs in that directory on startup and only on startup!     DLLs in that directory on startup and only on startup!
6099    
6100    
6101    
6102    
6103    Schoenebeck              Expires March 14, 2009               [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol       September 2008
6106    
6107    
6108     At the moment there is only one command for this feature set, but     At the moment there is only one command for this feature set, but
6109     this will most probably change in future.     this will most probably change in future.
6110    
# Line 5986  Internet-Draft        LinuxSampler Contr Line 6113  Internet-Draft        LinuxSampler Contr
6113     The front-end can request to open an appropriate instrument editor     The front-end can request to open an appropriate instrument editor
6114     application by sending the following command:     application by sending the following command:
6115    
   
   
 Schoenebeck              Expires August 19, 2008              [Page 107]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
6116        EDIT CHANNEL INSTRUMENT <sampler-channel>        EDIT CHANNEL INSTRUMENT <sampler-channel>
6117    
6118     Where <sampler-channel> should be replaced by the number of the     Where <sampler-channel> should be replaced by the number of the
# Line 6032  Internet-Draft        LinuxSampler Contr Line 6152  Internet-Draft        LinuxSampler Contr
6152    
6153        C: "EDIT CHANNEL INSTRUMENT 0"        C: "EDIT CHANNEL INSTRUMENT 0"
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck              Expires March 14, 2009               [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol       September 2008
6162    
6163    
6164        S: "OK"        S: "OK"
6165    
6166  6.10.  Managing Files  6.10.  Managing Files
# Line 6041  Internet-Draft        LinuxSampler Contr Line 6170  Internet-Draft        LinuxSampler Contr
6170     set allows to retrieve file informations even remotely from another     set allows to retrieve file informations even remotely from another
6171     machine.     machine.
6172    
   
   
   
 Schoenebeck              Expires August 19, 2008              [Page 108]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
6173  6.10.1.  Retrieving amount of instruments of a file  6.10.1.  Retrieving amount of instruments of a file
6174    
6175     The front-end can retrieve the amount of instruments within a given     The front-end can retrieve the amount of instruments within a given
# Line 6088  Internet-Draft        LinuxSampler Contr Line 6209  Internet-Draft        LinuxSampler Contr
6209    
6210     Where <filename> is the name of the instrument file (encapsulated     Where <filename> is the name of the instrument file (encapsulated
6211     into apostrophes, supporting escape sequences as described in chapter     into apostrophes, supporting escape sequences as described in chapter
    "Character Set and Escape Sequences (Section 7.1)").  
   
    The sampler will try to ask all sampler engines, whether they support  
    the given file and ask the first engine with a positive answer for a  
    list of IDs for the instruments in the given file.  
6212    
    Possible Answers:  
6213    
6214    
6215    Schoenebeck              Expires March 14, 2009               [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol       September 2008
6218    
6219    
6220       "Character Set and Escape Sequences (Section 7.1)").
6221    
6222  Schoenebeck              Expires August 19, 2008              [Page 109]     The sampler will try to ask all sampler engines, whether they support
6223       the given file and ask the first engine with a positive answer for a
6224  Internet-Draft        LinuxSampler Control Protocol        February 2008     list of IDs for the instruments in the given file.
6225    
6226       Possible Answers:
6227    
6228        On success, the sampler will answer by returning a comma separated        On success, the sampler will answer by returning a comma separated
6229        list of instrument IDs.        list of instrument IDs.
# Line 6146  Internet-Draft        LinuxSampler Contr Line 6266  Internet-Draft        LinuxSampler Contr
6266    
6267    
6268    
          NAME -  
6269    
             name of the instrument as stored in the instrument file  
6270    
6271           FORMAT_FAMILY -  Schoenebeck              Expires March 14, 2009               [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol       September 2008
6274    
6275    
6276    
6277    
6278             NAME -
6279    
6280  Schoenebeck              Expires August 19, 2008              [Page 110]              name of the instrument as stored in the instrument file
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
6281    
6282             FORMAT_FAMILY -
6283    
6284              name of the sampler format of the given instrument              name of the sampler format of the given instrument
6285    
# Line 6176  Internet-Draft        LinuxSampler Contr Line 6296  Internet-Draft        LinuxSampler Contr
6296    
6297              artists / sample library vendor of the instrument              artists / sample library vendor of the instrument
6298    
6299             KEY_BINDINGS -
6300    
6301                comma separated list of integer values representing the
6302                instrument's key mapping in the range between 0 .. 127,
6303                reflecting the analog meaning of the MIDI specification.
6304    
6305             KEYSWITCH_BINDINGS -
6306    
6307                comma separated list of integer values representing the
6308                instrument's keyswitch mapping in the range between 0 ..
6309                127, reflecting the analog meaning of the MIDI
6310                specification.
6311    
6312     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
6313    
6314     Example:     Example:
# Line 6188  Internet-Draft        LinuxSampler Contr Line 6321  Internet-Draft        LinuxSampler Contr
6321    
6322           "FORMAT_VERSION: 3"           "FORMAT_VERSION: 3"
6323    
6324    
6325    
6326    
6327    Schoenebeck              Expires March 14, 2009               [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol       September 2008
6330    
6331    
6332           "PRODUCT: The Backbone Bongo Beats"           "PRODUCT: The Backbone Bongo Beats"
6333    
6334           "ARTISTS: Jimmy the Fish"           "ARTISTS: Jimmy the Fish"
# Line 6212  Internet-Draft        LinuxSampler Contr Line 6353  Internet-Draft        LinuxSampler Contr
6353    
6354    
6355    
6356  Schoenebeck              Expires August 19, 2008              [Page 111]  
6357    
6358    
6359    
6360    
6361    
6362    
6363    
6364    
6365    
6366    
6367    
6368    
6369    
6370    
6371    
6372    
6373    
6374    
6375    
6376    
6377    
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck              Expires March 14, 2009               [Page 114]
6384    
6385  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6386    
6387    
6388  7.  Command Syntax  7.  Command Syntax
# Line 6268  Internet-Draft        LinuxSampler Contr Line 6436  Internet-Draft        LinuxSampler Contr
6436    
6437    
6438    
6439  Schoenebeck              Expires August 19, 2008              [Page 112]  Schoenebeck              Expires March 14, 2009               [Page 115]
6440    
6441  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6442    
6443    
6444        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6299  Internet-Draft        LinuxSampler Contr Line 6467  Internet-Draft        LinuxSampler Contr
6467    
6468        / FORMAT SP format_instruction        / FORMAT SP format_instruction
6469    
6470          SEND SP send_instruction
6471    
6472        / RESET        / RESET
6473    
6474        / QUIT        / QUIT
# Line 6318  Internet-Draft        LinuxSampler Contr Line 6488  Internet-Draft        LinuxSampler Contr
6488        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6489        instrument_index        instrument_index
6490    
       / DB_INSTRUMENTS SP db_path SP filename  
   
6491    
6492    
6493    
6494    
6495  Schoenebeck              Expires August 19, 2008              [Page 113]  Schoenebeck              Expires March 14, 2009               [Page 116]
6496    
6497  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6498    
6499    
6500          / DB_INSTRUMENTS SP db_path SP filename
6501    
6502        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6503    
6504        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
# Line 6375  Internet-Draft        LinuxSampler Contr Line 6545  Internet-Draft        LinuxSampler Contr
6545    
6546        / DB_INSTRUMENT_DIRECTORY_INFO        / DB_INSTRUMENT_DIRECTORY_INFO
6547    
       / DB_INSTRUMENT_COUNT  
   
6548    
6549    
6550    
6551  Schoenebeck              Expires August 19, 2008              [Page 114]  Schoenebeck              Expires March 14, 2009               [Page 117]
6552    
6553  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6554    
6555    
6556          / DB_INSTRUMENT_COUNT
6557    
6558        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
6559    
# Line 6431  Internet-Draft        LinuxSampler Contr Line 6601  Internet-Draft        LinuxSampler Contr
6601    
6602        / MIDI_INSTRUMENT_COUNT        / MIDI_INSTRUMENT_COUNT
6603    
       / MIDI_INSTRUMENT_INFO  
6604    
6605    
6606    
6607    Schoenebeck              Expires March 14, 2009               [Page 118]
 Schoenebeck              Expires August 19, 2008              [Page 115]  
6608    
6609  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6610    
6611    
6612          / MIDI_INSTRUMENT_INFO
6613    
6614        / DB_INSTRUMENT_DIRECTORY_COUNT        / DB_INSTRUMENT_DIRECTORY_COUNT
6615    
# Line 6486  Internet-Draft        LinuxSampler Contr Line 6656  Internet-Draft        LinuxSampler Contr
6656    
6657        / MIDI_INSTRUMENT_MAP SP midi_map        / MIDI_INSTRUMENT_MAP SP midi_map
6658    
       / MIDI_INSTRUMENT_MAP SP ALL  
   
6659    
6660    
6661    
6662    
6663  Schoenebeck              Expires August 19, 2008              [Page 116]  Schoenebeck              Expires March 14, 2009               [Page 119]
6664    
6665  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6666    
6667    
6668          / MIDI_INSTRUMENT_MAP SP ALL
6669    
6670        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6671    
# Line 6542  Internet-Draft        LinuxSampler Contr Line 6712  Internet-Draft        LinuxSampler Contr
6712        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
6713        string        string
6714    
       / CHANNELS  
   
6715    
6716    
6717    
6718    
6719  Schoenebeck              Expires August 19, 2008              [Page 117]  Schoenebeck              Expires March 14, 2009               [Page 120]
6720    
6721  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6722    
6723    
6724          / CHANNELS
6725    
6726        / CHANNEL SP INFO SP sampler_channel        / CHANNEL SP INFO SP sampler_channel
6727    
6728        / CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel        / CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
# Line 6599  Internet-Draft        LinuxSampler Contr Line 6769  Internet-Draft        LinuxSampler Contr
6769    
6770        / DB_INSTRUMENTS_JOB SP INFO SP number        / DB_INSTRUMENTS_JOB SP INFO SP number
6771    
       / VOLUME  
   
6772    
6773    
6774    
6775  Schoenebeck              Expires August 19, 2008              [Page 118]  Schoenebeck              Expires March 14, 2009               [Page 121]
6776    
6777  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6778    
6779    
6780          / VOLUME
6781    
6782        / FILE SP INSTRUMENTS SP filename        / FILE SP INSTRUMENTS SP filename
6783    
# Line 6653  Internet-Draft        LinuxSampler Contr Line 6823  Internet-Draft        LinuxSampler Contr
6823    
6824        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6825    
6826        / ECHO SP boolean        / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
   
       / VOLUME SP volume_value  
6827    
6828    
6829    
6830    
6831  Schoenebeck              Expires August 19, 2008              [Page 119]  Schoenebeck              Expires March 14, 2009               [Page 122]
6832    
6833  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
6834    
6835    
6836          / ECHO SP boolean
6837    
6838          / VOLUME SP volume_value
6839    
6840     create_instruction =     create_instruction =
6841    
# Line 6700  Internet-Draft        LinuxSampler Contr Line 6872  Internet-Draft        LinuxSampler Contr
6872    
6873        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6874    
6875          / LOST SP DB_INSTRUMENT_FILES
6876    
6877     move_instruction =     move_instruction =
6878    
6879        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
# Line 6708  Internet-Draft        LinuxSampler Contr Line 6882  Internet-Draft        LinuxSampler Contr
6882    
6883     copy_instruction =     copy_instruction =
6884    
       DB_INSTRUMENT_DIRECTORY SP db_path SP db_path  
6885    
       / DB_INSTRUMENT SP db_path SP db_path  
6886    
6887     destroy_instruction =  Schoenebeck              Expires March 14, 2009               [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol       September 2008
6890    
6891    
6892          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6893    
6894  Schoenebeck              Expires August 19, 2008              [Page 120]        / DB_INSTRUMENT SP db_path SP db_path
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
6895    
6896       destroy_instruction =
6897    
6898        AUDIO_OUTPUT_DEVICE SP number        AUDIO_OUTPUT_DEVICE SP number
6899    
# Line 6762  Internet-Draft        LinuxSampler Contr Line 6936  Internet-Draft        LinuxSampler Contr
6936    
6937        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6938    
       / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE  
6939    
       / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT  
6940    
    edit_instruction =  
6941    
6942    
6943    Schoenebeck              Expires March 14, 2009               [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol       September 2008
6946    
6947    
6948          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6949    
6950  Schoenebeck              Expires August 19, 2008              [Page 121]        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
6951    
6952       edit_instruction =
6953    
6954        CHANNEL SP INSTRUMENT SP sampler_channel        CHANNEL SP INSTRUMENT SP sampler_channel
6955    
# Line 6819  Internet-Draft        LinuxSampler Contr Line 6993  Internet-Draft        LinuxSampler Contr
6993    
6994        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
6995    
       / MIDI_INSTRUMENT_MAPS  
6996    
       / FX_SENDS SP sampler_channel  
6997    
       / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path  
6998    
6999    Schoenebeck              Expires March 14, 2009               [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol       September 2008
7002    
7003    
7004          / MIDI_INSTRUMENT_MAPS
7005    
7006  Schoenebeck              Expires August 19, 2008              [Page 122]        / FX_SENDS SP sampler_channel
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
7007    
7008          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
7009    
7010        / DB_INSTRUMENT_DIRECTORIES SP db_path        / DB_INSTRUMENT_DIRECTORIES SP db_path
7011    
# Line 6841  Internet-Draft        LinuxSampler Contr Line 7015  Internet-Draft        LinuxSampler Contr
7015    
7016        / FILE SP INSTRUMENTS SP filename        / FILE SP INSTRUMENTS SP filename
7017    
7018       send_instruction =
7019    
7020          CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP
7021          number
7022    
7023     load_instr_args =     load_instr_args =
7024    
7025        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 6869  Internet-Draft        LinuxSampler Contr Line 7048  Internet-Draft        LinuxSampler Contr
7048    
7049     audio_output_type_name =     audio_output_type_name =
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck              Expires March 14, 2009               [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol       September 2008
7058    
7059    
7060        string        string
7061    
7062     midi_input_port_index =     midi_input_port_index =
# Line 6881  Internet-Draft        LinuxSampler Contr Line 7069  Internet-Draft        LinuxSampler Contr
7069    
7070        / ALL        / ALL
7071    
   
   
   
 Schoenebeck              Expires August 19, 2008              [Page 123]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
7072     midi_input_type_name =     midi_input_type_name =
7073    
7074        string        string
# Line 6925  Internet-Draft        LinuxSampler Contr Line 7105  Internet-Draft        LinuxSampler Contr
7105    
7106     fx_send_id =     fx_send_id =
7107    
7108    
7109    
7110    
7111    Schoenebeck              Expires March 14, 2009               [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol       September 2008
7114    
7115    
7116        number        number
7117    
7118     engine_name =     engine_name =
# Line 6937  Internet-Draft        LinuxSampler Contr Line 7125  Internet-Draft        LinuxSampler Contr
7125    
7126     db_path =     db_path =
7127    
   
   
   
 Schoenebeck              Expires August 19, 2008              [Page 124]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
7128        path        path
7129    
7130     map_name =     map_name =
# Line 6981  Internet-Draft        LinuxSampler Contr Line 7161  Internet-Draft        LinuxSampler Contr
7161    
7162        / query_val_list SP string '=' query_val        / query_val_list SP string '=' query_val
7163    
7164    
7165    
7166    
7167    Schoenebeck              Expires March 14, 2009               [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol       September 2008
7170    
7171    
7172     query_val =     query_val =
7173    
7174        text_escaped        text_escaped
# Line 6993  Internet-Draft        LinuxSampler Contr Line 7181  Internet-Draft        LinuxSampler Contr
7181    
7182        / NON_RECURSIVE        / NON_RECURSIVE
7183    
   
   
   
 Schoenebeck              Expires August 19, 2008              [Page 125]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
7184        / FLAT        / FLAT
7185    
7186  7.1.  Character Set and Escape Sequences  7.1.  Character Set and Escape Sequences
# Line 7036  Internet-Draft        LinuxSampler Contr Line 7216  Internet-Draft        LinuxSampler Contr
7216     | \OOO                   | three digit octal ASCII code of the      |     | \OOO                   | three digit octal ASCII code of the      |
7217     |                        | character                                |     |                        | character                                |
7218     |                        |                                          |     |                        |                                          |
7219    
7220    
7221    
7222    
7223    Schoenebeck              Expires March 14, 2009               [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol       September 2008
7226    
7227    
7228     | \xHH                   | two digit hex ASCII code of the          |     | \xHH                   | two digit hex ASCII code of the          |
7229     |                        | character                                |     |                        | character                                |
7230     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 7049  Internet-Draft        LinuxSampler Contr Line 7238  Internet-Draft        LinuxSampler Contr
7238     backslash was sufficient.     backslash was sufficient.
7239    
7240     The following LSCP commands support escape sequences as part of their     The following LSCP commands support escape sequences as part of their
   
   
   
 Schoenebeck              Expires August 19, 2008              [Page 126]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
7241     filename / path based arguments and / or may contain a filename /     filename / path based arguments and / or may contain a filename /
7242     path with escape sequences in their response:     path with escape sequences in their response:
7243    
# Line 7092  Internet-Draft        LinuxSampler Contr Line 7273  Internet-Draft        LinuxSampler Contr
7273    
7274        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7275    
7276    
7277    
7278    
7279    Schoenebeck              Expires March 14, 2009               [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol       September 2008
7282    
7283    
7284        "SET DB_INSTRUMENT NAME" (Section 6.8.16)        "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7285    
7286        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
# Line 7104  Internet-Draft        LinuxSampler Contr Line 7293  Internet-Draft        LinuxSampler Contr
7293    
7294        "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)        "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
7295    
   
   
   
   
 Schoenebeck              Expires August 19, 2008              [Page 127]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
7296        "COPY DB_INSTRUMENT" (Section 6.8.18)        "COPY DB_INSTRUMENT" (Section 6.8.18)
7297    
7298        "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)        "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
7299    
7300          "FIND LOST DB_INSTRUMENT_FILES" (Section 6.8.23)
7301    
7302          "SET DB_INSTRUMENT FILE_PATH" (Section 6.8.24)
7303    
7304        "GET FILE INSTRUMENTS" (Section 6.10.1)        "GET FILE INSTRUMENTS" (Section 6.10.1)
7305    
7306        "LIST FILE INSTRUMENTS" (Section 6.10.2)        "LIST FILE INSTRUMENTS" (Section 6.10.2)
# Line 7144  Internet-Draft        LinuxSampler Contr Line 7328  Internet-Draft        LinuxSampler Contr
7328    
7329        "GET SERVER INFO" (Section 6.6.5)        "GET SERVER INFO" (Section 6.6.5)
7330    
7331    
7332    
7333    
7334    
7335    Schoenebeck              Expires March 14, 2009               [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol       September 2008
7338    
7339    
7340        "GET ENGINE INFO" (Section 6.4.9)        "GET ENGINE INFO" (Section 6.4.9)
7341    
7342        "GET CHANNEL INFO" (Section 6.4.10)        "GET CHANNEL INFO" (Section 6.4.10)
# Line 7160  Internet-Draft        LinuxSampler Contr Line 7353  Internet-Draft        LinuxSampler Contr
7353    
7354        "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)        "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
7355    
   
   
   
   
 Schoenebeck              Expires August 19, 2008              [Page 128]  
   
 Internet-Draft        LinuxSampler Control Protocol        February 2008  
   
   
7356        "MAP MIDI_INSTRUMENT" (Section 6.7.7)        "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7357    
7358        "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)        "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
# Line 7204  Internet-Draft        LinuxSampler Contr Line 7388  Internet-Draft        LinuxSampler Contr
7388    
7389    
7390    
7391    Schoenebeck              Expires March 14, 2009               [Page 132]
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 Schoenebeck              Expires August 19, 2008              [Page 129]  
7392    
7393  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7394    
7395    
7396  8.  Events  8.  Events
# Line 7276  Internet-Draft        LinuxSampler Contr Line 7444  Internet-Draft        LinuxSampler Contr
7444    
7445    
7446    
7447  Schoenebeck              Expires August 19, 2008              [Page 130]  Schoenebeck              Expires March 14, 2009               [Page 133]
7448    
7449  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7450    
7451    
7452        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 7332  Internet-Draft        LinuxSampler Contr Line 7500  Internet-Draft        LinuxSampler Contr
7500    
7501    
7502    
7503  Schoenebeck              Expires August 19, 2008              [Page 131]  Schoenebeck              Expires March 14, 2009               [Page 134]
7504    
7505  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7506    
7507    
7508        "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"        "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"
# Line 7362  Internet-Draft        LinuxSampler Contr Line 7530  Internet-Draft        LinuxSampler Contr
7530     Server will start sending one of the the following notification     Server will start sending one of the the following notification
7531     messages:     messages:
7532    
7533        "NOTIFY:CHANNEL_MIDI:<device-id> <port-id> NOTE_ON <note>        "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note>
7534        <velocity>"        <velocity>"
7535    
7536        "NOTIFY:CHANNEL_MIDI:<device-id> <port-id> NOTE_OFF <note>        "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note>
7537        <velocity>"        <velocity>"
7538    
7539     where <device-id> <port-id> will be replaced by the IDs of the     where <device-id> <port-id> will be replaced by the IDs of the
# Line 7388  Internet-Draft        LinuxSampler Contr Line 7556  Internet-Draft        LinuxSampler Contr
7556    
7557    
7558    
7559  Schoenebeck              Expires August 19, 2008              [Page 132]  Schoenebeck              Expires March 14, 2009               [Page 135]
7560    
7561  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7562    
7563    
7564        SUBSCRIBE VOICE_COUNT        SUBSCRIBE VOICE_COUNT
# Line 7444  Internet-Draft        LinuxSampler Contr Line 7612  Internet-Draft        LinuxSampler Contr
7612    
7613    
7614    
7615  Schoenebeck              Expires August 19, 2008              [Page 133]  Schoenebeck              Expires March 14, 2009               [Page 136]
7616    
7617  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7618    
7619    
7620        SUBSCRIBE CHANNEL_INFO        SUBSCRIBE CHANNEL_INFO
# Line 7500  Internet-Draft        LinuxSampler Contr Line 7668  Internet-Draft        LinuxSampler Contr
7668    
7669    
7670    
7671  Schoenebeck              Expires August 19, 2008              [Page 134]  Schoenebeck              Expires March 14, 2009               [Page 137]
7672    
7673  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7674    
7675    
7676  8.14.  Total number of active voices changed  8.14.  Total number of active voices changed
# Line 7556  Internet-Draft        LinuxSampler Contr Line 7724  Internet-Draft        LinuxSampler Contr
7724    
7725    
7726    
7727  Schoenebeck              Expires August 19, 2008              [Page 135]  Schoenebeck              Expires March 14, 2009               [Page 138]
7728    
7729  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7730    
7731    
7732        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
# Line 7612  Internet-Draft        LinuxSampler Contr Line 7780  Internet-Draft        LinuxSampler Contr
7780    
7781    
7782    
7783  Schoenebeck              Expires August 19, 2008              [Page 136]  Schoenebeck              Expires March 14, 2009               [Page 139]
7784    
7785  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7786    
7787    
7788  8.20.  Global settings changed  8.20.  Global settings changed
# Line 7668  Internet-Draft        LinuxSampler Contr Line 7836  Internet-Draft        LinuxSampler Contr
7836    
7837    
7838    
7839  Schoenebeck              Expires August 19, 2008              [Page 137]  Schoenebeck              Expires March 14, 2009               [Page 140]
7840    
7841  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7842    
7843    
7844     directory info.  Because these messages will be triggered by LSCP     directory info.  Because these messages will be triggered by LSCP
# Line 7724  Internet-Draft        LinuxSampler Contr Line 7892  Internet-Draft        LinuxSampler Contr
7892    
7893    
7894    
7895  Schoenebeck              Expires August 19, 2008              [Page 138]  Schoenebeck              Expires March 14, 2009               [Page 141]
7896    
7897  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7898    
7899    
7900     sufficient here.     sufficient here.
# Line 7780  Internet-Draft        LinuxSampler Contr Line 7948  Internet-Draft        LinuxSampler Contr
7948    
7949    
7950    
7951  Schoenebeck              Expires August 19, 2008              [Page 139]  Schoenebeck              Expires March 14, 2009               [Page 142]
7952    
7953  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
7954    
7955    
7956  9.  Security Considerations  9.  Security Considerations
# Line 7836  Internet-Draft        LinuxSampler Contr Line 8004  Internet-Draft        LinuxSampler Contr
8004    
8005    
8006    
8007  Schoenebeck              Expires August 19, 2008              [Page 140]  Schoenebeck              Expires March 14, 2009               [Page 143]
8008    
8009  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
8010    
8011    
8012  10.  Acknowledgments  10.  Acknowledgments
# Line 7892  Internet-Draft        LinuxSampler Contr Line 8060  Internet-Draft        LinuxSampler Contr
8060    
8061    
8062    
8063  Schoenebeck              Expires August 19, 2008              [Page 141]  Schoenebeck              Expires March 14, 2009               [Page 144]
8064    
8065  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
8066    
8067    
8068  11.  References  11.  References
# Line 7948  Internet-Draft        LinuxSampler Contr Line 8116  Internet-Draft        LinuxSampler Contr
8116    
8117    
8118    
8119  Schoenebeck              Expires August 19, 2008              [Page 142]  Schoenebeck              Expires March 14, 2009               [Page 145]
8120    
8121  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
8122    
8123    
8124  Author's Address  Author's Address
# Line 8004  Author's Address Line 8172  Author's Address
8172    
8173    
8174    
8175  Schoenebeck              Expires August 19, 2008              [Page 143]  Schoenebeck              Expires March 14, 2009               [Page 146]
8176    
8177  Internet-Draft        LinuxSampler Control Protocol        February 2008  Internet-Draft        LinuxSampler Control Protocol       September 2008
8178    
8179    
8180  Full Copyright Statement  Full Copyright Statement
# Line 8060  Acknowledgment Line 8228  Acknowledgment
8228    
8229    
8230    
8231  Schoenebeck              Expires August 19, 2008              [Page 144]  Schoenebeck              Expires March 14, 2009               [Page 147]
8232    
   

Legend:
Removed from v.1696  
changed lines
  Added in v.1773

  ViewVC Help
Powered by ViewVC