/[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 1363 by schoenebeck, Sun Sep 30 21:51:14 2007 UTC revision 1390 by schoenebeck, Sun Oct 7 14:07:48 2007 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: March 4, 2008                                    September 2007  Expires: April 9, 2008                                   October 7, 2007
8    
9    
10                   LinuxSampler Control Protocol (draft)                   LinuxSampler Control Protocol (draft)
# 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 March 4, 2008.     This Internet-Draft will expire on April 9, 2008.
37    
38  Copyright Notice  Copyright Notice
39    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck               Expires March 4, 2008                 [Page 1]  Schoenebeck               Expires April 9, 2008                 [Page 1]
56    
57  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck               Expires March 4, 2008                 [Page 2]  Schoenebeck               Expires April 9, 2008                 [Page 2]
112    
113  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
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 164  Internet-Draft    LinuxSampler Control P Line 164  Internet-Draft    LinuxSampler Control P
164    
165    
166    
167  Schoenebeck               Expires March 4, 2008                 [Page 3]  Schoenebeck               Expires April 9, 2008                 [Page 3]
168    
169  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
170    
171    
172         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
# Line 180  Internet-Draft    LinuxSampler Control P Line 180  Internet-Draft    LinuxSampler Control P
180       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75
181         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76
182         6.7.2.  Delete one particular or all MIDI instrument maps . .  77         6.7.2.  Delete one particular or all MIDI instrument maps . .  77
183         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  78
184         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78
185         6.7.5.  Getting MIDI instrument map information . . . . . . .  78         6.7.5.  Getting MIDI instrument map information . . . . . . .  78
186         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79
187         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80
188         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  83
189         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
190                 instrument map  . . . . . . . . . . . . . . . . . . .  83                 instrument map  . . . . . . . . . . . . . . . . . . .  83
191         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84
192         6.7.11. Get current settings of MIDI instrument map entry . .  84         6.7.11. Get current settings of MIDI instrument map entry . .  85
193         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87
195         6.8.1.  Creating a new instrument directory . . . . . . . . .  87         6.8.1.  Creating a new instrument directory . . . . . . . . .  87
196         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88
197         6.8.3.  Getting amount of instrument directories  . . . . . .  88         6.8.3.  Getting amount of instrument directories  . . . . . .  89
198         6.8.4.  Listing all directories in specific directory . . . .  89         6.8.4.  Listing all directories in specific directory . . . .  89
199         6.8.5.  Getting instrument directory information  . . . . . .  89         6.8.5.  Getting instrument directory information  . . . . . .  90
200         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91
201         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91
202         6.8.8.  Copying instrument directories  . . . . . . . . . . .  92         6.8.8.  Copying instrument directories  . . . . . . . . . . .  92
203         6.8.9.  Changing the description of directory . . . . . . . .  92         6.8.9.  Changing the description of directory . . . . . . . .  93
204         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93
205         6.8.11. Adding instruments to the instruments database  . . .  94         6.8.11. Adding instruments to the instruments database  . . .  95
206         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96
207         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96         6.8.13. Getting amount of instruments . . . . . . . . . . . .  97
208         6.8.14. Listing all instruments in specific directory . . . .  97         6.8.14. Listing all instruments in specific directory . . . .  97
209         6.8.15. Getting instrument information  . . . . . . . . . . .  98         6.8.15. Getting instrument information  . . . . . . . . . . .  98
210         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100
211         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 101         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 101
212         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 101         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102
213         6.8.19. Changing the description of instrument  . . . . . . . 102         6.8.19. Changing the description of instrument  . . . . . . . 102
214         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103
215         6.8.21. Getting job status information  . . . . . . . . . . . 105         6.8.21. Getting job status information  . . . . . . . . . . . 105
216         6.8.22. Formatting the instruments database . . . . . . . . . 106         6.8.22. Formatting the instruments database . . . . . . . . . 106
217       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 106       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107
218         6.9.1.  Opening an appropriate instrument editor         6.9.1.  Opening an appropriate instrument editor
219                 application . . . . . . . . . . . . . . . . . . . . . 106                 application . . . . . . . . . . . . . . . . . . . . . 107
220    
221    
222    
223  Schoenebeck               Expires March 4, 2008                 [Page 4]  Schoenebeck               Expires April 9, 2008                 [Page 4]
224    
225  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
226    
227    
228     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 108     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 109
229       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 121       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 122
230     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 123     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
231       8.1.  Number of audio output devices changed  . . . . . . . . . 123       8.1.  Number of audio output devices changed  . . . . . . . . . 126
232       8.2.  Audio output device's settings changed  . . . . . . . . . 123       8.2.  Audio output device's settings changed  . . . . . . . . . 126
233       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 123       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 126
234       8.4.  MIDI input device's settings changed  . . . . . . . . . . 124       8.4.  MIDI input device's settings changed  . . . . . . . . . . 127
235       8.5.  Number of sampler channels changed  . . . . . . . . . . . 124       8.5.  Number of sampler channels changed  . . . . . . . . . . . 127
236       8.6.  Number of active voices changed . . . . . . . . . . . . . 124       8.6.  Number of active voices changed . . . . . . . . . . . . . 127
237       8.7.  Number of active disk streams changed . . . . . . . . . . 125       8.7.  Number of active disk streams changed . . . . . . . . . . 128
238       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 125       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 128
239       8.9.  Channel information changed . . . . . . . . . . . . . . . 125       8.9.  Channel information changed . . . . . . . . . . . . . . . 128
240       8.10. Number of effect sends changed  . . . . . . . . . . . . . 126       8.10. Number of effect sends changed  . . . . . . . . . . . . . 129
241       8.11. Effect send information changed . . . . . . . . . . . . . 126       8.11. Effect send information changed . . . . . . . . . . . . . 129
242       8.12. Total number of active voices changed . . . . . . . . . . 126       8.12. Total number of active voices changed . . . . . . . . . . 129
243       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 127       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 130
244       8.14. MIDI instrument map information changed . . . . . . . . . 127       8.14. MIDI instrument map information changed . . . . . . . . . 130
245       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 127       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 130
246       8.16. MIDI instrument information changed . . . . . . . . . . . 128       8.16. MIDI instrument information changed . . . . . . . . . . . 131
247       8.17. Global settings changed . . . . . . . . . . . . . . . . . 128       8.17. Global settings changed . . . . . . . . . . . . . . . . . 131
248       8.18. Number of database instrument directories changed . . . . 129       8.18. Number of database instrument directories changed . . . . 132
249       8.19. Database instrument directory information changed . . . . 129       8.19. Database instrument directory information changed . . . . 132
250       8.20. Number of database instruments changed  . . . . . . . . . 130       8.20. Number of database instruments changed  . . . . . . . . . 133
251       8.21. Database instrument information changed . . . . . . . . . 130       8.21. Database instrument information changed . . . . . . . . . 133
252       8.22. Database job status information changed . . . . . . . . . 131       8.22. Database job status information changed . . . . . . . . . 134
253       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 131       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 134
254     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 132     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 135
255     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 133     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 136
256     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 134     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 137
257     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 135     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 138
258     Intellectual Property and Copyright Statements  . . . . . . . . . 136     Intellectual Property and Copyright Statements  . . . . . . . . . 139
259    
260    
261    
# Line 276  Internet-Draft    LinuxSampler Control P Line 276  Internet-Draft    LinuxSampler Control P
276    
277    
278    
279  Schoenebeck               Expires March 4, 2008                 [Page 5]  Schoenebeck               Expires April 9, 2008                 [Page 5]
280    
281  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft    LinuxSampler Control P Line 332  Internet-Draft    LinuxSampler Control P
332    
333    
334    
335  Schoenebeck               Expires March 4, 2008                 [Page 6]  Schoenebeck               Expires April 9, 2008                 [Page 6]
336    
337  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 388  Internet-Draft    LinuxSampler Control P Line 388  Internet-Draft    LinuxSampler Control P
388    
389    
390    
391  Schoenebeck               Expires March 4, 2008                 [Page 7]  Schoenebeck               Expires April 9, 2008                 [Page 7]
392    
393  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft    LinuxSampler Control P Line 444  Internet-Draft    LinuxSampler Control P
444    
445    
446    
447  Schoenebeck               Expires March 4, 2008                 [Page 8]  Schoenebeck               Expires April 9, 2008                 [Page 8]
448    
449  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft    LinuxSampler Control P Line 500  Internet-Draft    LinuxSampler Control P
500    
501    
502    
503  Schoenebeck               Expires March 4, 2008                 [Page 9]  Schoenebeck               Expires April 9, 2008                 [Page 9]
504    
505  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft    LinuxSampler Control P Line 556  Internet-Draft    LinuxSampler Control P
556    
557    
558    
559  Schoenebeck               Expires March 4, 2008                [Page 10]  Schoenebeck               Expires April 9, 2008                [Page 10]
560    
561  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft    LinuxSampler Control P Line 612  Internet-Draft    LinuxSampler Control P
612    
613    
614    
615  Schoenebeck               Expires March 4, 2008                [Page 11]  Schoenebeck               Expires April 9, 2008                [Page 11]
616    
617  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft    LinuxSampler Control P Line 668  Internet-Draft    LinuxSampler Control P
668    
669    
670    
671  Schoenebeck               Expires March 4, 2008                [Page 12]  Schoenebeck               Expires April 9, 2008                [Page 12]
672    
673  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft    LinuxSampler Control P Line 724  Internet-Draft    LinuxSampler Control P
724    
725    
726    
727  Schoenebeck               Expires March 4, 2008                [Page 13]  Schoenebeck               Expires April 9, 2008                [Page 13]
728    
729  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft    LinuxSampler Control P Line 780  Internet-Draft    LinuxSampler Control P
780    
781    
782    
783  Schoenebeck               Expires March 4, 2008                [Page 14]  Schoenebeck               Expires April 9, 2008                [Page 14]
784    
785  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft    LinuxSampler Control P Line 836  Internet-Draft    LinuxSampler Control P
836    
837    
838    
839  Schoenebeck               Expires March 4, 2008                [Page 15]  Schoenebeck               Expires April 9, 2008                [Page 15]
840    
841  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft    LinuxSampler Control P Line 892  Internet-Draft    LinuxSampler Control P
892    
893    
894    
895  Schoenebeck               Expires March 4, 2008                [Page 16]  Schoenebeck               Expires April 9, 2008                [Page 16]
896    
897  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft    LinuxSampler Control P Line 948  Internet-Draft    LinuxSampler Control P
948    
949    
950    
951  Schoenebeck               Expires March 4, 2008                [Page 17]  Schoenebeck               Expires April 9, 2008                [Page 17]
952    
953  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft    LinuxSampler Control P Line 1004  Internet-Draft    LinuxSampler Control P
1004    
1005    
1006    
1007  Schoenebeck               Expires March 4, 2008                [Page 18]  Schoenebeck               Expires April 9, 2008                [Page 18]
1008    
1009  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft    LinuxSampler Control P Line 1060  Internet-Draft    LinuxSampler Control P
1060    
1061    
1062    
1063  Schoenebeck               Expires March 4, 2008                [Page 19]  Schoenebeck               Expires April 9, 2008                [Page 19]
1064    
1065  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft    LinuxSampler Control P Line 1116  Internet-Draft    LinuxSampler Control P
1116    
1117    
1118    
1119  Schoenebeck               Expires March 4, 2008                [Page 20]  Schoenebeck               Expires April 9, 2008                [Page 20]
1120    
1121  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft    LinuxSampler Control P Line 1172  Internet-Draft    LinuxSampler Control P
1172    
1173    
1174    
1175  Schoenebeck               Expires March 4, 2008                [Page 21]  Schoenebeck               Expires April 9, 2008                [Page 21]
1176    
1177  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft    LinuxSampler Control P Line 1228  Internet-Draft    LinuxSampler Control P
1228    
1229    
1230    
1231  Schoenebeck               Expires March 4, 2008                [Page 22]  Schoenebeck               Expires April 9, 2008                [Page 22]
1232    
1233  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft    LinuxSampler Control P Line 1284  Internet-Draft    LinuxSampler Control P
1284    
1285    
1286    
1287  Schoenebeck               Expires March 4, 2008                [Page 23]  Schoenebeck               Expires April 9, 2008                [Page 23]
1288    
1289  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft    LinuxSampler Control P Line 1340  Internet-Draft    LinuxSampler Control P
1340    
1341    
1342    
1343  Schoenebeck               Expires March 4, 2008                [Page 24]  Schoenebeck               Expires April 9, 2008                [Page 24]
1344    
1345  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft    LinuxSampler Control P Line 1396  Internet-Draft    LinuxSampler Control P
1396    
1397    
1398    
1399  Schoenebeck               Expires March 4, 2008                [Page 25]  Schoenebeck               Expires April 9, 2008                [Page 25]
1400    
1401  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
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 Control P Line 1452  Internet-Draft    LinuxSampler Control P
1452    
1453    
1454    
1455  Schoenebeck               Expires March 4, 2008                [Page 26]  Schoenebeck               Expires April 9, 2008                [Page 26]
1456    
1457  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft    LinuxSampler Control P Line 1508  Internet-Draft    LinuxSampler Control P
1508    
1509    
1510    
1511  Schoenebeck               Expires March 4, 2008                [Page 27]  Schoenebeck               Expires April 9, 2008                [Page 27]
1512    
1513  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft    LinuxSampler Control P Line 1564  Internet-Draft    LinuxSampler Control P
1564    
1565    
1566    
1567  Schoenebeck               Expires March 4, 2008                [Page 28]  Schoenebeck               Expires April 9, 2008                [Page 28]
1568    
1569  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft    LinuxSampler Control P Line 1620  Internet-Draft    LinuxSampler Control P
1620    
1621    
1622    
1623  Schoenebeck               Expires March 4, 2008                [Page 29]  Schoenebeck               Expires April 9, 2008                [Page 29]
1624    
1625  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft    LinuxSampler Control P Line 1676  Internet-Draft    LinuxSampler Control P
1676    
1677    
1678    
1679  Schoenebeck               Expires March 4, 2008                [Page 30]  Schoenebeck               Expires April 9, 2008                [Page 30]
1680    
1681  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
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 Control P Line 1732  Internet-Draft    LinuxSampler Control P
1732    
1733    
1734    
1735  Schoenebeck               Expires March 4, 2008                [Page 31]  Schoenebeck               Expires April 9, 2008                [Page 31]
1736    
1737  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft    LinuxSampler Control P Line 1788  Internet-Draft    LinuxSampler Control P
1788    
1789    
1790    
1791  Schoenebeck               Expires March 4, 2008                [Page 32]  Schoenebeck               Expires April 9, 2008                [Page 32]
1792    
1793  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft    LinuxSampler Control P Line 1844  Internet-Draft    LinuxSampler Control P
1844    
1845    
1846    
1847  Schoenebeck               Expires March 4, 2008                [Page 33]  Schoenebeck               Expires April 9, 2008                [Page 33]
1848    
1849  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft    LinuxSampler Control P Line 1900  Internet-Draft    LinuxSampler Control P
1900    
1901    
1902    
1903  Schoenebeck               Expires March 4, 2008                [Page 34]  Schoenebeck               Expires April 9, 2008                [Page 34]
1904    
1905  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft    LinuxSampler Control P Line 1956  Internet-Draft    LinuxSampler Control P
1956    
1957    
1958    
1959  Schoenebeck               Expires March 4, 2008                [Page 35]  Schoenebeck               Expires April 9, 2008                [Page 35]
1960    
1961  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft    LinuxSampler Control P Line 2012  Internet-Draft    LinuxSampler Control P
2012    
2013    
2014    
2015  Schoenebeck               Expires March 4, 2008                [Page 36]  Schoenebeck               Expires April 9, 2008                [Page 36]
2016    
2017  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft    LinuxSampler Control P Line 2068  Internet-Draft    LinuxSampler Control P
2068    
2069    
2070    
2071  Schoenebeck               Expires March 4, 2008                [Page 37]  Schoenebeck               Expires April 9, 2008                [Page 37]
2072    
2073  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft    LinuxSampler Control P Line 2124  Internet-Draft    LinuxSampler Control P
2124    
2125    
2126    
2127  Schoenebeck               Expires March 4, 2008                [Page 38]  Schoenebeck               Expires April 9, 2008                [Page 38]
2128    
2129  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft    LinuxSampler Control P Line 2180  Internet-Draft    LinuxSampler Control P
2180    
2181    
2182    
2183  Schoenebeck               Expires March 4, 2008                [Page 39]  Schoenebeck               Expires April 9, 2008                [Page 39]
2184    
2185  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft    LinuxSampler Control P Line 2236  Internet-Draft    LinuxSampler Control P
2236    
2237    
2238    
2239  Schoenebeck               Expires March 4, 2008                [Page 40]  Schoenebeck               Expires April 9, 2008                [Page 40]
2240    
2241  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
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 Control P Line 2292  Internet-Draft    LinuxSampler Control P
2292    
2293    
2294    
2295  Schoenebeck               Expires March 4, 2008                [Page 41]  Schoenebeck               Expires April 9, 2008                [Page 41]
2296    
2297  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2348  Internet-Draft    LinuxSampler Control P Line 2348  Internet-Draft    LinuxSampler Control P
2348    
2349    
2350    
2351  Schoenebeck               Expires March 4, 2008                [Page 42]  Schoenebeck               Expires April 9, 2008                [Page 42]
2352    
2353  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2354    
2355    
2356        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft    LinuxSampler Control P Line 2404  Internet-Draft    LinuxSampler Control P
2404    
2405    
2406    
2407  Schoenebeck               Expires March 4, 2008                [Page 43]  Schoenebeck               Expires April 9, 2008                [Page 43]
2408    
2409  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2410    
2411    
2412     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 2460  Internet-Draft    LinuxSampler Control P Line 2460  Internet-Draft    LinuxSampler Control P
2460    
2461    
2462    
2463  Schoenebeck               Expires March 4, 2008                [Page 44]  Schoenebeck               Expires April 9, 2008                [Page 44]
2464    
2465  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2466    
2467    
2468        "OK" -        "OK" -
# Line 2516  Internet-Draft    LinuxSampler Control P Line 2516  Internet-Draft    LinuxSampler Control P
2516    
2517    
2518    
2519  Schoenebeck               Expires March 4, 2008                [Page 45]  Schoenebeck               Expires April 9, 2008                [Page 45]
2520    
2521  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2522    
2523    
2524        LinuxSampler will answer by returning a comma separated list with        LinuxSampler will answer by returning a comma separated list with
# Line 2572  Internet-Draft    LinuxSampler Control P Line 2572  Internet-Draft    LinuxSampler Control P
2572    
2573    
2574    
2575  Schoenebeck               Expires March 4, 2008                [Page 46]  Schoenebeck               Expires April 9, 2008                [Page 46]
2576    
2577  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2578    
2579    
2580    
# Line 2628  Internet-Draft    LinuxSampler Control P Line 2628  Internet-Draft    LinuxSampler Control P
2628    
2629    
2630    
2631  Schoenebeck               Expires March 4, 2008                [Page 47]  Schoenebeck               Expires April 9, 2008                [Page 47]
2632    
2633  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2634    
2635    
2636        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
# Line 2684  Internet-Draft    LinuxSampler Control P Line 2684  Internet-Draft    LinuxSampler Control P
2684    
2685    
2686    
2687  Schoenebeck               Expires March 4, 2008                [Page 48]  Schoenebeck               Expires April 9, 2008                [Page 48]
2688    
2689  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2690    
2691    
2692           VERSION -           VERSION -
# Line 2740  Internet-Draft    LinuxSampler Control P Line 2740  Internet-Draft    LinuxSampler Control P
2740    
2741    
2742    
2743  Schoenebeck               Expires March 4, 2008                [Page 49]  Schoenebeck               Expires April 9, 2008                [Page 49]
2744    
2745  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2746    
2747    
2748              sampler channel              sampler channel
# Line 2796  Internet-Draft    LinuxSampler Control P Line 2796  Internet-Draft    LinuxSampler Control P
2796    
2797    
2798    
2799  Schoenebeck               Expires March 4, 2008                [Page 50]  Schoenebeck               Expires April 9, 2008                [Page 50]
2800    
2801  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2802    
2803    
2804           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
# Line 2852  Internet-Draft    LinuxSampler Control P Line 2852  Internet-Draft    LinuxSampler Control P
2852    
2853    
2854    
2855  Schoenebeck               Expires March 4, 2008                [Page 51]  Schoenebeck               Expires April 9, 2008                [Page 51]
2856    
2857  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2858    
2859    
2860           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
# Line 2908  Internet-Draft    LinuxSampler Control P Line 2908  Internet-Draft    LinuxSampler Control P
2908    
2909    
2910    
2911  Schoenebeck               Expires March 4, 2008                [Page 52]  Schoenebeck               Expires April 9, 2008                [Page 52]
2912    
2913  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2914    
2915    
2916  6.4.12.  Current number of active disk streams  6.4.12.  Current number of active disk streams
# Line 2964  Internet-Draft    LinuxSampler Control P Line 2964  Internet-Draft    LinuxSampler Control P
2964    
2965    
2966    
2967  Schoenebeck               Expires March 4, 2008                [Page 53]  Schoenebeck               Expires April 9, 2008                [Page 53]
2968    
2969  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2970    
2971    
2972        the response are not in particular order, thus the front-end has        the response are not in particular order, thus the front-end has
# Line 3020  Internet-Draft    LinuxSampler Control P Line 3020  Internet-Draft    LinuxSampler Control P
3020    
3021    
3022    
3023  Schoenebeck               Expires March 4, 2008                [Page 54]  Schoenebeck               Expires April 9, 2008                [Page 54]
3024    
3025  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3026    
3027    
3028     Examples:     Examples:
# Line 3076  Internet-Draft    LinuxSampler Control P Line 3076  Internet-Draft    LinuxSampler Control P
3076    
3077    
3078    
3079  Schoenebeck               Expires March 4, 2008                [Page 55]  Schoenebeck               Expires April 9, 2008                [Page 55]
3080    
3081  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3082    
3083    
3084     command, <audio-out> is the numerical ID of the sampler channel's     command, <audio-out> is the numerical ID of the sampler channel's
# Line 3132  Internet-Draft    LinuxSampler Control P Line 3132  Internet-Draft    LinuxSampler Control P
3132    
3133    
3134    
3135  Schoenebeck               Expires March 4, 2008                [Page 56]  Schoenebeck               Expires April 9, 2008                [Page 56]
3136    
3137  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3138    
3139    
3140           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
# Line 3188  Internet-Draft    LinuxSampler Control P Line 3188  Internet-Draft    LinuxSampler Control P
3188    
3189    
3190    
3191  Schoenebeck               Expires March 4, 2008                [Page 57]  Schoenebeck               Expires April 9, 2008                [Page 57]
3192    
3193  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3194    
3195    
3196  6.4.19.  Setting MIDI input port  6.4.19.  Setting MIDI input port
# Line 3244  Internet-Draft    LinuxSampler Control P Line 3244  Internet-Draft    LinuxSampler Control P
3244    
3245    
3246    
3247  Schoenebeck               Expires March 4, 2008                [Page 58]  Schoenebeck               Expires April 9, 2008                [Page 58]
3248    
3249  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3250    
3251    
3252        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3300  Internet-Draft    LinuxSampler Control P Line 3300  Internet-Draft    LinuxSampler Control P
3300    
3301    
3302    
3303  Schoenebeck               Expires March 4, 2008                [Page 59]  Schoenebeck               Expires April 9, 2008                [Page 59]
3304    
3305  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3306    
3307    
3308    
# Line 3356  Internet-Draft    LinuxSampler Control P Line 3356  Internet-Draft    LinuxSampler Control P
3356    
3357    
3358    
3359  Schoenebeck               Expires March 4, 2008                [Page 60]  Schoenebeck               Expires April 9, 2008                [Page 60]
3360    
3361  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3362    
3363    
3364        "OK" -        "OK" -
# Line 3412  Internet-Draft    LinuxSampler Control P Line 3412  Internet-Draft    LinuxSampler Control P
3412    
3413    
3414    
3415  Schoenebeck               Expires March 4, 2008                [Page 61]  Schoenebeck               Expires April 9, 2008                [Page 61]
3416    
3417  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3418    
3419    
3420           would fall back to "NONE".           would fall back to "NONE".
# Line 3450  Internet-Draft    LinuxSampler Control P Line 3450  Internet-Draft    LinuxSampler Control P
3450     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3451     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3452     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3453     effect send entity.  The name does not have to be unique.     effect send entity.  The name does not have to be unique, but MUST be
3454       encapsulated into apostrophes and supports escape sequences as
3455       described in chapter "Character Set and Escape Sequences
3456       (Section 7.1)".
3457    
3458     By default, that is as initial routing, the effect send's audio     By default, that is as initial routing, the effect send's audio
3459     channels are automatically routed to the last audio channels of the     channels are automatically routed to the last audio channels of the
# Line 3462  Internet-Draft    LinuxSampler Control P Line 3465  Internet-Draft    LinuxSampler Control P
3465     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3466    
3467     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
    because having effect sends on a sampler channel will decrease  
    runtime performance, because for implementing channel effect sends,  
    separate (sampler channel local) audio buffers are needed to render  
3468    
3469    
3470    
3471  Schoenebeck               Expires March 4, 2008                [Page 62]  Schoenebeck               Expires April 9, 2008                [Page 62]
3472    
3473  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3474    
3475    
3476       because having effect sends on a sampler channel will decrease
3477       runtime performance, because for implementing channel effect sends,
3478       separate (sampler channel local) audio buffers are needed to render
3479     and mix the voices and route the audio signal afterwards to the     and mix the voices and route the audio signal afterwards to the
3480     master outputs and effect send outputs (along with their respective     master outputs and effect send outputs (along with their respective
3481     effect send levels).  A sampler channel without effect sends however     effect send levels).  A sampler channel without effect sends however
# Line 3518  Internet-Draft    LinuxSampler Control P Line 3521  Internet-Draft    LinuxSampler Control P
3521    
3522     Possible Answers:     Possible Answers:
3523    
       "OK" -  
   
3524    
3525    
3526    
3527    Schoenebeck               Expires April 9, 2008                [Page 63]
 Schoenebeck               Expires March 4, 2008                [Page 63]  
3528    
3529  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3530    
3531    
3532          "OK" -
3533    
3534           on success           on success
3535    
# Line 3575  Internet-Draft    LinuxSampler Control P Line 3577  Internet-Draft    LinuxSampler Control P
3577     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3578     (Section 6.4.4) command.     (Section 6.4.4) command.
3579    
    Possible Answers:  
   
3580    
3581    
3582    
3583  Schoenebeck               Expires March 4, 2008                [Page 64]  Schoenebeck               Expires April 9, 2008                [Page 64]
3584    
3585  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3586    
3587    
3588       Possible Answers:
3589    
3590        The sampler will answer by returning a comma separated list with        The sampler will answer by returning a comma separated list with
3591        all effect sends' numerical IDs on the given sampler channel.        all effect sends' numerical IDs on the given sampler channel.
# Line 3630  Internet-Draft    LinuxSampler Control P Line 3632  Internet-Draft    LinuxSampler Control P
3632              a value between 0 and 127 reflecting the MIDI controller              a value between 0 and 127 reflecting the MIDI controller
3633              which is able to modify the effect send's send level              which is able to modify the effect send's send level
3634    
          LEVEL -  
   
3635    
3636    
3637    
3638    
3639  Schoenebeck               Expires March 4, 2008                [Page 65]  Schoenebeck               Expires April 9, 2008                [Page 65]
3640    
3641  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3642    
3643    
3644             LEVEL -
3645    
3646              optionally dotted number reflecting the effect send's              optionally dotted number reflecting the effect send's
3647              current send level (where a value < 1.0 means attenuation              current send level (where a value < 1.0 means attenuation
# Line 3683  Internet-Draft    LinuxSampler Control P Line 3685  Internet-Draft    LinuxSampler Control P
3685     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3686     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3687     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3688     effect send entity, which does not have to be unique.     effect send entity, which does not have to be unique (name MUST be
3689       encapsulated into apostrophes and supports escape sequences as
3690     Possible Answers:     described in chapter "Character Set and Escape Sequences
3691       (Section 7.1)").
   
   
3692    
3693    
3694    
3695  Schoenebeck               Expires March 4, 2008                [Page 66]  Schoenebeck               Expires April 9, 2008                [Page 66]
3696    
3697  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3698    
3699    
3700       Possible Answers:
3701    
3702        "OK" -        "OK" -
3703    
3704           on success           on success
# Line 3746  Internet-Draft    LinuxSampler Control P Line 3748  Internet-Draft    LinuxSampler Control P
3748    
3749    
3750    
3751    Schoenebeck               Expires April 9, 2008                [Page 67]
   
 Schoenebeck               Expires March 4, 2008                [Page 67]  
3752    
3753  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3754    
3755    
3756        "OK" -        "OK" -
# Line 3804  Internet-Draft    LinuxSampler Control P Line 3804  Internet-Draft    LinuxSampler Control P
3804    
3805    
3806    
3807  Schoenebeck               Expires March 4, 2008                [Page 68]  Schoenebeck               Expires April 9, 2008                [Page 68]
3808    
3809  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3810    
3811    
3812        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3860  Internet-Draft    LinuxSampler Control P Line 3860  Internet-Draft    LinuxSampler Control P
3860    
3861    
3862    
3863  Schoenebeck               Expires March 4, 2008                [Page 69]  Schoenebeck               Expires April 9, 2008                [Page 69]
3864    
3865  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3866    
3867    
3868        C: "SET FX_SEND LEVEL 0 0 0.15"        C: "SET FX_SEND LEVEL 0 0 0.15"
# Line 3916  Internet-Draft    LinuxSampler Control P Line 3916  Internet-Draft    LinuxSampler Control P
3916    
3917    
3918    
3919  Schoenebeck               Expires March 4, 2008                [Page 70]  Schoenebeck               Expires April 9, 2008                [Page 70]
3920    
3921  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3922    
3923    
3924        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
# Line 3972  Internet-Draft    LinuxSampler Control P Line 3972  Internet-Draft    LinuxSampler Control P
3972    
3973    
3974    
3975  Schoenebeck               Expires March 4, 2008                [Page 71]  Schoenebeck               Expires April 9, 2008                [Page 71]
3976    
3977  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3978    
3979    
3980        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 4028  Internet-Draft    LinuxSampler Control P Line 4028  Internet-Draft    LinuxSampler Control P
4028    
4029    
4030    
4031  Schoenebeck               Expires March 4, 2008                [Page 72]  Schoenebeck               Expires April 9, 2008                [Page 72]
4032    
4033  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4034    
4035    
4036  6.6.  Global commands  6.6.  Global commands
# Line 4084  Internet-Draft    LinuxSampler Control P Line 4084  Internet-Draft    LinuxSampler Control P
4084    
4085    
4086    
4087  Schoenebeck               Expires March 4, 2008                [Page 73]  Schoenebeck               Expires April 9, 2008                [Page 73]
4088    
4089  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4090    
4091    
4092  6.6.4.  General sampler informations  6.6.4.  General sampler informations
# Line 4108  Internet-Draft    LinuxSampler Control P Line 4108  Internet-Draft    LinuxSampler Control P
4108    
4109           DESCRIPTION -           DESCRIPTION -
4110    
4111              arbitrary textual description about the sampler              arbitrary textual description about the sampler (note that
4112                the character string may contain escape sequences
4113                (Section 7.1))
4114    
4115           VERSION -           VERSION -
4116    
# Line 4138  Internet-Draft    LinuxSampler Control P Line 4140  Internet-Draft    LinuxSampler Control P
4140    
4141    
4142    
4143    Schoenebeck               Expires April 9, 2008                [Page 74]
   
 Schoenebeck               Expires March 4, 2008                [Page 74]  
4144    
4145  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4146    
4147    
4148        The sampler will always answer by returning the optional dotted        The sampler will always answer by returning the optional dotted
# Line 4196  Internet-Draft    LinuxSampler Control P Line 4196  Internet-Draft    LinuxSampler Control P
4196    
4197    
4198    
4199  Schoenebeck               Expires March 4, 2008                [Page 75]  Schoenebeck               Expires April 9, 2008                [Page 75]
4200    
4201  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4202    
4203    
4204     By default, that is when the sampler is launched, there is no map,     By default, that is when the sampler is launched, there is no map,
# Line 4227  Internet-Draft    LinuxSampler Control P Line 4227  Internet-Draft    LinuxSampler Control P
4227        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4228    
4229     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
4230     to the new map.  MIDI instrument Map names do not have to be unique.     to the new map.  MIDI instrument Map names do not have to be unique,
4231       but MUST be encapsulated into apostrophes and support escape
4232       sequences as described in chapter "Character Set and Escape Sequences
4233       (Section 7.1)".
4234    
4235     Possible Answers:     Possible Answers:
4236    
# Line 4245  Internet-Draft    LinuxSampler Control P Line 4248  Internet-Draft    LinuxSampler Control P
4248    
4249        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4250    
       S: "OK[0]"  
   
   
4251    
4252    
4253    
4254    
4255  Schoenebeck               Expires March 4, 2008                [Page 76]  Schoenebeck               Expires April 9, 2008                [Page 76]
4256    
4257  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4258    
4259    
4260          S: "OK[0]"
4261    
4262        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4263    
4264        S: "OK[1]"        S: "OK[1]"
# Line 4300  Internet-Draft    LinuxSampler Control P Line 4302  Internet-Draft    LinuxSampler Control P
4302    
4303        S: "OK"        S: "OK"
4304    
 6.7.3.  Get amount of existing MIDI instrument maps  
4305    
    The front-end can retrieve the current amount of MIDI instrument maps  
    by sending the following command:  
4306    
4307    
4308    
4309    
4310  Schoenebeck               Expires March 4, 2008                [Page 77]  
4311    Schoenebeck               Expires April 9, 2008                [Page 77]
4312    
4313  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4314    
4315    
4316    6.7.3.  Get amount of existing MIDI instrument maps
4317    
4318       The front-end can retrieve the current amount of MIDI instrument maps
4319       by sending the following command:
4320    
4321        GET MIDI_INSTRUMENT_MAPS        GET MIDI_INSTRUMENT_MAPS
4322    
4323     Possible Answers:     Possible Answers:
# Line 4356  Internet-Draft    LinuxSampler Control P Line 4361  Internet-Draft    LinuxSampler Control P
4361     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4362     (Section 6.7.4) command.     (Section 6.7.4) command.
4363    
    Possible Answers:  
   
       LinuxSampler will answer by sending a <CRLF> separated list.  Each  
       answer line begins with the settings category name followed by a  
       colon and then a space character <SP> and finally the info  
4364    
4365    
4366    
4367  Schoenebeck               Expires March 4, 2008                [Page 78]  Schoenebeck               Expires April 9, 2008                [Page 78]
4368    
4369  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4370    
4371    
4372       Possible Answers:
4373    
4374          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4375          answer line begins with the settings category name followed by a
4376          colon and then a space character <SP> and finally the info
4377        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
4378        following categories are defined:        following categories are defined:
4379    
# Line 4404  Internet-Draft    LinuxSampler Control P Line 4409  Internet-Draft    LinuxSampler Control P
4409        SET MIDI_INSTRUMENT_MAP NAME <map> <name>        SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4410    
4411     Where <map> is the numerical ID of the map and <name> the new custom     Where <map> is the numerical ID of the map and <name> the new custom
4412     name of the map, which does not have to be unique.     name of the map, which does not have to be unique (name MUST be
4413       encapsulated into apostrophes and supports escape sequences as
4414       described in chapter "Character Set and Escape Sequences
4415       (Section 7.1)").
4416    
4417     Possible Answers:     Possible Answers:
4418    
4419    
4420    
4421    
4422    
4423    Schoenebeck               Expires April 9, 2008                [Page 79]
4424    
4425    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4426    
4427    
4428        "OK" -        "OK" -
4429    
4430           on success           on success
# Line 4418  Internet-Draft    LinuxSampler Control P Line 4435  Internet-Draft    LinuxSampler Control P
4435    
4436     Example:     Example:
4437    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 79]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4438        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4439    
4440        S: "OK"        S: "OK"
# Line 4464  Internet-Draft    LinuxSampler Control P Line 4474  Internet-Draft    LinuxSampler Control P
4474           be freed from memory when not needed by any sampler channel           be freed from memory when not needed by any sampler channel
4475           anymore.           anymore.
4476    
4477    
4478    
4479    Schoenebeck               Expires April 9, 2008                [Page 80]
4480    
4481    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4482    
4483    
4484        "ON_DEMAND_HOLD" -        "ON_DEMAND_HOLD" -
4485    
4486           The instrument will be loaded when needed, that is when           The instrument will be loaded when needed, that is when
# Line 4474  Internet-Draft    LinuxSampler Control P Line 4491  Internet-Draft    LinuxSampler Control P
4491           instrument) are explicitly changed to "ON_DEMAND" and no           instrument) are explicitly changed to "ON_DEMAND" and no
4492           sampler channel is using the instrument anymore.           sampler channel is using the instrument anymore.
4493    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 80]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4494        "PERSISTENT" -        "PERSISTENT" -
4495    
4496           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
# Line 4515  Internet-Draft    LinuxSampler Control P Line 4525  Internet-Draft    LinuxSampler Control P
4525     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4526     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4527     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4528     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes, supporting escape sequences as described in chapter
4529     displaying an appropriate name for mapped instruments (using "GET     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4530     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     entry, useful for frontends for displaying an appropriate name for
4531       mapped instruments (using "GET MIDI_INSTRUMENT INFO"
4532    
4533    
4534    
4535    Schoenebeck               Expires April 9, 2008                [Page 81]
4536    
4537    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4538    
4539    
4540       (Section 6.7.11)).
4541    
4542     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4543     completely established in the sampler.  The OPTIONAL "NON_MODAL"     completely established in the sampler.  The OPTIONAL "NON_MODAL"
# Line 4529  Internet-Draft    LinuxSampler Control P Line 4549  Internet-Draft    LinuxSampler Control P
4549     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4550     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4551     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 81]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4552     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4553     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4554     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4573  Internet-Draft    LinuxSampler Control P Line 4585  Internet-Draft    LinuxSampler Control P
4585        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4586        'Silent Piano'"        'Silent Piano'"
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires April 9, 2008                [Page 82]
4592    
4593    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4594    
4595    
4596        S: "OK"        S: "OK"
4597    
4598        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
# Line 4585  Internet-Draft    LinuxSampler Control P Line 4605  Internet-Draft    LinuxSampler Control P
4605     The front-end can query the amount of currently existing entries in a     The front-end can query the amount of currently existing entries in a
4606     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4607    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 82]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4608        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
4609    
4610     The front-end can query the amount of currently existing entries in     The front-end can query the amount of currently existing entries in
# Line 4627  Internet-Draft    LinuxSampler Control P Line 4639  Internet-Draft    LinuxSampler Control P
4639     The front-end can query a list of all currently existing entries of     The front-end can query a list of all currently existing entries of
4640     all MIDI instrument maps by sending the following command:     all MIDI instrument maps by sending the following command:
4641    
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires April 9, 2008                [Page 83]
4648    
4649    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4650    
4651    
4652        LIST MIDI_INSTRUMENTS ALL        LIST MIDI_INSTRUMENTS ALL
4653    
4654     Possible Answers:     Possible Answers:
# Line 4641  Internet-Draft    LinuxSampler Control P Line 4663  Internet-Draft    LinuxSampler Control P
4663    
4664     Example:     Example:
4665    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 83]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4666        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
4667    
4668        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
# Line 4681  Internet-Draft    LinuxSampler Control P Line 4695  Internet-Draft    LinuxSampler Control P
4695    
4696        S: "OK"        S: "OK"
4697    
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires April 9, 2008                [Page 84]
4704    
4705    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4706    
4707    
4708  6.7.11.  Get current settings of MIDI instrument map entry  6.7.11.  Get current settings of MIDI instrument map entry
4709    
4710     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
# Line 4696  Internet-Draft    LinuxSampler Control P Line 4720  Internet-Draft    LinuxSampler Control P
4720    
4721     Possible Answers:     Possible Answers:
4722    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 84]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4723        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4724        answer line begins with the information category name followed by        answer line begins with the information category name followed by
4725        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 4737  Internet-Draft    LinuxSampler Control P Line 4752  Internet-Draft    LinuxSampler Control P
4752           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4753           cannot be changed.           cannot be changed.
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires April 9, 2008                [Page 85]
4760    
4761    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4762    
4763    
4764        "LOAD_MODE" -        "LOAD_MODE" -
4765    
4766           Life time of instrument (see "MAP MIDI_INSTRUMENT"           Life time of instrument (see "MAP MIDI_INSTRUMENT"
# Line 4752  Internet-Draft    LinuxSampler Control P Line 4776  Internet-Draft    LinuxSampler Control P
4776    
4777     Example:     Example:
4778    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 85]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4779        C: "GET MIDI_INSTRUMENT INFO 1 45 120"        C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4780    
4781        S: "NAME: Drums for Foo Song"        S: "NAME: Drums for Foo Song"
# Line 4794  Internet-Draft    LinuxSampler Control P Line 4809  Internet-Draft    LinuxSampler Control P
4809        CLEAR MIDI_INSTRUMENTS ALL        CLEAR MIDI_INSTRUMENTS ALL
4810    
4811     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4812    
4813    
4814    
4815    Schoenebeck               Expires April 9, 2008                [Page 86]
4816    
4817    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4818    
4819    
4820     only their entries, thus the map's settings like custom name will be     only their entries, thus the map's settings like custom name will be
4821     preservevd.     preservevd.
4822    
# Line 4809  Internet-Draft    LinuxSampler Control P Line 4832  Internet-Draft    LinuxSampler Control P
4832    
4833        S: "OK"        S: "OK"
4834    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 86]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4835        C: "CLEAR MIDI_INSTRUMENTS ALL"        C: "CLEAR MIDI_INSTRUMENTS ALL"
4836    
4837        S: "OK"        S: "OK"
# Line 4848  Internet-Draft    LinuxSampler Control P Line 4863  Internet-Draft    LinuxSampler Control P
4863    
4864     Possible Answers:     Possible Answers:
4865    
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires April 9, 2008                [Page 87]
4872    
4873    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4874    
4875    
4876        "OK" -        "OK" -
4877    
4878           on success           on success
# Line 4864  Internet-Draft    LinuxSampler Control P Line 4889  Internet-Draft    LinuxSampler Control P
4889    
4890        S: "OK"        S: "OK"
4891    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 87]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4892  6.8.2.  Deleting an instrument directory  6.8.2.  Deleting an instrument directory
4893    
4894     The front-end can delete a particular instrument directory from the     The front-end can delete a particular instrument directory from the
# Line 4901  Internet-Draft    LinuxSampler Control P Line 4917  Internet-Draft    LinuxSampler Control P
4917    
4918        S: "OK"        S: "OK"
4919    
4920    
4921    
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires April 9, 2008                [Page 88]
4928    
4929    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4930    
4931    
4932  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
4933    
4934     The front-end can retrieve the current amount of directories in a     The front-end can retrieve the current amount of directories in a
# Line 4920  Internet-Draft    LinuxSampler Control P Line 4948  Internet-Draft    LinuxSampler Control P
4948    
4949        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4950    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 88]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4951           if the given directory does not exist.           if the given directory does not exist.
4952    
4953     Example:     Example:
# Line 4958  Internet-Draft    LinuxSampler Control P Line 4977  Internet-Draft    LinuxSampler Control P
4977    
4978           if the given directory does not exist.           if the given directory does not exist.
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires April 9, 2008                [Page 89]
4984    
4985    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4986    
4987    
4988     Example:     Example:
4989    
4990        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
# Line 4977  Internet-Draft    LinuxSampler Control P Line 5004  Internet-Draft    LinuxSampler Control P
5004        GET DB_INSTRUMENT_DIRECTORY INFO <dir>        GET DB_INSTRUMENT_DIRECTORY INFO <dir>
5005    
5006     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 89]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5007     directory the front-end is interested in.     directory the front-end is interested in.
5008    
5009     Possible Answers:     Possible Answers:
# Line 5014  Internet-Draft    LinuxSampler Control P Line 5033  Internet-Draft    LinuxSampler Control P
5033    
5034     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires April 9, 2008                [Page 90]
5040    
5041    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5042    
5043    
5044     Example:     Example:
5045    
5046        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
# Line 5032  Internet-Draft    LinuxSampler Control P Line 5059  Internet-Draft    LinuxSampler Control P
5059     The front-end can alter the name of a specific instrument directory     The front-end can alter the name of a specific instrument directory
5060     by sending the following command:     by sending the following command:
5061    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 90]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5062        SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>        SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5063    
5064     Where <dir> is the absolute path name of the directory and <name> is     Where <dir> is the absolute path name of the directory and <name> is
# Line 5069  Internet-Draft    LinuxSampler Control P Line 5087  Internet-Draft    LinuxSampler Control P
5087     The front-end can move a specific instrument directory by sending the     The front-end can move a specific instrument directory by sending the
5088     following command:     following command:
5089    
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires April 9, 2008                [Page 91]
5096    
5097    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5098    
5099    
5100        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5101    
5102     Where <dir> is the absolute path name of the directory to move and     Where <dir> is the absolute path name of the directory to move and
# Line 5089  Internet-Draft    LinuxSampler Control P Line 5117  Internet-Draft    LinuxSampler Control P
5117    
5118     Example:     Example:
5119    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 91]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5120        C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/        C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5121        Acoustic'"        Acoustic'"
5122    
# Line 5125  Internet-Draft    LinuxSampler Control P Line 5145  Internet-Draft    LinuxSampler Control P
5145           exists in the destination directory.  Error is also thrown when           exists in the destination directory.  Error is also thrown when
5146           trying to copy a directory to a subdirectory of itself.           trying to copy a directory to a subdirectory of itself.
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires April 9, 2008                [Page 92]
5152    
5153    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5154    
5155    
5156     Example:     Example:
5157    
5158        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
# Line 5146  Internet-Draft    LinuxSampler Control P Line 5174  Internet-Draft    LinuxSampler Control P
5174    
5175     Possible Answers:     Possible Answers:
5176    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 92]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5177        "OK" -        "OK" -
5178    
5179           on success           on success
# Line 5180  Internet-Draft    LinuxSampler Control P Line 5201  Internet-Draft    LinuxSampler Control P
5201     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5202     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5203     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
5204    
5205    
5206    
5207    Schoenebeck               Expires April 9, 2008                [Page 93]
5208    
5209    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5210    
5211    
5212     form of "key1=val1 key2=val2 ...".  The following criterias are     form of "key1=val1 key2=val2 ...".  The following criterias are
5213     allowed:     allowed:
5214    
# Line 5201  Internet-Draft    LinuxSampler Control P Line 5230  Internet-Draft    LinuxSampler Control P
5230    
5231     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5232    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 93]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5233        Restricts the search to directories, which date of last        Restricts the search to directories, which date of last
5234        modification satisfies the specified period, where <date-after>        modification satisfies the specified period, where <date-after>
5235        and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-        and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
# Line 5235  Internet-Draft    LinuxSampler Control P Line 5256  Internet-Draft    LinuxSampler Control P
5256    
5257        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires April 9, 2008                [Page 94]
5264    
5265    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5266    
5267    
5268           if the given directory does not exist.           if the given directory does not exist.
5269    
5270     Example:     Example:
# Line 5257  Internet-Draft    LinuxSampler Control P Line 5287  Internet-Draft    LinuxSampler Control P
5287        [<instr_index>]        [<instr_index>]
5288    
5289     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 94]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5290     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
5291     instruments (that are not already in the database) will be added,     instruments (that are not already in the database) will be added,
5292     <file_path> is the absolute path name of a file or directory in the     <file_path> is the absolute path name of a file or directory in the
# Line 5289  Internet-Draft    LinuxSampler Control P Line 5311  Internet-Draft    LinuxSampler Control P
5311           Only the instruments in the specified directory will be added,           Only the instruments in the specified directory will be added,
5312           the instruments in the subdirectories will not be processed.           the instruments in the subdirectories will not be processed.
5313    
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires April 9, 2008                [Page 95]
5320    
5321    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5322    
5323    
5324        "FLAT" -        "FLAT" -
5325    
5326           All instruments will be processed, including those in the           All instruments will be processed, including those in the
# Line 5314  Internet-Draft    LinuxSampler Control P Line 5346  Internet-Draft    LinuxSampler Control P
5346           numerical ID used to obtain status information about the job           numerical ID used to obtain status information about the job
5347           progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)           progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5348    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 95]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5349        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5350    
5351           if an invalid path is specified.           if an invalid path is specified.
# Line 5344  Internet-Draft    LinuxSampler Control P Line 5369  Internet-Draft    LinuxSampler Control P
5369    
5370     Possible Answers:     Possible Answers:
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires April 9, 2008                [Page 96]
5376    
5377    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5378    
5379    
5380        "OK" -        "OK" -
5381    
5382           if the instrument is removed successfully           if the instrument is removed successfully
# Line 5370  Internet-Draft    LinuxSampler Control P Line 5403  Internet-Draft    LinuxSampler Control P
5403     including those located in subdirectories of the specified directory,     including those located in subdirectories of the specified directory,
5404     will be returned.     will be returned.
5405    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 96]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5406     Possible Answers:     Possible Answers:
5407    
5408        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
# Line 5399  Internet-Draft    LinuxSampler Control P Line 5425  Internet-Draft    LinuxSampler Control P
5425        LIST DB_INSTRUMENTS [RECURSIVE] <dir>        LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5426    
5427     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5428    
5429    
5430    
5431    Schoenebeck               Expires April 9, 2008                [Page 97]
5432    
5433    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5434    
5435    
5436     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
5437     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5438     specified directory, will be returned.     specified directory, will be returned.
# Line 5423  Internet-Draft    LinuxSampler Control P Line 5457  Internet-Draft    LinuxSampler Control P
5457        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5458        Steinway D','/Piano Collection/Lite/Free Piano'"        Steinway D','/Piano Collection/Lite/Free Piano'"
5459    
   
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 97]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5460  6.8.15.  Getting instrument information  6.8.15.  Getting instrument information
5461    
5462     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
# Line 5458  Internet-Draft    LinuxSampler Control P Line 5482  Internet-Draft    LinuxSampler Control P
5482              File name of the instrument.  Note that the character string              File name of the instrument.  Note that the character string
5483              may contain escape sequences (Section 7.1).              may contain escape sequences (Section 7.1).
5484    
5485    
5486    
5487    Schoenebeck               Expires April 9, 2008                [Page 98]
5488    
5489    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5490    
5491    
5492           INSTRUMENT_NR -           INSTRUMENT_NR -
5493    
5494              Index of the instrument within the file.              Index of the instrument within the file.
# Line 5480  Internet-Draft    LinuxSampler Control P Line 5511  Internet-Draft    LinuxSampler Control P
5511              instruments database, represented in "YYYY-MM-DD HH:MM:SS"              instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5512              format              format
5513    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 98]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5514           MODIFIED -           MODIFIED -
5515    
5516              The date and time of the last modification of the              The date and time of the last modification of the
# Line 5515  Internet-Draft    LinuxSampler Control P Line 5537  Internet-Draft    LinuxSampler Control P
5537              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5538              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires April 9, 2008                [Page 99]
5544    
5545    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5546    
5547    
5548           KEYWORDS -           KEYWORDS -
5549    
5550              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
# Line 5536  Internet-Draft    LinuxSampler Control P Line 5566  Internet-Draft    LinuxSampler Control P
5566    
5567           "FORMAT_VERSION: 2"           "FORMAT_VERSION: 2"
5568    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 99]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5569           "SIZE: 2050871870"           "SIZE: 2050871870"
5570    
5571           "CREATED: 2007-02-05 10:23:12"           "CREATED: 2007-02-05 10:23:12"
# Line 5573  Internet-Draft    LinuxSampler Control P Line 5594  Internet-Draft    LinuxSampler Control P
5594     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
5595     is the new name for that instrument.     is the new name for that instrument.
5596    
5597    
5598    
5599    Schoenebeck               Expires April 9, 2008               [Page 100]
5600    
5601    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5602    
5603    
5604     Possible Answers:     Possible Answers:
5605    
5606        "OK" -        "OK" -
# Line 5591  Internet-Draft    LinuxSampler Control P Line 5619  Internet-Draft    LinuxSampler Control P
5619    
5620        S: "OK"        S: "OK"
5621    
   
   
   
   
   
 Schoenebeck               Expires March 4, 2008               [Page 100]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5622  6.8.17.  Moving an instrument  6.8.17.  Moving an instrument
5623    
5624     The front-end can move a specific instrument to another directory by     The front-end can move a specific instrument to another directory by
# Line 5630  Internet-Draft    LinuxSampler Control P Line 5648  Internet-Draft    LinuxSampler Control P
5648    
5649        S: "OK"        S: "OK"
5650    
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires April 9, 2008               [Page 101]
5656    
5657    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5658    
5659    
5660  6.8.18.  Copying instruments  6.8.18.  Copying instruments
5661    
5662     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 5648  Internet-Draft    LinuxSampler Control P Line 5675  Internet-Draft    LinuxSampler Control P
5675    
5676        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5677    
   
   
   
   
 Schoenebeck               Expires March 4, 2008               [Page 101]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5678           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
5679           instrument with name equal to the name of the specified           instrument with name equal to the name of the specified
5680           instrument already exists in the destination directory.           instrument already exists in the destination directory.
# Line 5686  Internet-Draft    LinuxSampler Control P Line 5704  Internet-Draft    LinuxSampler Control P
5704    
5705           on success           on success
5706    
5707    
5708    
5709    
5710    
5711    Schoenebeck               Expires April 9, 2008               [Page 102]
5712    
5713    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5714    
5715    
5716        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5717    
5718           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5705  Internet-Draft    LinuxSampler Control P Line 5732  Internet-Draft    LinuxSampler Control P
5732        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5733    
5734     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
   
   
   
 Schoenebeck               Expires March 4, 2008               [Page 102]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5735     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5736     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5737     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
# Line 5743  Internet-Draft    LinuxSampler Control P Line 5762  Internet-Draft    LinuxSampler Control P
5762        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
5763        instruments created after <date-after>.        instruments created after <date-after>.
5764    
5765    
5766    
5767    Schoenebeck               Expires April 9, 2008               [Page 103]
5768    
5769    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5770    
5771    
5772     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5773    
5774        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 5762  Internet-Draft    LinuxSampler Control P Line 5788  Internet-Draft    LinuxSampler Control P
5788    
5789     PRODUCT='<search-string>'     PRODUCT='<search-string>'
5790    
   
   
 Schoenebeck               Expires March 4, 2008               [Page 103]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5791        Restricts the search to instruments with product info that        Restricts the search to instruments with product info that
5792        satisfies the supplied search string (encapsulated into        satisfies the supplied search string (encapsulated into
5793        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 5799  Internet-Draft    LinuxSampler Control P Line 5818  Internet-Draft    LinuxSampler Control P
5818        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
5819        families.        families.
5820    
5821    
5822    
5823    Schoenebeck               Expires April 9, 2008               [Page 104]
5824    
5825    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5826    
5827    
5828     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5829     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
5830    
# Line 5817  Internet-Draft    LinuxSampler Control P Line 5843  Internet-Draft    LinuxSampler Control P
5843        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5844        290'"        290'"
5845    
   
   
   
 Schoenebeck               Expires March 4, 2008               [Page 104]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5846        S: "'/Piano Collection/Bosendorfer 290'"        S: "'/Piano Collection/Bosendorfer 290'"
5847    
5848        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
# Line 5855  Internet-Draft    LinuxSampler Control P Line 5873  Internet-Draft    LinuxSampler Control P
5873    
5874           FILES_TOTAL -           FILES_TOTAL -
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires April 9, 2008               [Page 105]
5880    
5881    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5882    
5883    
5884              The total number of files scheduled for scanning              The total number of files scheduled for scanning
5885    
5886           FILES_SCANNED -           FILES_SCANNED -
# Line 5874  Internet-Draft    LinuxSampler Control P Line 5900  Internet-Draft    LinuxSampler Control P
5900    
5901     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5902    
   
   
 Schoenebeck               Expires March 4, 2008               [Page 105]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5903     Example:     Example:
5904    
5905        C: "GET DB_INSTRUMENTS_JOB INFO 2"        C: "GET DB_INSTRUMENTS_JOB INFO 2"
# Line 5909  Internet-Draft    LinuxSampler Control P Line 5928  Internet-Draft    LinuxSampler Control P
5928    
5929           on success           on success
5930    
5931    
5932    
5933    
5934    
5935    Schoenebeck               Expires April 9, 2008               [Page 106]
5936    
5937    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5938    
5939    
5940        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5941    
5942           If the formatting of the instruments database failed.           If the formatting of the instruments database failed.
# Line 5930  Internet-Draft    LinuxSampler Control P Line 5958  Internet-Draft    LinuxSampler Control P
5958     The front-end can request to open an appropriate instrument editor     The front-end can request to open an appropriate instrument editor
5959     application by sending the following command:     application by sending the following command:
5960    
   
   
 Schoenebeck               Expires March 4, 2008               [Page 106]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
5961        EDIT INSTRUMENT <sampler-channel>        EDIT INSTRUMENT <sampler-channel>
5962    
5963     Where <sampler-channel> should be replaced by the number of the     Where <sampler-channel> should be replaced by the number of the
# Line 5963  Internet-Draft    LinuxSampler Control P Line 5984  Internet-Draft    LinuxSampler Control P
5984    
5985           when an appropriate instrument editor was launched           when an appropriate instrument editor was launched
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck               Expires April 9, 2008               [Page 107]
5992    
5993    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5994    
5995    
5996        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
5997    
5998           when an appropriate instrument editor was launched, but there           when an appropriate instrument editor was launched, but there
# Line 5988  Internet-Draft    LinuxSampler Control P Line 6018  Internet-Draft    LinuxSampler Control P
6018    
6019    
6020    
6021  Schoenebeck               Expires March 4, 2008               [Page 107]  
6022    
6023    
6024    
6025    
6026    
6027    
6028    
6029    
6030    
6031    
6032    
6033    
6034    
6035    
6036    
6037    
6038    
6039    
6040    
6041    
6042    
6043    
6044    
6045    
6046    
6047    Schoenebeck               Expires April 9, 2008               [Page 108]
6048    
6049  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6050    
6051    
6052  7.  Command Syntax  7.  Command Syntax
# Line 6044  Internet-Draft    LinuxSampler Control P Line 6100  Internet-Draft    LinuxSampler Control P
6100    
6101    
6102    
6103  Schoenebeck               Expires March 4, 2008               [Page 108]  Schoenebeck               Expires April 9, 2008               [Page 109]
6104    
6105  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6106    
6107    
6108        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6100  Internet-Draft    LinuxSampler Control P Line 6156  Internet-Draft    LinuxSampler Control P
6156    
6157    
6158    
6159  Schoenebeck               Expires March 4, 2008               [Page 109]  Schoenebeck               Expires April 9, 2008               [Page 110]
6160    
6161  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6162    
6163    
6164        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
# Line 6156  Internet-Draft    LinuxSampler Control P Line 6212  Internet-Draft    LinuxSampler Control P
6212    
6213    
6214    
6215  Schoenebeck               Expires March 4, 2008               [Page 110]  Schoenebeck               Expires April 9, 2008               [Page 111]
6216    
6217  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6218    
6219    
6220        / MISCELLANEOUS        / MISCELLANEOUS
# Line 6212  Internet-Draft    LinuxSampler Control P Line 6268  Internet-Draft    LinuxSampler Control P
6268    
6269    
6270    
6271  Schoenebeck               Expires March 4, 2008               [Page 111]  Schoenebeck               Expires April 9, 2008               [Page 112]
6272    
6273  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6274    
6275    
6276        / MISCELLANEOUS        / MISCELLANEOUS
# Line 6268  Internet-Draft    LinuxSampler Control P Line 6324  Internet-Draft    LinuxSampler Control P
6324    
6325    
6326    
6327  Schoenebeck               Expires March 4, 2008               [Page 112]  Schoenebeck               Expires April 9, 2008               [Page 113]
6328    
6329  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6330    
6331    
6332        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
# Line 6324  Internet-Draft    LinuxSampler Control P Line 6380  Internet-Draft    LinuxSampler Control P
6380    
6381    
6382    
6383  Schoenebeck               Expires March 4, 2008               [Page 113]  Schoenebeck               Expires April 9, 2008               [Page 114]
6384    
6385  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6386    
6387    
6388        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
# Line 6380  Internet-Draft    LinuxSampler Control P Line 6436  Internet-Draft    LinuxSampler Control P
6436    
6437    
6438    
6439  Schoenebeck               Expires March 4, 2008               [Page 114]  Schoenebeck               Expires April 9, 2008               [Page 115]
6440    
6441  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6442    
6443    
6444        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
# Line 6436  Internet-Draft    LinuxSampler Control P Line 6492  Internet-Draft    LinuxSampler Control P
6492    
6493    
6494    
6495  Schoenebeck               Expires March 4, 2008               [Page 115]  Schoenebeck               Expires April 9, 2008               [Page 116]
6496    
6497  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6498    
6499    
6500        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
# Line 6492  Internet-Draft    LinuxSampler Control P Line 6548  Internet-Draft    LinuxSampler Control P
6548    
6549    
6550    
6551  Schoenebeck               Expires March 4, 2008               [Page 116]  Schoenebeck               Expires April 9, 2008               [Page 117]
6552    
6553  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6554    
6555    
6556        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
# Line 6548  Internet-Draft    LinuxSampler Control P Line 6604  Internet-Draft    LinuxSampler Control P
6604    
6605    
6606    
6607  Schoenebeck               Expires March 4, 2008               [Page 117]  Schoenebeck               Expires April 9, 2008               [Page 118]
6608    
6609  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6610    
6611    
6612        string '=' param_val_list        string '=' param_val_list
# Line 6604  Internet-Draft    LinuxSampler Control P Line 6660  Internet-Draft    LinuxSampler Control P
6660    
6661    
6662    
6663  Schoenebeck               Expires March 4, 2008               [Page 118]  Schoenebeck               Expires April 9, 2008               [Page 119]
6664    
6665  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6666    
6667    
6668        engine_name SP sampler_channel        engine_name SP sampler_channel
# Line 6660  Internet-Draft    LinuxSampler Control P Line 6716  Internet-Draft    LinuxSampler Control P
6716    
6717    
6718    
6719  Schoenebeck               Expires March 4, 2008               [Page 119]  Schoenebeck               Expires April 9, 2008               [Page 120]
6720    
6721  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6722    
6723    
6724     midi_ctrl =     midi_ctrl =
# Line 6701  Internet-Draft    LinuxSampler Control P Line 6757  Internet-Draft    LinuxSampler Control P
6757    
6758     map_name =     map_name =
6759    
6760        stringval        stringval_escaped
6761    
6762     entry_name =     entry_name =
6763    
6764        stringval        stringval_escaped
6765    
6766     fx_send_name =     fx_send_name =
6767    
6768        stringval        stringval_escaped
6769    
6770     param_val_list =     param_val_list =
6771    
6772    
6773    
6774    
6775  Schoenebeck               Expires March 4, 2008               [Page 120]  Schoenebeck               Expires April 9, 2008               [Page 121]
6776    
6777  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6778    
6779    
6780        param_val        param_val
# Line 6743  Internet-Draft    LinuxSampler Control P Line 6799  Internet-Draft    LinuxSampler Control P
6799    
6800     query_val =     query_val =
6801    
6802        textval_escaped        text_escaped
6803    
6804        / stringval_escaped        / stringval_escaped
6805    
# Line 6772  Internet-Draft    LinuxSampler Control P Line 6828  Internet-Draft    LinuxSampler Control P
6828    
6829    
6830    
6831  Schoenebeck               Expires March 4, 2008               [Page 121]  Schoenebeck               Expires April 9, 2008               [Page 122]
6832    
6833  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6834    
6835    
6836     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 6812  Internet-Draft    LinuxSampler Control P Line 6868  Internet-Draft    LinuxSampler Control P
6868     (that is as double backslash), whereas in the old versions a single     (that is as double backslash), whereas in the old versions a single
6869     backslash was sufficient.     backslash was sufficient.
6870    
6871       The following LSCP commands support escape sequences as part of their
6872       filename / path based arguments:
6873    
6874          "LOAD INSTRUMENT" (Section 6.4.1)
6875    
6876          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
6877    
6878          "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
6879    
6880          "ADD DB_INSTRUMENTS" (Section 6.8.11)
6881    
6882          "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires April 9, 2008               [Page 123]
6888    
6889    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6890    
6891    
6892          "REMOVE DB_INSTRUMENT" (Section 6.8.12)
6893    
6894          "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
6895    
6896          "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
6897    
6898          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
6899    
6900          "GET DB_INSTRUMENTS" (Section 6.8.13)
6901    
6902          "LIST DB_INSTRUMENTS" (Section 6.8.14)
6903    
6904          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
6905    
6906          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
6907    
6908          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
6909    
6910          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
6911    
6912          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
6913    
6914          "FIND DB_INSTRUMENTS" (Section 6.8.20)
6915    
6916          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
6917    
6918          "MOVE DB_INSTRUMENT" (Section 6.8.17)
6919    
6920          "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
6921    
6922          "COPY DB_INSTRUMENT" (Section 6.8.18)
6923    
6924          "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
6925    
6926       Note that the forward slash character ('/') has a special meaning in
6927       filename / path based arguments: it acts as separator of the nodes in
6928       the path, thus if a directory- or filename includes a forward slash
6929       (not intended as path node separator), you MUST escape that slash
6930       either with the respective hex escape sequence ("\x2f") or with the
6931       respective octal escape sequence ("\057").
6932    
6933       The following LSCP commands even support escape sequences as part of
6934       at least one of their text-based arguments (i.e. entity name,
6935       description):
6936    
6937          "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck               Expires April 9, 2008               [Page 124]
6944    
6945    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6946    
6947    
6948          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
6949    
6950          "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
6951    
6952          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
6953    
6954          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
6955    
6956          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
6957    
6958          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
6959    
6960          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
6961    
6962       Please note that these lists are manually maintained.  If you find a
6963       command that also supports escape sequences we forgot to mention
6964       here, please report it!
6965    
6966    
6967    
6968    
6969    
6970    
6971    
6972    
6973    
6974    
6975    
6976    
6977    
6978    
6979    
6980    
6981    
6982    
6983    
6984    
6985    
# Line 6828  Internet-Draft    LinuxSampler Control P Line 6996  Internet-Draft    LinuxSampler Control P
6996    
6997    
6998    
6999  Schoenebeck               Expires March 4, 2008               [Page 122]  Schoenebeck               Expires April 9, 2008               [Page 125]
7000    
7001  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7002    
7003    
7004  8.  Events  8.  Events
# Line 6884  Internet-Draft    LinuxSampler Control P Line 7052  Internet-Draft    LinuxSampler Control P
7052    
7053    
7054    
7055  Schoenebeck               Expires March 4, 2008               [Page 123]  Schoenebeck               Expires April 9, 2008               [Page 126]
7056    
7057  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7058    
7059    
7060        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 6940  Internet-Draft    LinuxSampler Control P Line 7108  Internet-Draft    LinuxSampler Control P
7108    
7109    
7110    
7111  Schoenebeck               Expires March 4, 2008               [Page 124]  Schoenebeck               Expires April 9, 2008               [Page 127]
7112    
7113  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7114    
7115    
7116        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
# Line 6996  Internet-Draft    LinuxSampler Control P Line 7164  Internet-Draft    LinuxSampler Control P
7164    
7165    
7166    
7167  Schoenebeck               Expires March 4, 2008               [Page 125]  Schoenebeck               Expires April 9, 2008               [Page 128]
7168    
7169  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7170    
7171    
7172        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 7052  Internet-Draft    LinuxSampler Control P Line 7220  Internet-Draft    LinuxSampler Control P
7220    
7221    
7222    
7223  Schoenebeck               Expires March 4, 2008               [Page 126]  Schoenebeck               Expires April 9, 2008               [Page 129]
7224    
7225  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7226    
7227    
7228        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
# Line 7108  Internet-Draft    LinuxSampler Control P Line 7276  Internet-Draft    LinuxSampler Control P
7276    
7277    
7278    
7279  Schoenebeck               Expires March 4, 2008               [Page 127]  Schoenebeck               Expires April 9, 2008               [Page 130]
7280    
7281  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7282    
7283    
7284        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
# Line 7164  Internet-Draft    LinuxSampler Control P Line 7332  Internet-Draft    LinuxSampler Control P
7332    
7333    
7334    
7335  Schoenebeck               Expires March 4, 2008               [Page 128]  Schoenebeck               Expires April 9, 2008               [Page 131]
7336    
7337  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7338    
7339    
7340  8.18.  Number of database instrument directories changed  8.18.  Number of database instrument directories changed
# Line 7220  Internet-Draft    LinuxSampler Control P Line 7388  Internet-Draft    LinuxSampler Control P
7388    
7389    
7390    
7391  Schoenebeck               Expires March 4, 2008               [Page 129]  Schoenebeck               Expires April 9, 2008               [Page 132]
7392    
7393  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7394    
7395    
7396  8.20.  Number of database instruments changed  8.20.  Number of database instruments changed
# Line 7276  Internet-Draft    LinuxSampler Control P Line 7444  Internet-Draft    LinuxSampler Control P
7444    
7445    
7446    
7447  Schoenebeck               Expires March 4, 2008               [Page 130]  Schoenebeck               Expires April 9, 2008               [Page 133]
7448    
7449  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7450    
7451    
7452  8.22.  Database job status information changed  8.22.  Database job status information changed
# Line 7332  Internet-Draft    LinuxSampler Control P Line 7500  Internet-Draft    LinuxSampler Control P
7500    
7501    
7502    
7503  Schoenebeck               Expires March 4, 2008               [Page 131]  Schoenebeck               Expires April 9, 2008               [Page 134]
7504    
7505  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7506    
7507    
7508  9.  Security Considerations  9.  Security Considerations
# Line 7388  Internet-Draft    LinuxSampler Control P Line 7556  Internet-Draft    LinuxSampler Control P
7556    
7557    
7558    
7559  Schoenebeck               Expires March 4, 2008               [Page 132]  Schoenebeck               Expires April 9, 2008               [Page 135]
7560    
7561  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7562    
7563    
7564  10.  Acknowledgments  10.  Acknowledgments
# Line 7444  Internet-Draft    LinuxSampler Control P Line 7612  Internet-Draft    LinuxSampler Control P
7612    
7613    
7614    
7615  Schoenebeck               Expires March 4, 2008               [Page 133]  Schoenebeck               Expires April 9, 2008               [Page 136]
7616    
7617  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7618    
7619    
7620  11.  References  11.  References
# Line 7500  Internet-Draft    LinuxSampler Control P Line 7668  Internet-Draft    LinuxSampler Control P
7668    
7669    
7670    
7671  Schoenebeck               Expires March 4, 2008               [Page 134]  Schoenebeck               Expires April 9, 2008               [Page 137]
7672    
7673  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7674    
7675    
7676  Author's Address  Author's Address
# Line 7556  Author's Address Line 7724  Author's Address
7724    
7725    
7726    
7727  Schoenebeck               Expires March 4, 2008               [Page 135]  Schoenebeck               Expires April 9, 2008               [Page 138]
7728    
7729  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7730    
7731    
7732  Full Copyright Statement  Full Copyright Statement
# Line 7612  Acknowledgment Line 7780  Acknowledgment
7780    
7781    
7782    
7783  Schoenebeck               Expires March 4, 2008               [Page 136]  Schoenebeck               Expires April 9, 2008               [Page 139]
7784    
7785    
Legend:
Removed from v.1363  
changed lines
  Added in v.1390
  ViewVC Help
Powered by ViewVC