/[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 1800 by iliev, Wed Sep 10 15:14:31 2008 UTC revision 1801 by schoenebeck, Sun Dec 7 01:31:29 2008 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: March 14, 2009                               September 10, 2008  Expires: June 9, 2009                                   December 6, 2008
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
# Line 33  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on March 14, 2009.     This Internet-Draft will expire on June 9, 2009.
37    
38    
 Copyright Notice  
39    
    Copyright (C) The IETF Trust (2008).  
40    
41    
42    
# Line 52  Copyright Notice Line 51  Copyright Notice
51    
52    
53    
54  Schoenebeck              Expires March 14, 2009                 [Page 1]  
55    Schoenebeck               Expires June 9, 2009                  [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck              Expires March 14, 2009                 [Page 2]  Schoenebeck               Expires June 9, 2009                  [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.  Getting all created MIDI input device list  . . . . .  37
# Line 164  Internet-Draft        LinuxSampler Contr Line 164  Internet-Draft        LinuxSampler Contr
164    
165    
166    
167  Schoenebeck              Expires March 14, 2009                 [Page 3]  Schoenebeck               Expires June 9, 2009                  [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
170    
171    
172         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  73         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  73
# Line 179  Internet-Draft        LinuxSampler Contr Line 179  Internet-Draft        LinuxSampler Contr
179         6.6.5.  General sampler informations  . . . . . . . . . . . .  75         6.6.5.  General sampler informations  . . . . . . . . . . . .  75
180         6.6.6.  Getting global volume attenuation . . . . . . . . . .  76         6.6.6.  Getting global volume attenuation . . . . . . . . . .  76
181         6.6.7.  Setting global volume attenuation . . . . . . . . . .  76         6.6.7.  Setting global volume attenuation . . . . . . . . . .  76
182       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  77         6.6.8.  Getting global voice limit  . . . . . . . . . . . . .  77
183         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  77         6.6.9.  Setting global voice limit  . . . . . . . . . . . . .  77
184         6.7.2.  Delete one particular or all MIDI instrument maps . .  78         6.6.10. Getting global disk stream limit  . . . . . . . . . .  78
185         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  79         6.6.11. Setting global disk stream limit  . . . . . . . . . .  78
186         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  79       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  79
187         6.7.5.  Getting MIDI instrument map information . . . . . . .  80         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  80
188         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  81         6.7.2.  Delete one particular or all MIDI instrument maps . .  81
189         6.7.7.  Create or replace a MIDI instrument map entry . . . .  81         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  81
190         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  84         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  82
191           6.7.5.  Getting MIDI instrument map information . . . . . . .  82
192           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  83
193           6.7.7.  Create or replace a MIDI instrument map entry . . . .  84
194           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  86
195         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
196                 instrument map  . . . . . . . . . . . . . . . . . . .  85                 instrument map  . . . . . . . . . . . . . . . . . . .  87
197         6.7.10. Remove an entry from the MIDI instrument map  . . . .  85         6.7.10. Remove an entry from the MIDI instrument map  . . . .  88
198         6.7.11. Get current settings of MIDI instrument map entry . .  86         6.7.11. Get current settings of MIDI instrument map entry . .  88
199         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  88         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  90
200       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  89       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  91
201         6.8.1.  Creating a new instrument directory . . . . . . . . .  89         6.8.1.  Creating a new instrument directory . . . . . . . . .  91
202         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  89         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  92
203         6.8.3.  Getting amount of instrument directories  . . . . . .  90         6.8.3.  Getting amount of instrument directories  . . . . . .  92
204         6.8.4.  Listing all directories in specific directory . . . .  91         6.8.4.  Listing all directories in specific directory . . . .  93
205         6.8.5.  Getting instrument directory information  . . . . . .  91         6.8.5.  Getting instrument directory information  . . . . . .  94
206         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  92         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  95
207         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  93         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  95
208         6.8.8.  Copying instrument directories  . . . . . . . . . . .  94         6.8.8.  Copying instrument directories  . . . . . . . . . . .  96
209         6.8.9.  Changing the description of directory . . . . . . . .  94         6.8.9.  Changing the description of directory . . . . . . . .  97
210         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  95         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  97
211         6.8.11. Adding instruments to the instruments database  . . .  96         6.8.11. Adding instruments to the instruments database  . . .  99
212         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  98         6.8.12. Removing an instrument  . . . . . . . . . . . . . . . 100
213         6.8.13. Getting amount of instruments . . . . . . . . . . . .  98         6.8.13. Getting amount of instruments . . . . . . . . . . . . 101
214         6.8.14. Listing all instruments in specific directory . . . .  99         6.8.14. Listing all instruments in specific directory . . . . 101
215         6.8.15. Getting instrument information  . . . . . . . . . . . 100         6.8.15. Getting instrument information  . . . . . . . . . . . 102
216         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 102         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 104
217         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 103         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 105
218         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 103         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 106
219         6.8.19. Changing the description of instrument  . . . . . . . 104         6.8.19. Changing the description of instrument  . . . . . . . 106
        6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 104  
        6.8.21. Getting job status information  . . . . . . . . . . . 107  
        6.8.22. Formatting the instruments database . . . . . . . . . 108  
        6.8.23. Checking for lost instrument files  . . . . . . . . . 108  
220    
221    
222    
223  Schoenebeck              Expires March 14, 2009                 [Page 4]  Schoenebeck               Expires June 9, 2009                  [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
226    
227    
228         6.8.24. Replacing an instrument file  . . . . . . . . . . . . 109         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 107
229       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 109         6.8.21. Getting job status information  . . . . . . . . . . . 109
230           6.8.22. Formatting the instruments database . . . . . . . . . 110
231           6.8.23. Checking for lost instrument files  . . . . . . . . . 111
232           6.8.24. Replacing an instrument file  . . . . . . . . . . . . 111
233         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 112
234         6.9.1.  Opening an appropriate instrument editor         6.9.1.  Opening an appropriate instrument editor
235                 application . . . . . . . . . . . . . . . . . . . . . 110                 application . . . . . . . . . . . . . . . . . . . . . 112
236       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 111       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 113
237         6.10.1. Retrieving amount of instruments of a file  . . . . . 111         6.10.1. Retrieving amount of instruments of a file  . . . . . 113
238         6.10.2. Retrieving all instruments of a file  . . . . . . . . 111         6.10.2. Retrieving all instruments of a file  . . . . . . . . 114
239         6.10.3. Retrieving informations about one instrument in a         6.10.3. Retrieving informations about one instrument in a
240                 file  . . . . . . . . . . . . . . . . . . . . . . . . 112                 file  . . . . . . . . . . . . . . . . . . . . . . . . 114
241     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 115     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 117
242       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 129       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 131
243     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 133     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
244       8.1.  Number of audio output devices changed  . . . . . . . . . 133       8.1.  Number of audio output devices changed  . . . . . . . . . 136
245       8.2.  Audio output device's settings changed  . . . . . . . . . 133       8.2.  Audio output device's settings changed  . . . . . . . . . 136
246       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 133       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 136
247       8.4.  MIDI input device's settings changed  . . . . . . . . . . 134       8.4.  MIDI input device's settings changed  . . . . . . . . . . 137
248       8.5.  Number of sampler channels changed  . . . . . . . . . . . 134       8.5.  Number of sampler channels changed  . . . . . . . . . . . 137
249       8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 134       8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 137
250       8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 135       8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 138
251       8.8.  Number of active voices changed . . . . . . . . . . . . . 135       8.8.  Number of active voices changed . . . . . . . . . . . . . 138
252       8.9.  Number of active disk streams changed . . . . . . . . . . 136       8.9.  Number of active disk streams changed . . . . . . . . . . 139
253       8.10. Disk stream buffer fill state changed . . . . . . . . . . 136       8.10. Disk stream buffer fill state changed . . . . . . . . . . 139
254       8.11. Channel information changed . . . . . . . . . . . . . . . 136       8.11. Channel information changed . . . . . . . . . . . . . . . 139
255       8.12. Number of effect sends changed  . . . . . . . . . . . . . 137       8.12. Number of effect sends changed  . . . . . . . . . . . . . 140
256       8.13. Effect send information changed . . . . . . . . . . . . . 137       8.13. Effect send information changed . . . . . . . . . . . . . 140
257       8.14. Total number of active voices changed . . . . . . . . . . 138       8.14. Total number of active voices changed . . . . . . . . . . 141
258       8.15. Total number of active disk streams changed . . . . . . . 138       8.15. Total number of active disk streams changed . . . . . . . 141
259       8.16. Number of MIDI instrument maps changed  . . . . . . . . . 138       8.16. Number of MIDI instrument maps changed  . . . . . . . . . 141
260       8.17. MIDI instrument map information changed . . . . . . . . . 138       8.17. MIDI instrument map information changed . . . . . . . . . 141
261       8.18. Number of MIDI instruments changed  . . . . . . . . . . . 139       8.18. Number of MIDI instruments changed  . . . . . . . . . . . 142
262       8.19. MIDI instrument information changed . . . . . . . . . . . 139       8.19. MIDI instrument information changed . . . . . . . . . . . 142
263       8.20. Global settings changed . . . . . . . . . . . . . . . . . 140       8.20. Global settings changed . . . . . . . . . . . . . . . . . 143
264       8.21. Number of database instrument directories changed . . . . 140       8.21. Number of database instrument directories changed . . . . 143
265       8.22. Database instrument directory information changed . . . . 140       8.22. Database instrument directory information changed . . . . 143
266       8.23. Number of database instruments changed  . . . . . . . . . 141       8.23. Number of database instruments changed  . . . . . . . . . 144
267       8.24. Database instrument information changed . . . . . . . . . 141       8.24. Database instrument information changed . . . . . . . . . 144
268       8.25. Database job status information changed . . . . . . . . . 142       8.25. Database job status information changed . . . . . . . . . 145
269       8.26. Miscellaneous and debugging events  . . . . . . . . . . . 142       8.26. Miscellaneous and debugging events  . . . . . . . . . . . 145
270     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 143     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 147
271     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 144     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 148
272     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 145     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 149
273     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 146     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 150
274     Intellectual Property and Copyright Statements  . . . . . . . . . 147     Intellectual Property and Copyright Statements  . . . . . . . . . 151
   
275    
276    
277    
278    
279    Schoenebeck               Expires June 9, 2009                  [Page 5]
   
   
 Schoenebeck              Expires March 14, 2009                 [Page 5]  
280    
281  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck              Expires March 14, 2009                 [Page 6]  Schoenebeck               Expires June 9, 2009                  [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck              Expires March 14, 2009                 [Page 7]  Schoenebeck               Expires June 9, 2009                  [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck              Expires March 14, 2009                 [Page 8]  Schoenebeck               Expires June 9, 2009                  [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck              Expires March 14, 2009                 [Page 9]  Schoenebeck               Expires June 9, 2009                  [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck              Expires March 14, 2009                [Page 10]  Schoenebeck               Expires June 9, 2009                 [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck              Expires March 14, 2009                [Page 11]  Schoenebeck               Expires June 9, 2009                 [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck              Expires March 14, 2009                [Page 12]  Schoenebeck               Expires June 9, 2009                 [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck              Expires March 14, 2009                [Page 13]  Schoenebeck               Expires June 9, 2009                 [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck              Expires March 14, 2009                [Page 14]  Schoenebeck               Expires June 9, 2009                 [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck              Expires March 14, 2009                [Page 15]  Schoenebeck               Expires June 9, 2009                 [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck              Expires March 14, 2009                [Page 16]  Schoenebeck               Expires June 9, 2009                 [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck              Expires March 14, 2009                [Page 17]  Schoenebeck               Expires June 9, 2009                 [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck              Expires March 14, 2009                [Page 18]  Schoenebeck               Expires June 9, 2009                 [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck              Expires March 14, 2009                [Page 19]  Schoenebeck               Expires June 9, 2009                 [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck              Expires March 14, 2009                [Page 20]  Schoenebeck               Expires June 9, 2009                 [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck              Expires March 14, 2009                [Page 21]  Schoenebeck               Expires June 9, 2009                 [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck              Expires March 14, 2009                [Page 22]  Schoenebeck               Expires June 9, 2009                 [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck              Expires March 14, 2009                [Page 23]  Schoenebeck               Expires June 9, 2009                 [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck              Expires March 14, 2009                [Page 24]  Schoenebeck               Expires June 9, 2009                 [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck              Expires March 14, 2009                [Page 25]  Schoenebeck               Expires June 9, 2009                 [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck              Expires March 14, 2009                [Page 26]  Schoenebeck               Expires June 9, 2009                 [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck              Expires March 14, 2009                [Page 27]  Schoenebeck               Expires June 9, 2009                 [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck              Expires March 14, 2009                [Page 28]  Schoenebeck               Expires June 9, 2009                 [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck              Expires March 14, 2009                [Page 29]  Schoenebeck               Expires June 9, 2009                 [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck              Expires March 14, 2009                [Page 30]  Schoenebeck               Expires June 9, 2009                 [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck              Expires March 14, 2009                [Page 31]  Schoenebeck               Expires June 9, 2009                 [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck              Expires March 14, 2009                [Page 32]  Schoenebeck               Expires June 9, 2009                 [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck              Expires March 14, 2009                [Page 33]  Schoenebeck               Expires June 9, 2009                 [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck              Expires March 14, 2009                [Page 34]  Schoenebeck               Expires June 9, 2009                 [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck              Expires March 14, 2009                [Page 35]  Schoenebeck               Expires June 9, 2009                 [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck              Expires March 14, 2009                [Page 36]  Schoenebeck               Expires June 9, 2009                 [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck              Expires March 14, 2009                [Page 37]  Schoenebeck               Expires June 9, 2009                 [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck              Expires March 14, 2009                [Page 38]  Schoenebeck               Expires June 9, 2009                 [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck              Expires March 14, 2009                [Page 39]  Schoenebeck               Expires June 9, 2009                 [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck              Expires March 14, 2009                [Page 40]  Schoenebeck               Expires June 9, 2009                 [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck              Expires March 14, 2009                [Page 41]  Schoenebeck               Expires June 9, 2009                 [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck              Expires March 14, 2009                [Page 42]  Schoenebeck               Expires June 9, 2009                 [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2354    
2355    
2356        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck              Expires March 14, 2009                [Page 43]  Schoenebeck               Expires June 9, 2009                 [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2410    
2411    
2412     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck              Expires March 14, 2009                [Page 44]  Schoenebeck               Expires June 9, 2009                 [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2466    
2467    
2468     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck              Expires March 14, 2009                [Page 45]  Schoenebeck               Expires June 9, 2009                 [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2522    
2523    
2524  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck              Expires March 14, 2009                [Page 46]  Schoenebeck               Expires June 9, 2009                 [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2578    
2579    
2580           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck              Expires March 14, 2009                [Page 47]  Schoenebeck               Expires June 9, 2009                 [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2634    
2635    
2636  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck              Expires March 14, 2009                [Page 48]  Schoenebeck               Expires June 9, 2009                 [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2690    
2691    
2692     Possible Answers:     Possible Answers:
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck              Expires March 14, 2009                [Page 49]  Schoenebeck               Expires June 9, 2009                 [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2746    
2747    
2748        following categories are defined:        following categories are defined:
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck              Expires March 14, 2009                [Page 50]  Schoenebeck               Expires June 9, 2009                 [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2802    
2803    
2804           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
# Line 2852  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855  Schoenebeck              Expires March 14, 2009                [Page 51]  Schoenebeck               Expires June 9, 2009                 [Page 51]
2856    
2857  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2858    
2859    
2860     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 2908  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911  Schoenebeck              Expires March 14, 2009                [Page 52]  Schoenebeck               Expires June 9, 2009                 [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2914    
2915    
2916     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
# Line 2964  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck              Expires March 14, 2009                [Page 53]  Schoenebeck               Expires June 9, 2009                 [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
2970    
2971    
2972     command.     command.
# Line 3020  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck              Expires March 14, 2009                [Page 54]  Schoenebeck               Expires June 9, 2009                 [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3026    
3027    
3028        "OK" -        "OK" -
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck              Expires March 14, 2009                [Page 55]  Schoenebeck               Expires June 9, 2009                 [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3082    
3083    
3084     Examples:     Examples:
# Line 3132  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck              Expires March 14, 2009                [Page 56]  Schoenebeck               Expires June 9, 2009                 [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3138    
3139    
3140     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
# Line 3188  Internet-Draft        LinuxSampler Contr Line 3188  Internet-Draft        LinuxSampler Contr
3188    
3189    
3190    
3191  Schoenebeck              Expires March 14, 2009                [Page 57]  Schoenebeck               Expires June 9, 2009                 [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3194    
3195    
3196           message           message
# Line 3244  Internet-Draft        LinuxSampler Contr Line 3244  Internet-Draft        LinuxSampler Contr
3244    
3245    
3246    
3247  Schoenebeck              Expires March 14, 2009                [Page 58]  Schoenebeck               Expires June 9, 2009                 [Page 58]
3248    
3249  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3250    
3251    
3252        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
# Line 3300  Internet-Draft        LinuxSampler Contr Line 3300  Internet-Draft        LinuxSampler Contr
3300    
3301    
3302    
3303  Schoenebeck              Expires March 14, 2009                [Page 59]  Schoenebeck               Expires June 9, 2009                 [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3306    
3307    
3308           if channel volume was set, but there are noteworthy issue(s)           if channel volume was set, but there are noteworthy issue(s)
# Line 3356  Internet-Draft        LinuxSampler Contr Line 3356  Internet-Draft        LinuxSampler Contr
3356    
3357    
3358    
3359  Schoenebeck              Expires March 14, 2009                [Page 60]  Schoenebeck               Expires June 9, 2009                 [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3362    
3363    
3364  6.4.23.  Soloing a sampler channel  6.4.23.  Soloing a sampler channel
# Line 3412  Internet-Draft        LinuxSampler Contr Line 3412  Internet-Draft        LinuxSampler Contr
3412    
3413    
3414    
3415  Schoenebeck              Expires March 14, 2009                [Page 61]  Schoenebeck               Expires June 9, 2009                 [Page 61]
3416    
3417  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3418    
3419    
3420           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
# Line 3468  Internet-Draft        LinuxSampler Contr Line 3468  Internet-Draft        LinuxSampler Contr
3468    
3469    
3470    
3471  Schoenebeck              Expires March 14, 2009                [Page 62]  Schoenebeck               Expires June 9, 2009                 [Page 62]
3472    
3473  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3474    
3475    
3476     effect send entity.  The name does not have to be unique, but MUST be     effect send entity.  The name does not have to be unique, but MUST be
# Line 3524  Internet-Draft        LinuxSampler Contr Line 3524  Internet-Draft        LinuxSampler Contr
3524    
3525    
3526    
3527  Schoenebeck              Expires March 14, 2009                [Page 63]  Schoenebeck               Expires June 9, 2009                 [Page 63]
3528    
3529  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3530    
3531    
3532  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
# Line 3580  Internet-Draft        LinuxSampler Contr Line 3580  Internet-Draft        LinuxSampler Contr
3580    
3581    
3582    
3583  Schoenebeck              Expires March 14, 2009                [Page 64]  Schoenebeck               Expires June 9, 2009                 [Page 64]
3584    
3585  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3586    
3587    
3588        C: "GET FX_SENDS 0"        C: "GET FX_SENDS 0"
# Line 3636  Internet-Draft        LinuxSampler Contr Line 3636  Internet-Draft        LinuxSampler Contr
3636    
3637    
3638    
3639  Schoenebeck              Expires March 14, 2009                [Page 65]  Schoenebeck               Expires June 9, 2009                 [Page 65]
3640    
3641  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3642    
3643    
3644        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
# Line 3692  Internet-Draft        LinuxSampler Contr Line 3692  Internet-Draft        LinuxSampler Contr
3692    
3693    
3694    
3695  Schoenebeck              Expires March 14, 2009                [Page 66]  Schoenebeck               Expires June 9, 2009                 [Page 66]
3696    
3697  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3698    
3699    
3700  6.4.30.  Changing effect send's name  6.4.30.  Changing effect send's name
# Line 3748  Internet-Draft        LinuxSampler Contr Line 3748  Internet-Draft        LinuxSampler Contr
3748    
3749    
3750    
3751  Schoenebeck              Expires March 14, 2009                [Page 67]  Schoenebeck               Expires June 9, 2009                 [Page 67]
3752    
3753  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3754    
3755    
3756     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
# Line 3804  Internet-Draft        LinuxSampler Contr Line 3804  Internet-Draft        LinuxSampler Contr
3804    
3805    
3806    
3807  Schoenebeck              Expires March 14, 2009                [Page 68]  Schoenebeck               Expires June 9, 2009                 [Page 68]
3808    
3809  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3810    
3811    
3812     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
# Line 3860  Internet-Draft        LinuxSampler Contr Line 3860  Internet-Draft        LinuxSampler Contr
3860    
3861    
3862    
3863  Schoenebeck              Expires March 14, 2009                [Page 69]  Schoenebeck               Expires June 9, 2009                 [Page 69]
3864    
3865  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3866    
3867    
3868        "OK" -        "OK" -
# Line 3916  Internet-Draft        LinuxSampler Contr Line 3916  Internet-Draft        LinuxSampler Contr
3916    
3917    
3918    
3919  Schoenebeck              Expires March 14, 2009                [Page 70]  Schoenebeck               Expires June 9, 2009                 [Page 70]
3920    
3921  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3922    
3923    
3924     Possible Answers:     Possible Answers:
# Line 3972  Internet-Draft        LinuxSampler Contr Line 3972  Internet-Draft        LinuxSampler Contr
3972    
3973    
3974    
3975  Schoenebeck              Expires March 14, 2009                [Page 71]  Schoenebeck               Expires June 9, 2009                 [Page 71]
3976    
3977  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
3978    
3979    
3980    
# Line 4028  Internet-Draft        LinuxSampler Contr Line 4028  Internet-Draft        LinuxSampler Contr
4028    
4029    
4030    
4031  Schoenebeck              Expires March 14, 2009                [Page 72]  Schoenebeck               Expires June 9, 2009                 [Page 72]
4032    
4033  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
4034    
4035    
4036     Possible Answers:     Possible Answers:
# Line 4084  Internet-Draft        LinuxSampler Contr Line 4084  Internet-Draft        LinuxSampler Contr
4084    
4085    
4086    
4087  Schoenebeck              Expires March 14, 2009                [Page 73]  Schoenebeck               Expires June 9, 2009                 [Page 73]
4088    
4089  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
4090    
4091    
4092    
# Line 4140  Internet-Draft        LinuxSampler Contr Line 4140  Internet-Draft        LinuxSampler Contr
4140    
4141    
4142    
4143  Schoenebeck              Expires March 14, 2009                [Page 74]  Schoenebeck               Expires June 9, 2009                 [Page 74]
4144    
4145  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
4146    
4147    
4148        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
# Line 4196  Internet-Draft        LinuxSampler Contr Line 4196  Internet-Draft        LinuxSampler Contr
4196    
4197    
4198    
4199  Schoenebeck              Expires March 14, 2009                [Page 75]  Schoenebeck               Expires June 9, 2009                 [Page 75]
4200    
4201  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
4202    
4203    
4204           PROTOCOL_VERSION -           PROTOCOL_VERSION -
# Line 4252  Internet-Draft        LinuxSampler Contr Line 4252  Internet-Draft        LinuxSampler Contr
4252    
4253    
4254    
4255  Schoenebeck              Expires March 14, 2009                [Page 76]  Schoenebeck               Expires June 9, 2009                 [Page 76]
4256    
4257  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
4258    
4259    
4260        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 4268  Internet-Draft        LinuxSampler Contr Line 4268  Internet-Draft        LinuxSampler Contr
4268           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4269           error message           error message
4270    
4271    6.6.8.  Getting global voice limit
4272    
4273       The client can ask for the current global sampler-wide limit for
4274       maximum voices by sending the following command:
4275    
4276          GET VOICES
4277    
4278       Possible Answers:
4279    
4280          LinuxSampler will answer by returning the number for the current
4281          limit of maximum voices.
4282    
4283       The voice limit setting defines how many voices should maximum be
4284       processed by the sampler at the same time.  If the user triggers new
4285       notes which would exceed that voice limit, the sampler engine will
4286       react by stealing old voices for those newly triggered notes.  Note
4287       that the amount of voices triggered by a new note can be larger than
4288       one and is dependent to the respective instrument and probably
4289       further criterias.
4290    
4291    6.6.9.  Setting global voice limit
4292    
4293       The client can alter the current global sampler-wide limit for
4294       maximum voices by sending the following command:
4295    
4296          SET VOICES <max-voices>
4297    
4298       Where <max-voices> should be replaced by the integer value,
4299       reflecting the new global amount limit of maximum voices.  This value
4300       has to be larger than 0.
4301    
4302       Possible Answers:
4303    
4304          "OK" -
4305    
4306             on success
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires June 9, 2009                 [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol        December 2008
4314    
4315    
4316          "WRN:<warning-code>:<warning-message>" -
4317    
4318             if the voice limit was set, but there are noteworthy issue(s)
4319             related, providing an appropriate warning code and warning
4320             message
4321    
4322          "ERR:<error-code>:<error-message>" -
4323    
4324             in case it failed, providing an appropriate error code and
4325             error message
4326    
4327       Note: the given value will be passed to all sampler engine instances.
4328       The total amount of maximum voices on the running system might thus
4329       be as big as the given value multiplied by the current amount of
4330       engine instances.
4331    
4332       Caution: when adjusting the voice limit, you SHOULD also adjust the
4333       disk stream limit respectively and vice versa.
4334    
4335    6.6.10.  Getting global disk stream limit
4336    
4337       The client can ask for the current global sampler-wide limit for
4338       maximum disk streams by sending the following command:
4339    
4340          GET STREAMS
4341    
4342       Possible Answers:
4343    
4344          LinuxSampler will answer by returning the number for the current
4345          limit of maximum disk streams.
4346    
4347       The disk stream limit setting defines how many disk streams should
4348       maximum be processed by a sampler engine at the same time.  The
4349       higher this value, the more memory (RAM) will be occupied, since
4350       every disk streams allocates a certain buffer size for being able to
4351       perform its streaming operations.
4352    
4353    6.6.11.  Setting global disk stream limit
4354    
4355       The client can alter the current global sampler-wide limit for
4356       maximum disk streams by sending the following command:
4357    
4358          SET STREAMS <max-streams>
4359    
4360       Where <max-streams> should be replaced by the integer value,
4361       reflecting the new global amount limit of maximum disk streams.  This
4362       value has to be positive.
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires June 9, 2009                 [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol        December 2008
4370    
4371    
4372       Possible Answers:
4373    
4374          "OK" -
4375    
4376             on success
4377    
4378          "WRN:<warning-code>:<warning-message>" -
4379    
4380             if the disk stream limit was set, but there are noteworthy
4381             issue(s) related, providing an appropriate warning code and
4382             warning message
4383    
4384          "ERR:<error-code>:<error-message>" -
4385    
4386             in case it failed, providing an appropriate error code and
4387             error message
4388    
4389       Note: the given value will be passed to all sampler engine instances.
4390       The total amount of maximum disk streams on the running system might
4391       thus be as big as the given value multiplied by the current amount of
4392       engine instances.
4393    
4394       Caution: when adjusting the disk stream limit, you SHOULD also adjust
4395       the voice limit respectively and vice versa.
4396    
4397  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4398    
4399     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 4291  Internet-Draft        LinuxSampler Contr Line 4417  Internet-Draft        LinuxSampler Contr
4417     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4418     channel.     channel.
4419    
4420    
4421    
4422    
4423    Schoenebeck               Expires June 9, 2009                 [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol        December 2008
4426    
4427    
4428     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
4429     to switch to another instrument.  Instead when receiving a bank     to switch to another instrument.  Instead when receiving a bank
4430     select message the bank value will be stored and a subsequent program     select message the bank value will be stored and a subsequent program
# Line 4303  Internet-Draft        LinuxSampler Contr Line 4437  Internet-Draft        LinuxSampler Contr
4437     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
4438     following command:     following command:
4439    
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4440        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4441    
4442     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
# Line 4347  Internet-Draft        LinuxSampler Contr Line 4471  Internet-Draft        LinuxSampler Contr
4471    
4472        S: "OK[5]"        S: "OK[5]"
4473    
4474    
4475    
4476    
4477    
4478    
4479    Schoenebeck               Expires June 9, 2009                 [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol        December 2008
4482    
4483    
4484  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
4485    
4486     The front-end can delete a particular MIDI instrument map by sending     The front-end can delete a particular MIDI instrument map by sending
# Line 4360  Internet-Draft        LinuxSampler Contr Line 4494  Internet-Draft        LinuxSampler Contr
4494     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4495     following command:     following command:
4496    
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4497        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4498    
4499     Possible Answers:     Possible Answers:
# Line 4405  Internet-Draft        LinuxSampler Contr Line 4530  Internet-Draft        LinuxSampler Contr
4530    
4531     Example:     Example:
4532    
4533    
4534    
4535    Schoenebeck               Expires June 9, 2009                 [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol        December 2008
4538    
4539    
4540        C: "GET MIDI_INSTRUMENT_MAPS"        C: "GET MIDI_INSTRUMENT_MAPS"
4541    
4542        S: "2"        S: "2"
# Line 4415  Internet-Draft        LinuxSampler Contr Line 4547  Internet-Draft        LinuxSampler Contr
4547     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4548     following command:     following command:
4549    
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4550        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4551    
4552     Possible Answers:     Possible Answers:
# Line 4463  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585    
4586              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
4587              unique (note that this character string may contain escape              unique (note that this character string may contain escape
4588    
4589    
4590    
4591    Schoenebeck               Expires June 9, 2009                 [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol        December 2008
4594    
4595    
4596              sequences (Section 7.1))              sequences (Section 7.1))
4597    
4598           DEFAULT -           DEFAULT -
# Line 4474  Internet-Draft        LinuxSampler Contr Line 4604  Internet-Draft        LinuxSampler Contr
4604    
4605     Example:     Example:
4606    
   
   
 Schoenebeck              Expires March 14, 2009                [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4607        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4608    
4609        S: "NAME: Standard Map"        S: "NAME: Standard Map"
# Line 4518  Internet-Draft        LinuxSampler Contr Line 4641  Internet-Draft        LinuxSampler Contr
4641    
4642        S: "OK"        S: "OK"
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires June 9, 2009                 [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol        December 2008
4650    
4651    
4652  6.7.7.  Create or replace a MIDI instrument map entry  6.7.7.  Create or replace a MIDI instrument map entry
4653    
4654     The front-end can create a new or replace an existing entry in a     The front-end can create a new or replace an existing entry in a
# Line 4529  Internet-Draft        LinuxSampler Contr Line 4660  Internet-Draft        LinuxSampler Contr
4660    
4661     Where <map> is the numeric ID of the map to alter, <midi_bank> is an     Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4662     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4663     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4664     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4665     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
# Line 4573  Internet-Draft        LinuxSampler Contr Line 4696  Internet-Draft        LinuxSampler Contr
4696    
4697        "PERSISTENT" -        "PERSISTENT" -
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires June 9, 2009                 [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol        December 2008
4706    
4707    
4708           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
4709           mapping command is sent and the instrument is kept all the           mapping command is sent and the instrument is kept all the
4710           time.  Instruments with this mode are only freed when the           time.  Instruments with this mode are only freed when the
# Line 4585  Internet-Draft        LinuxSampler Contr Line 4717  Internet-Draft        LinuxSampler Contr
4717           In case there is no <instr_load_mode> argument given, it will           In case there is no <instr_load_mode> argument given, it will
4718           be up to the InstrumentManager to decide which mode to use.           be up to the InstrumentManager to decide which mode to use.
4719           Usually it will use "ON_DEMAND" if an entry for the given           Usually it will use "ON_DEMAND" if an entry for the given
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4720           instrument does not exist in the InstrumentManager's list yet,           instrument does not exist in the InstrumentManager's list yet,
4721           otherwise if an entry already exists, it will simply stick with           otherwise if an entry already exists, it will simply stick with
4722           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
# Line 4629  Internet-Draft        LinuxSampler Contr Line 4753  Internet-Draft        LinuxSampler Contr
4753     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4754     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4755     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
4756    
4757    
4758    
4759    Schoenebeck               Expires June 9, 2009                 [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol        December 2008
4762    
4763    
4764     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4765     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4766     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4640  Internet-Draft        LinuxSampler Contr Line 4772  Internet-Draft        LinuxSampler Contr
4772    
4773           usually           usually
4774    
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4775        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4776    
4777           when the given map or engine does not exist or a value is out           when the given map or engine does not exist or a value is out
# Line 4686  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809     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
4810     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4811    
       GET MIDI_INSTRUMENTS <map>  
   
    The front-end can query the amount of currently existing entries in  
    all MIDI instrument maps by sending the following command:  
4812    
       GET MIDI_INSTRUMENTS ALL  
   
    Possible Answers:  
4813    
4814    
4815    Schoenebeck               Expires June 9, 2009                 [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol        December 2008
4818    
4819    
4820          GET MIDI_INSTRUMENTS <map>
4821    
4822       The front-end can query the amount of currently existing entries in
4823       all MIDI instrument maps by sending the following command:
4824    
4825  Schoenebeck              Expires March 14, 2009                [Page 84]        GET MIDI_INSTRUMENTS ALL
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
4826    
4827       Possible Answers:
4828    
4829        The sampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
4830        in the MIDI instrument map(s).        in the MIDI instrument map(s).
# Line 4744  Internet-Draft        LinuxSampler Contr Line 4865  Internet-Draft        LinuxSampler Contr
4865    
4866     Example:     Example:
4867    
       C: "LIST MIDI_INSTRUMENTS 0"  
4868    
       S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"  
4869    
 6.7.10.  Remove an entry from the MIDI instrument map  
4870    
4871     The front-end can delete an entry from a MIDI instrument map by  Schoenebeck               Expires June 9, 2009                 [Page 87]
4872     sending the following command:  
4873    Internet-Draft        LinuxSampler Control Protocol        December 2008
4874    
4875    
4876          C: "LIST MIDI_INSTRUMENTS 0"
4877    
4878          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4879    
4880  Schoenebeck              Expires March 14, 2009                [Page 85]  6.7.10.  Remove an entry from the MIDI instrument map
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
4881    
4882       The front-end can delete an entry from a MIDI instrument map by
4883       sending the following command:
4884    
4885        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4886    
# Line 4799  Internet-Draft        LinuxSampler Contr Line 4920  Internet-Draft        LinuxSampler Contr
4920    
4921     Possible Answers:     Possible Answers:
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires June 9, 2009                 [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol        December 2008
4930    
4931    
4932        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4933        answer line begins with the information category name followed by        answer line begins with the information category name followed by
4934        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 4809  Internet-Draft        LinuxSampler Contr Line 4939  Internet-Draft        LinuxSampler Contr
4939    
4940           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
4941           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
4942           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
4943           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4944           be unique. (note that this character string may contain escape           be unique. (note that this character string may contain escape
# Line 4853  Internet-Draft        LinuxSampler Contr Line 4975  Internet-Draft        LinuxSampler Contr
4975           (where a value < 1.0 means attenuation and a value > 1.0 means           (where a value < 1.0 means attenuation and a value > 1.0 means
4976           amplification)           amplification)
4977    
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires June 9, 2009                 [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol        December 2008
4986    
4987    
4988        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
4989    
4990     Example:     Example:
# Line 4865  Internet-Draft        LinuxSampler Contr Line 4997  Internet-Draft        LinuxSampler Contr
4997    
4998           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4999    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5000           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
5001    
5002           "INSTRUMENT_NAME: Joe's Drumkit"           "INSTRUMENT_NAME: Joe's Drumkit"
# Line 4909  Internet-Draft        LinuxSampler Contr Line 5033  Internet-Draft        LinuxSampler Contr
5033    
5034     Examples:     Examples:
5035    
       C: "CLEAR MIDI_INSTRUMENTS 0"  
   
       S: "OK"  
   
       C: "CLEAR MIDI_INSTRUMENTS ALL"  
   
       S: "OK"  
   
5036    
5037    
5038    
5039    Schoenebeck               Expires June 9, 2009                 [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol        December 2008
5042    
5043    
5044          C: "CLEAR MIDI_INSTRUMENTS 0"
5045    
5046          S: "OK"
5047    
5048  Schoenebeck              Expires March 14, 2009                [Page 88]        C: "CLEAR MIDI_INSTRUMENTS ALL"
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
5049    
5050          S: "OK"
5051    
5052  6.8.  Managing Instruments Database  6.8.  Managing Instruments Database
5053    
# Line 4968  Internet-Draft        LinuxSampler Contr Line 5088  Internet-Draft        LinuxSampler Contr
5088    
5089     Examples:     Examples:
5090    
       C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"  
5091    
       S: "OK"  
5092    
 6.8.2.  Deleting an instrument directory  
5093    
    The front-end can delete a particular instrument directory from the  
    instruments database by sending the following command:  
5094    
5095    Schoenebeck               Expires June 9, 2009                 [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol        December 2008
5098    
5099    
5100          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
5101    
5102  Schoenebeck              Expires March 14, 2009                [Page 89]        S: "OK"
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
5103    
5104    6.8.2.  Deleting an instrument directory
5105    
5106       The front-end can delete a particular instrument directory from the
5107       instruments database by sending the following command:
5108    
5109        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
5110    
# Line 5022  Internet-Draft        LinuxSampler Contr Line 5143  Internet-Draft        LinuxSampler Contr
5143    
5144     Possible Answers:     Possible Answers:
5145    
       The current number of instrument directories in the specified  
       directory.  
5146    
       "ERR:<error-code>:<error-message>" -  
5147    
          if the given directory does not exist.  
5148    
    Example:  
5149    
5150    
5151    Schoenebeck               Expires June 9, 2009                 [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol        December 2008
5154    
5155    
5156          The current number of instrument directories in the specified
5157          directory.
5158    
5159          "ERR:<error-code>:<error-message>" -
5160    
5161  Schoenebeck              Expires March 14, 2009                [Page 90]           if the given directory does not exist.
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
5162    
5163       Example:
5164    
5165        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
5166    
# Line 5077  Internet-Draft        LinuxSampler Contr Line 5198  Internet-Draft        LinuxSampler Contr
5198        S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano        S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
5199        Collection/Acoustic/New','/Percussion Collection'"        Collection/Acoustic/New','/Percussion Collection'"
5200    
5201    
5202    
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires June 9, 2009                 [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol        December 2008
5210    
5211    
5212  6.8.5.  Getting instrument directory information  6.8.5.  Getting instrument directory information
5213    
5214     The front-end can ask for the current settings of an instrument     The front-end can ask for the current settings of an instrument
# Line 5089  Internet-Draft        LinuxSampler Contr Line 5221  Internet-Draft        LinuxSampler Contr
5221    
5222     Possible Answers:     Possible Answers:
5223    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5224        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5225        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5226        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
# Line 5133  Internet-Draft        LinuxSampler Contr Line 5257  Internet-Draft        LinuxSampler Contr
5257    
5258           "MODIFIED: 2007-04-07 12:50:21"           "MODIFIED: 2007-04-07 12:50:21"
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires June 9, 2009                 [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol        December 2008
5266    
5267    
5268           "."           "."
5269    
5270  6.8.6.  Renaming an instrument directory  6.8.6.  Renaming an instrument directory
# Line 5145  Internet-Draft        LinuxSampler Contr Line 5277  Internet-Draft        LinuxSampler Contr
5277     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
5278     the new name for that directory.     the new name for that directory.
5279    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5280     Possible Answers:     Possible Answers:
5281    
5282        "OK" -        "OK" -
# Line 5187  Internet-Draft        LinuxSampler Contr Line 5311  Internet-Draft        LinuxSampler Contr
5311    
5312           on success           on success
5313    
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires June 9, 2009                 [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol        December 2008
5322    
5323    
5324        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5325    
5326           in case a given directory does not exists, or if a directory           in case a given directory does not exists, or if a directory
# Line 5201  Internet-Draft        LinuxSampler Contr Line 5335  Internet-Draft        LinuxSampler Contr
5335    
5336        S: "OK"        S: "OK"
5337    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5338  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
5339    
5340     The front-end can copy a specific instrument directory by sending the     The front-end can copy a specific instrument directory by sending the
# Line 5239  Internet-Draft        LinuxSampler Contr Line 5365  Internet-Draft        LinuxSampler Contr
5365    
5366        S: "OK"        S: "OK"
5367    
5368    
5369    
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires June 9, 2009                 [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol        December 2008
5378    
5379    
5380  6.8.9.  Changing the description of directory  6.8.9.  Changing the description of directory
5381    
5382     The front-end can alter the description of a specific instrument     The front-end can alter the description of a specific instrument
# Line 5257  Internet-Draft        LinuxSampler Contr Line 5395  Internet-Draft        LinuxSampler Contr
5395    
5396           on success           on success
5397    
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5398        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5399    
5400           in case the given directory does not exists.           in case the given directory does not exists.
# Line 5295  Internet-Draft        LinuxSampler Contr Line 5425  Internet-Draft        LinuxSampler Contr
5425    
5426        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5427        supplied search string (encapsulated into apostrophes, supporting        supplied search string (encapsulated into apostrophes, supporting
5428    
5429    
5430    
5431    Schoenebeck               Expires June 9, 2009                 [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol        December 2008
5434    
5435    
5436        escape sequences as described in chapter "Character Set and Escape        escape sequences as described in chapter "Character Set and Escape
5437        Sequences (Section 7.1)").        Sequences (Section 7.1)").
5438    
# Line 5313  Internet-Draft        LinuxSampler Contr Line 5451  Internet-Draft        LinuxSampler Contr
5451        modification satisfies the specified period, where <date-after>        modification satisfies the specified period, where <date-after>
5452        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-
5453        after> is omitted the search is restricted to directories, which        after> is omitted the search is restricted to directories, which
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 95]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5454        are last modified before <date-before>.  If <date-before> is        are last modified before <date-before>.  If <date-before> is
5455        omitted, the search is restricted to directories, which are last        omitted, the search is restricted to directories, which are last
5456        modified after <date-after>.        modified after <date-after>.
# Line 5351  Internet-Draft        LinuxSampler Contr Line 5481  Internet-Draft        LinuxSampler Contr
5481    
5482        S: "'/Piano Collection'"        S: "'/Piano Collection'"
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires June 9, 2009                 [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol        December 2008
5490    
5491    
5492        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5493        30:13'"        30:13'"
5494    
# Line 5361  Internet-Draft        LinuxSampler Contr Line 5499  Internet-Draft        LinuxSampler Contr
5499     The front-end can add one or more instruments to the instruments     The front-end can add one or more instruments to the instruments
5500     database by sending the following command:     database by sending the following command:
5501    
5502        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir>
5503        [<instr_index>]        <file_path> [<instr_index>]
5504    
5505     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5506     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
5507     instruments (that are not already in the database) will be added,     instruments (that are not already in the database) will be added,
5508     <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
5509     file system (encapsulated into apostrophes).  In case an instrument     file system (encapsulated into apostrophes).  In case an instrument
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 96]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5510     file is supplied, only the instruments in the specified file will be     file is supplied, only the instruments in the specified file will be
5511     added to the instruments database.  If the optional <instr_index>     added to the instruments database.  If the optional <instr_index>
5512     (the index of the instrument within the given file) is supplied too,     (the index of the instrument within the given file) is supplied too,
# Line 5404  Internet-Draft        LinuxSampler Contr Line 5534  Internet-Draft        LinuxSampler Contr
5534           not be recreated in the instruments database.  All instruments           not be recreated in the instruments database.  All instruments
5535           will be added directly in the specified database directory.           will be added directly in the specified database directory.
5536    
5537       If FILE_AS_DIR argument is supplied, all instruments in an instrument
5538       file will be added to a separate directory in the instruments
5539       database, which name will be the name of the instrument file with the
5540    
5541    
5542    
5543    Schoenebeck               Expires June 9, 2009                 [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol        December 2008
5546    
5547    
5548       file extension stripped off.
5549    
5550     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
5551     is that the regular command returns when the scanning is finished     is that the regular command returns when the scanning is finished
5552     while NON_MODAL version returns immediately and a background process     while NON_MODAL version returns immediately and a background process
# Line 5424  Internet-Draft        LinuxSampler Contr Line 5567  Internet-Draft        LinuxSampler Contr
5567    
5568        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5569    
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5570           if an invalid path is specified.           if an invalid path is specified.
5571    
5572     Examples:     Examples:
# Line 5458  Internet-Draft        LinuxSampler Contr Line 5592  Internet-Draft        LinuxSampler Contr
5592    
5593           if the instrument is removed successfully           if the instrument is removed successfully
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck               Expires June 9, 2009                [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol        December 2008
5602    
5603    
5604        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5605    
5606           if the given path does not exist or is a directory.           if the given path does not exist or is a directory.
# Line 5482  Internet-Draft        LinuxSampler Contr Line 5625  Internet-Draft        LinuxSampler Contr
5625    
5626     Possible Answers:     Possible Answers:
5627    
   
   
 Schoenebeck              Expires March 14, 2009                [Page 98]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5628        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5629    
5630        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5513  Internet-Draft        LinuxSampler Contr Line 5649  Internet-Draft        LinuxSampler Contr
5649     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5650     specified directory, will be returned.     specified directory, will be returned.
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires June 9, 2009                [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol        December 2008
5658    
5659    
5660     Possible Answers:     Possible Answers:
5661    
5662        A comma separated list of all instruments (encapsulated into        A comma separated list of all instruments (encapsulated into
# Line 5533  Internet-Draft        LinuxSampler Contr Line 5677  Internet-Draft        LinuxSampler Contr
5677        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5678        Steinway D','/Piano Collection/Lite/Free Piano'"        Steinway D','/Piano Collection/Lite/Free Piano'"
5679    
   
   
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009                [Page 99]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5680  6.8.15.  Getting instrument information  6.8.15.  Getting instrument information
5681    
5682     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 5572  Internet-Draft        LinuxSampler Contr Line 5704  Internet-Draft        LinuxSampler Contr
5704    
5705           INSTRUMENT_NR -           INSTRUMENT_NR -
5706    
5707    
5708    
5709    
5710    
5711    Schoenebeck               Expires June 9, 2009                [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol        December 2008
5714    
5715    
5716              Index of the instrument within the file.              Index of the instrument within the file.
5717    
5718           FORMAT_FAMILY -           FORMAT_FAMILY -
# Line 5592  Internet-Draft        LinuxSampler Contr Line 5733  Internet-Draft        LinuxSampler Contr
5733              instruments database, represented in "YYYY-MM-DD HH:MM:SS"              instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5734              format              format
5735    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5736           MODIFIED -           MODIFIED -
5737    
5738              The date and time of the last modification of the              The date and time of the last modification of the
# Line 5627  Internet-Draft        LinuxSampler Contr Line 5759  Internet-Draft        LinuxSampler Contr
5759              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5760              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5761    
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck               Expires June 9, 2009                [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol        December 2008
5770    
5771    
5772           KEYWORDS -           KEYWORDS -
5773    
5774              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
# Line 5648  Internet-Draft        LinuxSampler Contr Line 5790  Internet-Draft        LinuxSampler Contr
5790    
5791           "FORMAT_VERSION: 2"           "FORMAT_VERSION: 2"
5792    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 101]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5793           "SIZE: 2050871870"           "SIZE: 2050871870"
5794    
5795           "CREATED: 2007-02-05 10:23:12"           "CREATED: 2007-02-05 10:23:12"
# Line 5685  Internet-Draft        LinuxSampler Contr Line 5818  Internet-Draft        LinuxSampler Contr
5818     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
5819     is the new name for that instrument.     is the new name for that instrument.
5820    
5821    
5822    
5823    Schoenebeck               Expires June 9, 2009                [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol        December 2008
5826    
5827    
5828     Possible Answers:     Possible Answers:
5829    
5830        "OK" -        "OK" -
# Line 5703  Internet-Draft        LinuxSampler Contr Line 5843  Internet-Draft        LinuxSampler Contr
5843    
5844        S: "OK"        S: "OK"
5845    
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5846  6.8.17.  Moving an instrument  6.8.17.  Moving an instrument
5847    
5848     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 5742  Internet-Draft        LinuxSampler Contr Line 5872  Internet-Draft        LinuxSampler Contr
5872    
5873        S: "OK"        S: "OK"
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires June 9, 2009                [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol        December 2008
5882    
5883    
5884  6.8.18.  Copying instruments  6.8.18.  Copying instruments
5885    
5886     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 5760  Internet-Draft        LinuxSampler Contr Line 5899  Internet-Draft        LinuxSampler Contr
5899    
5900        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5901    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 103]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5902           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
5903           instrument with name equal to the name of the specified           instrument with name equal to the name of the specified
5904           instrument already exists in the destination directory.           instrument already exists in the destination directory.
# Line 5798  Internet-Draft        LinuxSampler Contr Line 5928  Internet-Draft        LinuxSampler Contr
5928    
5929           on success           on success
5930    
5931    
5932    
5933    
5934    
5935    Schoenebeck               Expires June 9, 2009                [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol        December 2008
5938    
5939    
5940        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5941    
5942           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5817  Internet-Draft        LinuxSampler Contr Line 5956  Internet-Draft        LinuxSampler Contr
5956        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5957    
5958     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 14, 2009               [Page 104]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
5959     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5960     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5961     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 5855  Internet-Draft        LinuxSampler Contr Line 5986  Internet-Draft        LinuxSampler Contr
5986        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
5987        instruments created after <date-after>.        instruments created after <date-after>.
5988    
5989    
5990    
5991    Schoenebeck               Expires June 9, 2009                [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol        December 2008
5994    
5995    
5996     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5997    
5998        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 5874  Internet-Draft        LinuxSampler Contr Line 6012  Internet-Draft        LinuxSampler Contr
6012    
6013     PRODUCT='<search-string>'     PRODUCT='<search-string>'
6014    
   
   
 Schoenebeck              Expires March 14, 2009               [Page 105]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6015        Restricts the search to instruments with product info that        Restricts the search to instruments with product info that
6016        satisfies the supplied search string (encapsulated into        satisfies the supplied search string (encapsulated into
6017        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 5911  Internet-Draft        LinuxSampler Contr Line 6042  Internet-Draft        LinuxSampler Contr
6042        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
6043        families.        families.
6044    
6045    
6046    
6047    Schoenebeck               Expires June 9, 2009                [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol        December 2008
6050    
6051    
6052     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
6053     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
6054    
# Line 5929  Internet-Draft        LinuxSampler Contr Line 6067  Internet-Draft        LinuxSampler Contr
6067        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
6068        290'"        290'"
6069    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 106]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6070        S: "'/Piano Collection/Bosendorfer 290'"        S: "'/Piano Collection/Bosendorfer 290'"
6071    
6072        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
# Line 5967  Internet-Draft        LinuxSampler Contr Line 6097  Internet-Draft        LinuxSampler Contr
6097    
6098           FILES_TOTAL -           FILES_TOTAL -
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires June 9, 2009                [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol        December 2008
6106    
6107    
6108              The total number of files scheduled for scanning              The total number of files scheduled for scanning
6109    
6110           FILES_SCANNED -           FILES_SCANNED -
# Line 5986  Internet-Draft        LinuxSampler Contr Line 6124  Internet-Draft        LinuxSampler Contr
6124    
6125     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
6126    
   
   
 Schoenebeck              Expires March 14, 2009               [Page 107]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6127     Example:     Example:
6128    
6129        C: "GET DB_INSTRUMENTS_JOB INFO 2"        C: "GET DB_INSTRUMENTS_JOB INFO 2"
# Line 6021  Internet-Draft        LinuxSampler Contr Line 6152  Internet-Draft        LinuxSampler Contr
6152    
6153           on success           on success
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck               Expires June 9, 2009                [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol        December 2008
6162    
6163    
6164        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6165    
6166           If the formatting of the instruments database failed.           If the formatting of the instruments database failed.
# Line 6040  Internet-Draft        LinuxSampler Contr Line 6180  Internet-Draft        LinuxSampler Contr
6180    
6181        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6182    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 108]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6183           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
6184           error message.           error message.
6185    
# Line 6076  Internet-Draft        LinuxSampler Contr Line 6207  Internet-Draft        LinuxSampler Contr
6207    
6208           on success           on success
6209    
6210    
6211    
6212    
6213    
6214    
6215    Schoenebeck               Expires June 9, 2009                [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol        December 2008
6218    
6219    
6220        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6221    
6222           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 6097  Internet-Draft        LinuxSampler Contr Line 6238  Internet-Draft        LinuxSampler Contr
6238     directory.  The sampler will automatically try to load all plugin     directory.  The sampler will automatically try to load all plugin
6239     DLLs in that directory on startup and only on startup!     DLLs in that directory on startup and only on startup!
6240    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 109]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6241     At the moment there is only one command for this feature set, but     At the moment there is only one command for this feature set, but
6242     this will most probably change in future.     this will most probably change in future.
6243    
# Line 6133  Internet-Draft        LinuxSampler Contr Line 6266  Internet-Draft        LinuxSampler Contr
6266     Note: consequently instrument editors are always spawned locally on     Note: consequently instrument editors are always spawned locally on
6267     the same machine where the sampler is running on!     the same machine where the sampler is running on!
6268    
6269    
6270    
6271    Schoenebeck               Expires June 9, 2009                [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol        December 2008
6274    
6275    
6276     Possible Answers:     Possible Answers:
6277    
6278        "OK" -        "OK" -
# Line 6152  Internet-Draft        LinuxSampler Contr Line 6292  Internet-Draft        LinuxSampler Contr
6292    
6293        C: "EDIT CHANNEL INSTRUMENT 0"        C: "EDIT CHANNEL INSTRUMENT 0"
6294    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 110]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6295        S: "OK"        S: "OK"
6296    
6297  6.10.  Managing Files  6.10.  Managing Files
# Line 6190  Internet-Draft        LinuxSampler Contr Line 6321  Internet-Draft        LinuxSampler Contr
6321        On success, the sampler will answer by returning the amount of        On success, the sampler will answer by returning the amount of
6322        instruments.        instruments.
6323    
6324    
6325    
6326    
6327    Schoenebeck               Expires June 9, 2009                [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol        December 2008
6330    
6331    
6332        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6333    
6334           if the file could not be handled           if the file could not be handled
# Line 6209  Internet-Draft        LinuxSampler Contr Line 6348  Internet-Draft        LinuxSampler Contr
6348    
6349     Where <filename> is the name of the instrument file (encapsulated     Where <filename> is the name of the instrument file (encapsulated
6350     into apostrophes, supporting escape sequences as described in chapter     into apostrophes, supporting escape sequences as described in chapter
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 111]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6351     "Character Set and Escape Sequences (Section 7.1)").     "Character Set and Escape Sequences (Section 7.1)").
6352    
6353     The sampler will try to ask all sampler engines, whether they support     The sampler will try to ask all sampler engines, whether they support
# Line 6244  Internet-Draft        LinuxSampler Contr Line 6375  Internet-Draft        LinuxSampler Contr
6375     instrument within a given instrument file by sending the following     instrument within a given instrument file by sending the following
6376     command:     command:
6377    
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck               Expires June 9, 2009                [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol        December 2008
6386    
6387    
6388        GET FILE INSTRUMENT INFO <filename> <instr-id>        GET FILE INSTRUMENT INFO <filename> <instr-id>
6389    
6390     Where <filename> is the name of the instrument file (encapsulated     Where <filename> is the name of the instrument file (encapsulated
# Line 6266  Internet-Draft        LinuxSampler Contr Line 6407  Internet-Draft        LinuxSampler Contr
6407    
6408    
6409    
   
   
 Schoenebeck              Expires March 14, 2009               [Page 112]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
   
   
6410           NAME -           NAME -
6411    
6412              name of the instrument as stored in the instrument file              name of the instrument as stored in the instrument file
# Line 6302  Internet-Draft        LinuxSampler Contr Line 6434  Internet-Draft        LinuxSampler Contr
6434              instrument's key mapping in the range between 0 .. 127,              instrument's key mapping in the range between 0 .. 127,
6435              reflecting the analog meaning of the MIDI specification.              reflecting the analog meaning of the MIDI specification.
6436    
6437    
6438    
6439    Schoenebeck               Expires June 9, 2009                [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol        December 2008
6442    
6443    
6444           KEYSWITCH_BINDINGS -           KEYSWITCH_BINDINGS -
6445    
6446              comma separated list of integer values representing the              comma separated list of integer values representing the
# Line 6321  Internet-Draft        LinuxSampler Contr Line 6460  Internet-Draft        LinuxSampler Contr
6460    
6461           "FORMAT_VERSION: 3"           "FORMAT_VERSION: 3"
6462    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 113]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
6463           "PRODUCT: The Backbone Bongo Beats"           "PRODUCT: The Backbone Bongo Beats"
6464    
6465           "ARTISTS: Jimmy the Fish"           "ARTISTS: Jimmy the Fish"
# Line 6361  Internet-Draft        LinuxSampler Contr Line 6492  Internet-Draft        LinuxSampler Contr
6492    
6493    
6494    
6495    Schoenebeck               Expires June 9, 2009                [Page 116]
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 114]  
6496    
6497  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
6498    
6499    
6500  7.  Command Syntax  7.  Command Syntax
# Line 6436  Internet-Draft        LinuxSampler Contr Line 6548  Internet-Draft        LinuxSampler Contr
6548    
6549    
6550    
6551  Schoenebeck              Expires March 14, 2009               [Page 115]  Schoenebeck               Expires June 9, 2009                [Page 117]
6552    
6553  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
6554    
6555    
6556        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6467  Internet-Draft        LinuxSampler Contr Line 6579  Internet-Draft        LinuxSampler Contr
6579    
6580        / FORMAT SP format_instruction        / FORMAT SP format_instruction
6581    
6582        SEND SP send_instruction        / SEND SP send_instruction
6583    
6584        / RESET        / RESET
6585    
# Line 6481  Internet-Draft        LinuxSampler Contr Line 6593  Internet-Draft        LinuxSampler Contr
6593    
6594        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6595    
6596          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP
6597          db_path SP filename
6598    
6599        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6600    
6601        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename        / DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP
6602          filename
6603    
       / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP  
       instrument_index  
6604    
6605    
6606    
6607    Schoenebeck               Expires June 9, 2009                [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol        December 2008
6610    
6611    
6612  Schoenebeck              Expires March 14, 2009               [Page 116]        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
6613    
6614          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6615          instrument_index
6616    
6617        / DB_INSTRUMENTS SP db_path SP filename        / DB_INSTRUMENTS SP db_path SP filename
6618    
# Line 6539  Internet-Draft        LinuxSampler Contr Line 6656  Internet-Draft        LinuxSampler Contr
6656    
6657        / MIDI_INSTRUMENT_COUNT        / MIDI_INSTRUMENT_COUNT
6658    
       / MIDI_INSTRUMENT_INFO  
6659    
       / DB_INSTRUMENT_DIRECTORY_COUNT  
6660    
       / DB_INSTRUMENT_DIRECTORY_INFO  
6661    
6662    
6663    Schoenebeck               Expires June 9, 2009                [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol        December 2008
6666    
6667    
6668  Schoenebeck              Expires March 14, 2009               [Page 117]        / MIDI_INSTRUMENT_INFO
6669    
6670  Internet-Draft        LinuxSampler Control Protocol       September 2008        / DB_INSTRUMENT_DIRECTORY_COUNT
6671    
6672          / DB_INSTRUMENT_DIRECTORY_INFO
6673    
6674        / DB_INSTRUMENT_COUNT        / DB_INSTRUMENT_COUNT
6675    
# Line 6595  Internet-Draft        LinuxSampler Contr Line 6713  Internet-Draft        LinuxSampler Contr
6713    
6714        / FX_SEND_INFO        / FX_SEND_INFO
6715    
       / MIDI_INSTRUMENT_MAP_COUNT  
6716    
       / MIDI_INSTRUMENT_MAP_INFO  
6717    
       / MIDI_INSTRUMENT_COUNT  
6718    
6719    Schoenebeck               Expires June 9, 2009                [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol        December 2008
6722    
6723    
6724          / MIDI_INSTRUMENT_MAP_COUNT
6725    
6726  Schoenebeck              Expires March 14, 2009               [Page 118]        / MIDI_INSTRUMENT_MAP_INFO
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
6727    
6728          / MIDI_INSTRUMENT_COUNT
6729    
6730        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
6731    
# Line 6652  Internet-Draft        LinuxSampler Contr Line 6770  Internet-Draft        LinuxSampler Contr
6770    
6771     remove_instruction =     remove_instruction =
6772    
       CHANNEL SP sampler_channel  
   
       / MIDI_INSTRUMENT_MAP SP midi_map  
   
6773    
6774    
6775    Schoenebeck               Expires June 9, 2009                [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol        December 2008
6778    
6779    
6780  Schoenebeck              Expires March 14, 2009               [Page 119]        CHANNEL SP sampler_channel
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
6781    
6782          / MIDI_INSTRUMENT_MAP SP midi_map
6783    
6784        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6785    
# Line 6709  Internet-Draft        LinuxSampler Contr Line 6825  Internet-Draft        LinuxSampler Contr
6825    
6826        / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number        / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
6827    
       / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP  
       string  
   
   
6828    
6829    
6830    
6831  Schoenebeck              Expires March 14, 2009               [Page 120]  Schoenebeck               Expires June 9, 2009                [Page 122]
6832    
6833  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
6834    
6835    
6836          / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
6837          string
6838    
6839        / CHANNELS        / CHANNELS
6840    
6841        / CHANNEL SP INFO SP sampler_channel        / CHANNEL SP INFO SP sampler_channel
# Line 6765  Internet-Draft        LinuxSampler Contr Line 6880  Internet-Draft        LinuxSampler Contr
6880    
6881        / DB_INSTRUMENTS SP db_path        / DB_INSTRUMENTS SP db_path
6882    
       / DB_INSTRUMENT SP INFO SP db_path  
   
       / DB_INSTRUMENTS_JOB SP INFO SP number  
6883    
6884    
6885    
6886    
6887  Schoenebeck              Expires March 14, 2009               [Page 121]  Schoenebeck               Expires June 9, 2009                [Page 123]
6888    
6889  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
6890    
6891    
6892          / DB_INSTRUMENT SP INFO SP db_path
6893    
6894          / DB_INSTRUMENTS_JOB SP INFO SP number
6895    
6896        / VOLUME        / VOLUME
6897    
6898          / VOICES
6899    
6900          / STREAMS
6901    
6902        / FILE SP INSTRUMENTS SP filename        / FILE SP INSTRUMENTS SP filename
6903    
6904        / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index        / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
# Line 6816  Internet-Draft        LinuxSampler Contr Line 6936  Internet-Draft        LinuxSampler Contr
6936    
6937        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6938    
       / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP  
       stringval_escaped  
6939    
       / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped  
6940    
       / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped  
6941    
       / DB_INSTRUMENT SP FILE_PATH SP filename SP filename  
6942    
6943    Schoenebeck               Expires June 9, 2009                [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol        December 2008
6946    
6947    
6948          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6949          stringval_escaped
6950    
6951  Schoenebeck              Expires March 14, 2009               [Page 122]        / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
6952    
6953          / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6954    
6955          / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6956    
6957        / ECHO SP boolean        / ECHO SP boolean
6958    
6959        / VOLUME SP volume_value        / VOLUME SP volume_value
6960    
6961          / VOICES SP number
6962    
6963          / STREAMS SP number
6964    
6965     create_instruction =     create_instruction =
6966    
6967        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 6867  Internet-Draft        LinuxSampler Contr Line 6992  Internet-Draft        LinuxSampler Contr
6992    
6993        / DB_INSTRUMENTS SP db_path SP query_val_list        / DB_INSTRUMENTS SP db_path SP query_val_list
6994    
6995    
6996    
6997    
6998    
6999    Schoenebeck               Expires June 9, 2009                [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol        December 2008
7002    
7003    
7004        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
7005        query_val_list        query_val_list
7006    
# Line 6882  Internet-Draft        LinuxSampler Contr Line 7016  Internet-Draft        LinuxSampler Contr
7016    
7017     copy_instruction =     copy_instruction =
7018    
   
   
 Schoenebeck              Expires March 14, 2009               [Page 123]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7019        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
7020    
7021        / DB_INSTRUMENT SP db_path SP db_path        / DB_INSTRUMENT SP db_path SP db_path
# Line 6921  Internet-Draft        LinuxSampler Contr Line 7048  Internet-Draft        LinuxSampler Contr
7048    
7049        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck               Expires June 9, 2009                [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol        December 2008
7058    
7059    
7060        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
7061    
7062        / MIDI_INPUT_CHANNEL SP sampler_channel SP        / MIDI_INPUT_CHANNEL SP sampler_channel SP
# Line 6936  Internet-Draft        LinuxSampler Contr Line 7072  Internet-Draft        LinuxSampler Contr
7072    
7073        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
7074    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 124]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7075        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
7076    
7077        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
# Line 6977  Internet-Draft        LinuxSampler Contr Line 7104  Internet-Draft        LinuxSampler Contr
7104    
7105     list_instruction =     list_instruction =
7106    
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires June 9, 2009                [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol        December 2008
7114    
7115    
7116        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
7117    
7118        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 6993  Internet-Draft        LinuxSampler Contr Line 7129  Internet-Draft        LinuxSampler Contr
7129    
7130        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
7131    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 125]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7132        / MIDI_INSTRUMENT_MAPS        / MIDI_INSTRUMENT_MAPS
7133    
7134        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
# Line 7032  Internet-Draft        LinuxSampler Contr Line 7160  Internet-Draft        LinuxSampler Contr
7160    
7161     instr_load_mode =     instr_load_mode =
7162    
7163    
7164    
7165    
7166    
7167    Schoenebeck               Expires June 9, 2009                [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol        December 2008
7170    
7171    
7172        ON_DEMAND        ON_DEMAND
7173    
7174        / ON_DEMAND_HOLD        / ON_DEMAND_HOLD
# Line 7048  Internet-Draft        LinuxSampler Contr Line 7185  Internet-Draft        LinuxSampler Contr
7185    
7186     audio_output_type_name =     audio_output_type_name =
7187    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 126]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7188        string        string
7189    
7190     midi_input_port_index =     midi_input_port_index =
# Line 7089  Internet-Draft        LinuxSampler Contr Line 7217  Internet-Draft        LinuxSampler Contr
7217    
7218        number        number
7219    
7220    
7221    
7222    
7223    Schoenebeck               Expires June 9, 2009                [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol        December 2008
7226    
7227    
7228     volume_value =     volume_value =
7229    
7230        dotnum        dotnum
# Line 7105  Internet-Draft        LinuxSampler Contr Line 7241  Internet-Draft        LinuxSampler Contr
7241    
7242     fx_send_id =     fx_send_id =
7243    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 127]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7244        number        number
7245    
7246     engine_name =     engine_name =
# Line 7145  Internet-Draft        LinuxSampler Contr Line 7273  Internet-Draft        LinuxSampler Contr
7273    
7274        / param_val_list','param_val        / param_val_list','param_val
7275    
7276    
7277    
7278    
7279    Schoenebeck               Expires June 9, 2009                [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol        December 2008
7282    
7283    
7284     param_val =     param_val =
7285    
7286        string        string
# Line 7161  Internet-Draft        LinuxSampler Contr Line 7297  Internet-Draft        LinuxSampler Contr
7297    
7298        / query_val_list SP string '=' query_val        / query_val_list SP string '=' query_val
7299    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 128]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7300     query_val =     query_val =
7301    
7302        text_escaped        text_escaped
# Line 7193  Internet-Draft        LinuxSampler Contr Line 7321  Internet-Draft        LinuxSampler Contr
7321     certain, explicitly declared parts of the protocol.  The supported     certain, explicitly declared parts of the protocol.  The supported
7322     escape sequences are defined as follows:     escape sequences are defined as follows:
7323    
7324    
7325    
7326    
7327    
7328    
7329    
7330    
7331    
7332    
7333    
7334    
7335    Schoenebeck               Expires June 9, 2009                [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol        December 2008
7338    
7339    
7340     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
7341     | ASCII Character        | Translated into (Name)                   |     | ASCII Character        | Translated into (Name)                   |
7342     | Sequence               |                                          |     | Sequence               |                                          |
# Line 7216  Internet-Draft        LinuxSampler Contr Line 7360  Internet-Draft        LinuxSampler Contr
7360     | \OOO                   | three digit octal ASCII code of the      |     | \OOO                   | three digit octal ASCII code of the      |
7361     |                        | character                                |     |                        | character                                |
7362     |                        |                                          |     |                        |                                          |
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 129]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7363     | \xHH                   | two digit hex ASCII code of the          |     | \xHH                   | two digit hex ASCII code of the          |
7364     |                        | character                                |     |                        | character                                |
7365     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 7249  Internet-Draft        LinuxSampler Contr Line 7384  Internet-Draft        LinuxSampler Contr
7384    
7385        "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)        "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7386    
7387    
7388    
7389    
7390    
7391    Schoenebeck               Expires June 9, 2009                [Page 132]
7392    
7393    Internet-Draft        LinuxSampler Control Protocol        December 2008
7394    
7395    
7396        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
7397    
7398        "ADD DB_INSTRUMENTS" (Section 6.8.11)        "ADD DB_INSTRUMENTS" (Section 6.8.11)
# Line 7273  Internet-Draft        LinuxSampler Contr Line 7417  Internet-Draft        LinuxSampler Contr
7417    
7418        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7419    
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 130]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7420        "SET DB_INSTRUMENT NAME" (Section 6.8.16)        "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7421    
7422        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
# Line 7305  Internet-Draft        LinuxSampler Contr Line 7441  Internet-Draft        LinuxSampler Contr
7441    
7442        "LIST FILE INSTRUMENTS" (Section 6.10.2)        "LIST FILE INSTRUMENTS" (Section 6.10.2)
7443    
7444    
7445    
7446    
7447    Schoenebeck               Expires June 9, 2009                [Page 133]
7448    
7449    Internet-Draft        LinuxSampler Control Protocol        December 2008
7450    
7451    
7452        "GET FILE INSTRUMENT INFO" (Section 6.10.3)        "GET FILE INSTRUMENT INFO" (Section 6.10.3)
7453    
7454     Note that the forward slash character ('/') has a special meaning in     Note that the forward slash character ('/') has a special meaning in
# Line 7328  Internet-Draft        LinuxSampler Contr Line 7472  Internet-Draft        LinuxSampler Contr
7472    
7473        "GET SERVER INFO" (Section 6.6.5)        "GET SERVER INFO" (Section 6.6.5)
7474    
   
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 131]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
7475        "GET ENGINE INFO" (Section 6.4.9)        "GET ENGINE INFO" (Section 6.4.9)
7476    
7477        "GET CHANNEL INFO" (Section 6.4.10)        "GET CHANNEL INFO" (Section 6.4.10)
# Line 7361  Internet-Draft        LinuxSampler Contr Line 7496  Internet-Draft        LinuxSampler Contr
7496    
7497        "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)        "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7498    
7499    
7500    
7501    
7502    
7503    Schoenebeck               Expires June 9, 2009                [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol        December 2008
7506    
7507    
7508        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7509    
7510        "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)        "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
# Line 7388  Internet-Draft        LinuxSampler Contr Line 7532  Internet-Draft        LinuxSampler Contr
7532    
7533    
7534    
7535  Schoenebeck              Expires March 14, 2009               [Page 132]  
7536    
7537    
7538    
7539    
7540    
7541    
7542    
7543    
7544    
7545    
7546    
7547    
7548    
7549    
7550    
7551    
7552    
7553    
7554    
7555    
7556    
7557    
7558    
7559    Schoenebeck               Expires June 9, 2009                [Page 135]
7560    
7561  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
7562    
7563    
7564  8.  Events  8.  Events
# Line 7444  Internet-Draft        LinuxSampler Contr Line 7612  Internet-Draft        LinuxSampler Contr
7612    
7613    
7614    
7615  Schoenebeck              Expires March 14, 2009               [Page 133]  Schoenebeck               Expires June 9, 2009                [Page 136]
7616    
7617  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
7618    
7619    
7620        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 7500  Internet-Draft        LinuxSampler Contr Line 7668  Internet-Draft        LinuxSampler Contr
7668    
7669    
7670    
7671  Schoenebeck              Expires March 14, 2009               [Page 134]  Schoenebeck               Expires June 9, 2009                [Page 137]
7672    
7673  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
7674    
7675    
7676        "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"        "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"
# Line 7556  Internet-Draft        LinuxSampler Contr Line 7724  Internet-Draft        LinuxSampler Contr
7724    
7725    
7726    
7727  Schoenebeck              Expires March 14, 2009               [Page 135]  Schoenebeck               Expires June 9, 2009                [Page 138]
7728    
7729  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
7730    
7731    
7732        SUBSCRIBE VOICE_COUNT        SUBSCRIBE VOICE_COUNT
# Line 7612  Internet-Draft        LinuxSampler Contr Line 7780  Internet-Draft        LinuxSampler Contr
7780    
7781    
7782    
7783  Schoenebeck              Expires March 14, 2009               [Page 136]  Schoenebeck               Expires June 9, 2009                [Page 139]
7784    
7785  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
7786    
7787    
7788        SUBSCRIBE CHANNEL_INFO        SUBSCRIBE CHANNEL_INFO
# Line 7668  Internet-Draft        LinuxSampler Contr Line 7836  Internet-Draft        LinuxSampler Contr
7836    
7837    
7838    
7839  Schoenebeck              Expires March 14, 2009               [Page 137]  Schoenebeck               Expires June 9, 2009                [Page 140]
7840    
7841  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
7842    
7843    
7844  8.14.  Total number of active voices changed  8.14.  Total number of active voices changed
# Line 7724  Internet-Draft        LinuxSampler Contr Line 7892  Internet-Draft        LinuxSampler Contr
7892    
7893    
7894    
7895  Schoenebeck              Expires March 14, 2009               [Page 138]  Schoenebeck               Expires June 9, 2009                [Page 141]
7896    
7897  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
7898    
7899    
7900        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
# Line 7780  Internet-Draft        LinuxSampler Contr Line 7948  Internet-Draft        LinuxSampler Contr
7948    
7949    
7950    
7951  Schoenebeck              Expires March 14, 2009               [Page 139]  Schoenebeck               Expires June 9, 2009                [Page 142]
7952    
7953  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
7954    
7955    
7956  8.20.  Global settings changed  8.20.  Global settings changed
# Line 7800  Internet-Draft        LinuxSampler Contr Line 7968  Internet-Draft        LinuxSampler Contr
7968        by the optional dotted floating point value, reflecting the new        by the optional dotted floating point value, reflecting the new
7969        global volume parameter.        global volume parameter.
7970    
7971          "NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the
7972          golbal limit of the sampler for maximum voices is changed, where
7973          <max-voices> will be an integer value, reflecting the new global
7974          voice limit parameter.
7975    
7976          "NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the
7977          golbal limit of the sampler for maximum disk streams is changed,
7978          where <max-streams> will be an integer value, reflecting the new
7979          global disk streams limit parameter.
7980    
7981  8.21.  Number of database instrument directories changed  8.21.  Number of database instrument directories changed
7982    
7983     Client may want to be notified when the number of instrument     Client may want to be notified when the number of instrument
# Line 7824  Internet-Draft        LinuxSampler Contr Line 8002  Internet-Draft        LinuxSampler Contr
8002     Client may want to be notified when changes were made to directories     Client may want to be notified when changes were made to directories
8003     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
8004    
8005    
8006    
8007    Schoenebeck               Expires June 9, 2009                [Page 143]
8008    
8009    Internet-Draft        LinuxSampler Control Protocol        December 2008
8010    
8011    
8012        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
8013    
8014     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7833  Internet-Draft        LinuxSampler Contr Line 8018  Internet-Draft        LinuxSampler Contr
8018     where <dir-path> will be replaced by the absolute path name of the     where <dir-path> will be replaced by the absolute path name of the
8019     directory, for which information changes occurred.  The front-end     directory, for which information changes occurred.  The front-end
8020     will have to send the respective command to actually get the updated     will have to send the respective command to actually get the updated
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 140]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8021     directory info.  Because these messages will be triggered by LSCP     directory info.  Because these messages will be triggered by LSCP
8022     commands issued by other clients rather than real time events     commands issued by other clients rather than real time events
8023     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
# Line 7881  Internet-Draft        LinuxSampler Contr Line 8058  Internet-Draft        LinuxSampler Contr
8058    
8059     Server will start sending the following notification messages:     Server will start sending the following notification messages:
8060    
8061    
8062    
8063    Schoenebeck               Expires June 9, 2009                [Page 144]
8064    
8065    Internet-Draft        LinuxSampler Control Protocol        December 2008
8066    
8067    
8068        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
8069    
8070     where <instr-path> will be replaced by the absolute path name of the     where <instr-path> will be replaced by the absolute path name of the
# Line 7889  Internet-Draft        LinuxSampler Contr Line 8073  Internet-Draft        LinuxSampler Contr
8073     info.  Because these messages will be triggered by LSCP commands     info.  Because these messages will be triggered by LSCP commands
8074     issued by other clients rather than real time events happening on the     issued by other clients rather than real time events happening on the
8075     server, it is believed that an empty notification message is     server, it is believed that an empty notification message is
   
   
   
 Schoenebeck              Expires March 14, 2009               [Page 141]  
   
 Internet-Draft        LinuxSampler Control Protocol       September 2008  
   
   
8076     sufficient here.     sufficient here.
8077    
8078        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
# Line 7937  Internet-Draft        LinuxSampler Contr Line 8113  Internet-Draft        LinuxSampler Contr
8113    
8114     where <string> will be replaced by whatever data server wants to send     where <string> will be replaced by whatever data server wants to send
8115     to the client.  Client MAY display this data to the user AS IS to     to the client.  Client MAY display this data to the user AS IS to
8116    
8117    
8118    
8119    Schoenebeck               Expires June 9, 2009                [Page 145]
8120    
8121    Internet-Draft        LinuxSampler Control Protocol        December 2008
8122    
8123    
8124     facilitate debugging.     facilitate debugging.
8125    
8126    
# Line 7948  Internet-Draft        LinuxSampler Contr Line 8132  Internet-Draft        LinuxSampler Contr
8132    
8133    
8134    
8135  Schoenebeck              Expires March 14, 2009               [Page 142]  
8136    
8137    
8138    
8139    
8140    
8141    
8142    
8143    
8144    
8145    
8146    
8147    
8148    
8149    
8150    
8151    
8152    
8153    
8154    
8155    
8156    
8157    
8158    
8159    
8160    
8161    
8162    
8163    
8164    
8165    
8166    
8167    
8168    
8169    
8170    
8171    
8172    
8173    
8174    
8175    Schoenebeck               Expires June 9, 2009                [Page 146]
8176    
8177  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
8178    
8179    
8180  9.  Security Considerations  9.  Security Considerations
# Line 8004  Internet-Draft        LinuxSampler Contr Line 8228  Internet-Draft        LinuxSampler Contr
8228    
8229    
8230    
8231  Schoenebeck              Expires March 14, 2009               [Page 143]  Schoenebeck               Expires June 9, 2009                [Page 147]
8232    
8233  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
8234    
8235    
8236  10.  Acknowledgments  10.  Acknowledgments
# Line 8060  Internet-Draft        LinuxSampler Contr Line 8284  Internet-Draft        LinuxSampler Contr
8284    
8285    
8286    
8287  Schoenebeck              Expires March 14, 2009               [Page 144]  Schoenebeck               Expires June 9, 2009                [Page 148]
8288    
8289  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
8290    
8291    
8292  11.  References  11.  References
# Line 8116  Internet-Draft        LinuxSampler Contr Line 8340  Internet-Draft        LinuxSampler Contr
8340    
8341    
8342    
8343  Schoenebeck              Expires March 14, 2009               [Page 145]  Schoenebeck               Expires June 9, 2009                [Page 149]
8344    
8345  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
8346    
8347    
8348  Author's Address  Author's Address
# Line 8172  Author's Address Line 8396  Author's Address
8396    
8397    
8398    
8399  Schoenebeck              Expires March 14, 2009               [Page 146]  Schoenebeck               Expires June 9, 2009                [Page 150]
8400    
8401  Internet-Draft        LinuxSampler Control Protocol       September 2008  Internet-Draft        LinuxSampler Control Protocol        December 2008
8402    
8403    
8404  Full Copyright Statement  Full Copyright Statement
# Line 8219  Intellectual Property Line 8443  Intellectual Property
8443     ietf-ipr@ietf.org.     ietf-ipr@ietf.org.
8444    
8445    
 Acknowledgment  
8446    
    Funding for the RFC Editor function is provided by the IETF  
    Administrative Support Activity (IASA).  
8447    
8448    
8449    
8450    
8451    
8452  Schoenebeck              Expires March 14, 2009               [Page 147]  
8453    
8454    
8455    Schoenebeck               Expires June 9, 2009                [Page 151]
8456    
8457    
Legend:
Removed from v.1800  
changed lines
  Added in v.1801
  ViewVC Help
Powered by ViewVC