/[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 1362 by schoenebeck, Fri Jun 22 14:24:57 2007 UTC revision 1363 by schoenebeck, Sun Sep 30 21:51:14 2007 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: December 24, 2007                                 June 22, 2007  Expires: March 4, 2008                                    September 2007
8    
9    
10                   LinuxSampler Control Protocol (draft)                   LinuxSampler Control Protocol (draft)
# Line 33  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on December 24, 2007.     This Internet-Draft will expire on March 4, 2008.
37    
38  Copyright Notice  Copyright Notice
39    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck             Expires December 24, 2007               [Page 1]  Schoenebeck               Expires March 4, 2008                 [Page 1]
56    
57  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck             Expires December 24, 2007               [Page 2]  Schoenebeck               Expires March 4, 2008                 [Page 2]
112    
113  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.  Getting all created MIDI input device list  . . . . .  37
# Line 126  Internet-Draft    LinuxSampler Control P Line 126  Internet-Draft    LinuxSampler Control P
126         6.4.3.  Getting all created sampler channel count . . . . . .  45         6.4.3.  Getting all created sampler channel count . . . . . .  45
127         6.4.4.  Getting all created sampler channel list  . . . . . .  45         6.4.4.  Getting all created sampler channel list  . . . . . .  45
128         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  46         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47
130         6.4.7.  Getting amount of available engines . . . . . . . . .  47         6.4.7.  Getting amount of available engines . . . . . . . . .  47
131         6.4.8.  Getting all available engines . . . . . . . . . . . .  48         6.4.8.  Getting all available engines . . . . . . . . . . . .  48
132         6.4.9.  Getting information about an engine . . . . . . . . .  48         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information . . . . . . . . .  49         6.4.10. Getting sampler channel information . . . . . . . . .  49
134         6.4.11. Current number of active voices . . . . . . . . . . .  52         6.4.11. Current number of active voices . . . . . . . . . . .  52
135         6.4.12. Current number of active disk streams . . . . . . . .  52         6.4.12. Current number of active disk streams . . . . . . . .  53
136         6.4.13. Current fill state of disk stream buffers . . . . . .  53         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device . . . . . . . . . . . . .  54         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55
139         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55
140         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  57         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58
143         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  59         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60
146         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60
147         6.4.24. Assigning a MIDI instrument map to a sampler         6.4.24. Assigning a MIDI instrument map to a sampler
148                 channel . . . . . . . . . . . . . . . . . . . . . . .  61                 channel . . . . . . . . . . . . . . . . . . . . . . .  61
# Line 164  Internet-Draft    LinuxSampler Control P Line 164  Internet-Draft    LinuxSampler Control P
164    
165    
166    
167  Schoenebeck             Expires December 24, 2007               [Page 3]  Schoenebeck               Expires March 4, 2008                 [Page 3]
168    
169  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
170    
171    
172         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
173       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  73
174         6.6.1.  Current number of active voices . . . . . . . . . . .  73         6.6.1.  Current number of active voices . . . . . . . . . . .  73
175         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73
176         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73
177         6.6.4.  General sampler informations  . . . . . . . . . . . .  73         6.6.4.  General sampler informations  . . . . . . . . . . . .  74
178         6.6.5.  Getting global volume attenuation . . . . . . . . . .  74         6.6.5.  Getting global volume attenuation . . . . . . . . . .  74
179         6.6.6.  Setting global volume attenuation . . . . . . . . . .  75         6.6.6.  Setting global volume attenuation . . . . . . . . . .  75
180       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75
# Line 193  Internet-Draft    LinuxSampler Control P Line 193  Internet-Draft    LinuxSampler Control P
193         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87
195         6.8.1.  Creating a new instrument directory . . . . . . . . .  87         6.8.1.  Creating a new instrument directory . . . . . . . . .  87
196         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88
197         6.8.3.  Getting amount of instrument directories  . . . . . .  88         6.8.3.  Getting amount of instrument directories  . . . . . .  88
198         6.8.4.  Listing all directories in specific directory . . . .  89         6.8.4.  Listing all directories in specific directory . . . .  89
199         6.8.5.  Getting instrument directory information  . . . . . .  89         6.8.5.  Getting instrument directory information  . . . . . .  89
# Line 206  Internet-Draft    LinuxSampler Control P Line 206  Internet-Draft    LinuxSampler Control P
206         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96
207         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96
208         6.8.14. Listing all instruments in specific directory . . . .  97         6.8.14. Listing all instruments in specific directory . . . .  97
209         6.8.15. Getting instrument information  . . . . . . . . . . .  97         6.8.15. Getting instrument information  . . . . . . . . . . .  98
210         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100
211         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 100         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 101
212         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 101         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 101
213         6.8.19. Changing the description of instrument  . . . . . . . 102         6.8.19. Changing the description of instrument  . . . . . . . 102
214         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102
215         6.8.21. Getting job status information  . . . . . . . . . . . 104         6.8.21. Getting job status information  . . . . . . . . . . . 105
216     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 106         6.8.22. Formatting the instruments database . . . . . . . . . 106
217       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 119       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 106
218     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 121         6.9.1.  Opening an appropriate instrument editor
219       8.1.  Number of audio output devices changed  . . . . . . . . . 121                 application . . . . . . . . . . . . . . . . . . . . . 106
220    
221    
222    
223  Schoenebeck             Expires December 24, 2007               [Page 4]  Schoenebeck               Expires March 4, 2008                 [Page 4]
224    
225  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
226    
227    
228       8.2.  Audio output device's settings changed  . . . . . . . . . 121     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 108
229       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 121       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 121
230       8.4.  MIDI input device's settings changed  . . . . . . . . . . 122     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
231       8.5.  Number of sampler channels changed  . . . . . . . . . . . 122       8.1.  Number of audio output devices changed  . . . . . . . . . 123
232       8.6.  Number of active voices changed . . . . . . . . . . . . . 122       8.2.  Audio output device's settings changed  . . . . . . . . . 123
233       8.7.  Number of active disk streams changed . . . . . . . . . . 123       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 123
234       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 123       8.4.  MIDI input device's settings changed  . . . . . . . . . . 124
235       8.9.  Channel information changed . . . . . . . . . . . . . . . 123       8.5.  Number of sampler channels changed  . . . . . . . . . . . 124
236       8.10. Number of effect sends changed  . . . . . . . . . . . . . 124       8.6.  Number of active voices changed . . . . . . . . . . . . . 124
237       8.11. Effect send information changed . . . . . . . . . . . . . 124       8.7.  Number of active disk streams changed . . . . . . . . . . 125
238       8.12. Total number of active voices changed . . . . . . . . . . 124       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 125
239       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 125       8.9.  Channel information changed . . . . . . . . . . . . . . . 125
240       8.14. MIDI instrument map information changed . . . . . . . . . 125       8.10. Number of effect sends changed  . . . . . . . . . . . . . 126
241       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 125       8.11. Effect send information changed . . . . . . . . . . . . . 126
242       8.16. MIDI instrument information changed . . . . . . . . . . . 126       8.12. Total number of active voices changed . . . . . . . . . . 126
243       8.17. Global settings changed . . . . . . . . . . . . . . . . . 126       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 127
244       8.18. Number of database instrument directories changed . . . . 127       8.14. MIDI instrument map information changed . . . . . . . . . 127
245       8.19. Database instrument directory information changed . . . . 127       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 127
246       8.20. Number of database instruments changed  . . . . . . . . . 128       8.16. MIDI instrument information changed . . . . . . . . . . . 128
247       8.21. Database instrument information changed . . . . . . . . . 128       8.17. Global settings changed . . . . . . . . . . . . . . . . . 128
248       8.22. Database job status information changed . . . . . . . . . 129       8.18. Number of database instrument directories changed . . . . 129
249       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 129       8.19. Database instrument directory information changed . . . . 129
250     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 130       8.20. Number of database instruments changed  . . . . . . . . . 130
251     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 131       8.21. Database instrument information changed . . . . . . . . . 130
252     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 132       8.22. Database job status information changed . . . . . . . . . 131
253     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 133       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 131
254     Intellectual Property and Copyright Statements  . . . . . . . . . 134     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 132
255       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 133
256       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 134
257       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 135
258       Intellectual Property and Copyright Statements  . . . . . . . . . 136
259    
260    
261    
# Line 272  Internet-Draft    LinuxSampler Control P Line 276  Internet-Draft    LinuxSampler Control P
276    
277    
278    
279    Schoenebeck               Expires March 4, 2008                 [Page 5]
   
   
   
 Schoenebeck             Expires December 24, 2007               [Page 5]  
280    
281  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft    LinuxSampler Control P Line 332  Internet-Draft    LinuxSampler Control P
332    
333    
334    
335  Schoenebeck             Expires December 24, 2007               [Page 6]  Schoenebeck               Expires March 4, 2008                 [Page 6]
336    
337  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 388  Internet-Draft    LinuxSampler Control P Line 388  Internet-Draft    LinuxSampler Control P
388    
389    
390    
391  Schoenebeck             Expires December 24, 2007               [Page 7]  Schoenebeck               Expires March 4, 2008                 [Page 7]
392    
393  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft    LinuxSampler Control P Line 444  Internet-Draft    LinuxSampler Control P
444    
445    
446    
447  Schoenebeck             Expires December 24, 2007               [Page 8]  Schoenebeck               Expires March 4, 2008                 [Page 8]
448    
449  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft    LinuxSampler Control P Line 500  Internet-Draft    LinuxSampler Control P
500    
501    
502    
503  Schoenebeck             Expires December 24, 2007               [Page 9]  Schoenebeck               Expires March 4, 2008                 [Page 9]
504    
505  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft    LinuxSampler Control P Line 556  Internet-Draft    LinuxSampler Control P
556    
557    
558    
559  Schoenebeck             Expires December 24, 2007              [Page 10]  Schoenebeck               Expires March 4, 2008                [Page 10]
560    
561  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft    LinuxSampler Control P Line 612  Internet-Draft    LinuxSampler Control P
612    
613    
614    
615  Schoenebeck             Expires December 24, 2007              [Page 11]  Schoenebeck               Expires March 4, 2008                [Page 11]
616    
617  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft    LinuxSampler Control P Line 668  Internet-Draft    LinuxSampler Control P
668    
669    
670    
671  Schoenebeck             Expires December 24, 2007              [Page 12]  Schoenebeck               Expires March 4, 2008                [Page 12]
672    
673  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft    LinuxSampler Control P Line 724  Internet-Draft    LinuxSampler Control P
724    
725    
726    
727  Schoenebeck             Expires December 24, 2007              [Page 13]  Schoenebeck               Expires March 4, 2008                [Page 13]
728    
729  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft    LinuxSampler Control P Line 780  Internet-Draft    LinuxSampler Control P
780    
781    
782    
783  Schoenebeck             Expires December 24, 2007              [Page 14]  Schoenebeck               Expires March 4, 2008                [Page 14]
784    
785  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft    LinuxSampler Control P Line 836  Internet-Draft    LinuxSampler Control P
836    
837    
838    
839  Schoenebeck             Expires December 24, 2007              [Page 15]  Schoenebeck               Expires March 4, 2008                [Page 15]
840    
841  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft    LinuxSampler Control P Line 892  Internet-Draft    LinuxSampler Control P
892    
893    
894    
895  Schoenebeck             Expires December 24, 2007              [Page 16]  Schoenebeck               Expires March 4, 2008                [Page 16]
896    
897  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft    LinuxSampler Control P Line 948  Internet-Draft    LinuxSampler Control P
948    
949    
950    
951  Schoenebeck             Expires December 24, 2007              [Page 17]  Schoenebeck               Expires March 4, 2008                [Page 17]
952    
953  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft    LinuxSampler Control P Line 1004  Internet-Draft    LinuxSampler Control P
1004    
1005    
1006    
1007  Schoenebeck             Expires December 24, 2007              [Page 18]  Schoenebeck               Expires March 4, 2008                [Page 18]
1008    
1009  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft    LinuxSampler Control P Line 1060  Internet-Draft    LinuxSampler Control P
1060    
1061    
1062    
1063  Schoenebeck             Expires December 24, 2007              [Page 19]  Schoenebeck               Expires March 4, 2008                [Page 19]
1064    
1065  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft    LinuxSampler Control P Line 1116  Internet-Draft    LinuxSampler Control P
1116    
1117    
1118    
1119  Schoenebeck             Expires December 24, 2007              [Page 20]  Schoenebeck               Expires March 4, 2008                [Page 20]
1120    
1121  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft    LinuxSampler Control P Line 1172  Internet-Draft    LinuxSampler Control P
1172    
1173    
1174    
1175  Schoenebeck             Expires December 24, 2007              [Page 21]  Schoenebeck               Expires March 4, 2008                [Page 21]
1176    
1177  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft    LinuxSampler Control P Line 1228  Internet-Draft    LinuxSampler Control P
1228    
1229    
1230    
1231  Schoenebeck             Expires December 24, 2007              [Page 22]  Schoenebeck               Expires March 4, 2008                [Page 22]
1232    
1233  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft    LinuxSampler Control P Line 1284  Internet-Draft    LinuxSampler Control P
1284    
1285    
1286    
1287  Schoenebeck             Expires December 24, 2007              [Page 23]  Schoenebeck               Expires March 4, 2008                [Page 23]
1288    
1289  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft    LinuxSampler Control P Line 1340  Internet-Draft    LinuxSampler Control P
1340    
1341    
1342    
1343  Schoenebeck             Expires December 24, 2007              [Page 24]  Schoenebeck               Expires March 4, 2008                [Page 24]
1344    
1345  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft    LinuxSampler Control P Line 1396  Internet-Draft    LinuxSampler Control P
1396    
1397    
1398    
1399  Schoenebeck             Expires December 24, 2007              [Page 25]  Schoenebeck               Expires March 4, 2008                [Page 25]
1400    
1401  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft    LinuxSampler Control P Line 1452  Internet-Draft    LinuxSampler Control P
1452    
1453    
1454    
1455  Schoenebeck             Expires December 24, 2007              [Page 26]  Schoenebeck               Expires March 4, 2008                [Page 26]
1456    
1457  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft    LinuxSampler Control P Line 1508  Internet-Draft    LinuxSampler Control P
1508    
1509    
1510    
1511  Schoenebeck             Expires December 24, 2007              [Page 27]  Schoenebeck               Expires March 4, 2008                [Page 27]
1512    
1513  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft    LinuxSampler Control P Line 1564  Internet-Draft    LinuxSampler Control P
1564    
1565    
1566    
1567  Schoenebeck             Expires December 24, 2007              [Page 28]  Schoenebeck               Expires March 4, 2008                [Page 28]
1568    
1569  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft    LinuxSampler Control P Line 1620  Internet-Draft    LinuxSampler Control P
1620    
1621    
1622    
1623  Schoenebeck             Expires December 24, 2007              [Page 29]  Schoenebeck               Expires March 4, 2008                [Page 29]
1624    
1625  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft    LinuxSampler Control P Line 1676  Internet-Draft    LinuxSampler Control P
1676    
1677    
1678    
1679  Schoenebeck             Expires December 24, 2007              [Page 30]  Schoenebeck               Expires March 4, 2008                [Page 30]
1680    
1681  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft    LinuxSampler Control P Line 1732  Internet-Draft    LinuxSampler Control P
1732    
1733    
1734    
1735  Schoenebeck             Expires December 24, 2007              [Page 31]  Schoenebeck               Expires March 4, 2008                [Page 31]
1736    
1737  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft    LinuxSampler Control P Line 1788  Internet-Draft    LinuxSampler Control P
1788    
1789    
1790    
1791  Schoenebeck             Expires December 24, 2007              [Page 32]  Schoenebeck               Expires March 4, 2008                [Page 32]
1792    
1793  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft    LinuxSampler Control P Line 1844  Internet-Draft    LinuxSampler Control P
1844    
1845    
1846    
1847  Schoenebeck             Expires December 24, 2007              [Page 33]  Schoenebeck               Expires March 4, 2008                [Page 33]
1848    
1849  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft    LinuxSampler Control P Line 1900  Internet-Draft    LinuxSampler Control P
1900    
1901    
1902    
1903  Schoenebeck             Expires December 24, 2007              [Page 34]  Schoenebeck               Expires March 4, 2008                [Page 34]
1904    
1905  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft    LinuxSampler Control P Line 1956  Internet-Draft    LinuxSampler Control P
1956    
1957    
1958    
1959  Schoenebeck             Expires December 24, 2007              [Page 35]  Schoenebeck               Expires March 4, 2008                [Page 35]
1960    
1961  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft    LinuxSampler Control P Line 2012  Internet-Draft    LinuxSampler Control P
2012    
2013    
2014    
2015  Schoenebeck             Expires December 24, 2007              [Page 36]  Schoenebeck               Expires March 4, 2008                [Page 36]
2016    
2017  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft    LinuxSampler Control P Line 2068  Internet-Draft    LinuxSampler Control P
2068    
2069    
2070    
2071  Schoenebeck             Expires December 24, 2007              [Page 37]  Schoenebeck               Expires March 4, 2008                [Page 37]
2072    
2073  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft    LinuxSampler Control P Line 2124  Internet-Draft    LinuxSampler Control P
2124    
2125    
2126    
2127  Schoenebeck             Expires December 24, 2007              [Page 38]  Schoenebeck               Expires March 4, 2008                [Page 38]
2128    
2129  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft    LinuxSampler Control P Line 2180  Internet-Draft    LinuxSampler Control P
2180    
2181    
2182    
2183  Schoenebeck             Expires December 24, 2007              [Page 39]  Schoenebeck               Expires March 4, 2008                [Page 39]
2184    
2185  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft    LinuxSampler Control P Line 2236  Internet-Draft    LinuxSampler Control P
2236    
2237    
2238    
2239  Schoenebeck             Expires December 24, 2007              [Page 40]  Schoenebeck               Expires March 4, 2008                [Page 40]
2240    
2241  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft    LinuxSampler Control P Line 2292  Internet-Draft    LinuxSampler Control P
2292    
2293    
2294    
2295  Schoenebeck             Expires December 24, 2007              [Page 41]  Schoenebeck               Expires March 4, 2008                [Page 41]
2296    
2297  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2328  Internet-Draft    LinuxSampler Control P Line 2328  Internet-Draft    LinuxSampler Control P
2328     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2329     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2330     MIDI port number, <key> by the name of the parameter to change and     MIDI port number, <key> by the name of the parameter to change and
2331     <value> by the new value for this parameter.     <value> by the new value for this parameter (encapsulated into
2332       apostrophes) or NONE (not encapsulated into apostrophes) for
2333       specifying no value for parameters allowing a list of values.
2334    
2335     Possible Answers:     Possible Answers:
2336    
# Line 2342  Internet-Draft    LinuxSampler Control P Line 2344  Internet-Draft    LinuxSampler Control P
2344           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2345           code and warning message           code and warning message
2346    
       "ERR:<error-code>:<error-message>" -  
   
2347    
2348    
2349    
2350    
2351  Schoenebeck             Expires December 24, 2007              [Page 42]  Schoenebeck               Expires March 4, 2008                [Page 42]
2352    
2353  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2354    
2355    
2356          "ERR:<error-code>:<error-message>" -
2357    
2358           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2359           error message           error message
2360    
2361     Example:     Example:
2362    
2363          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2364    
2365          S: "OK"
2366    
2367          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2368    
2369          S: "OK"
2370    
2371  6.4.  Configuring sampler channels  6.4.  Configuring sampler channels
2372    
# Line 2393  Internet-Draft    LinuxSampler Control P Line 2401  Internet-Draft    LinuxSampler Control P
2401     (Section 6.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2402     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2403     such as making sure that the file could be read and it is of a proper     such as making sure that the file could be read and it is of a proper
    format and SHOULD return ERR and SHOULD not launch the background  
    process should any errors be detected at that point.  
2404    
    Possible Answers:  
   
       "OK" -  
2405    
2406    
2407    Schoenebeck               Expires March 4, 2008                [Page 43]
2408    
2409    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2410    
2411    
2412       format and SHOULD return ERR and SHOULD not launch the background
2413       process should any errors be detected at that point.
2414    
2415  Schoenebeck             Expires December 24, 2007              [Page 43]     Possible Answers:
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
2416    
2417          "OK" -
2418    
2419           in case the instrument was successfully loaded           in case the instrument was successfully loaded
2420    
# Line 2449  Internet-Draft    LinuxSampler Control P Line 2456  Internet-Draft    LinuxSampler Control P
2456    
2457     Possible Answers:     Possible Answers:
2458    
       "OK" -  
2459    
          in case the engine was successfully deployed  
2460    
       "WRN:<warning-code>:<warning-message>" -  
2461    
          in case the engine was deployed successfully, but there are  
          noteworthy issue(s) related, providing an appropriate warning  
2462    
2463    Schoenebeck               Expires March 4, 2008                [Page 44]
2464    
2465    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2466    
2467    
2468  Schoenebeck             Expires December 24, 2007              [Page 44]        "OK" -
2469    
2470  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007           in case the engine was successfully deployed
2471    
2472          "WRN:<warning-code>:<warning-message>" -
2473    
2474             in case the engine was deployed successfully, but there are
2475             noteworthy issue(s) related, providing an appropriate warning
2476           code and warning message           code and warning message
2477    
2478        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2505  Internet-Draft    LinuxSampler Control P Line 2513  Internet-Draft    LinuxSampler Control P
2513    
2514     Possible Answers:     Possible Answers:
2515    
       LinuxSampler will answer by returning a comma separated list with  
       all sampler channels numerical IDs.  
2516    
    Example:  
   
       C: "LIST CHANNELS"  
2517    
2518    
2519    Schoenebeck               Expires March 4, 2008                [Page 45]
2520    
2521    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2522    
2523    
2524          LinuxSampler will answer by returning a comma separated list with
2525          all sampler channels numerical IDs.
2526    
2527  Schoenebeck             Expires December 24, 2007              [Page 45]     Example:
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
2528    
2529          C: "LIST CHANNELS"
2530    
2531        S: "0,1,2,3,4,5,6,9,10,11,15,20"        S: "0,1,2,3,4,5,6,9,10,11,15,20"
2532    
# Line 2564  Internet-Draft    LinuxSampler Control P Line 2571  Internet-Draft    LinuxSampler Control P
2571    
2572    
2573    
 6.4.6.  Removing a sampler channel  
   
    A sampler channel can be removed by sending the following command:  
2574    
2575    Schoenebeck               Expires March 4, 2008                [Page 46]
2576    
2577    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2578    
2579    
2580    
2581    
2582  Schoenebeck             Expires December 24, 2007              [Page 46]  6.4.6.  Removing a sampler channel
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
2583    
2584       A sampler channel can be removed by sending the following command:
2585    
2586        REMOVE CHANNEL <sampler-channel>        REMOVE CHANNEL <sampler-channel>
2587    
# Line 2619  Internet-Draft    LinuxSampler Control P Line 2625  Internet-Draft    LinuxSampler Control P
2625    
2626     Example:     Example:
2627    
       C: "GET AVAILABLE_ENGINES"  
   
       S: "4"  
   
2628    
2629    
2630    
2631    Schoenebeck               Expires March 4, 2008                [Page 47]
2632    
2633    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2634    
2635    
2636  Schoenebeck             Expires December 24, 2007              [Page 47]        C: "GET AVAILABLE_ENGINES"
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
2637    
2638          S: "4"
2639    
2640  6.4.8.  Getting all available engines  6.4.8.  Getting all available engines
2641    
# Line 2677  Internet-Draft    LinuxSampler Control P Line 2681  Internet-Draft    LinuxSampler Control P
2681    
2682              arbitrary description text about the engine              arbitrary description text about the engine
2683    
          VERSION -  
2684    
             arbitrary character string regarding the engine's version  
2685    
2686    
2687    Schoenebeck               Expires March 4, 2008                [Page 48]
2688    
2689    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2690    
2691    
2692  Schoenebeck             Expires December 24, 2007              [Page 48]           VERSION -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
2693    
2694                arbitrary character string regarding the engine's version
2695    
2696     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2697    
# Line 2733  Internet-Draft    LinuxSampler Control P Line 2737  Internet-Draft    LinuxSampler Control P
2737              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2738              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2739              signal, "NONE" if there's no device connected to this              signal, "NONE" if there's no device connected to this
             sampler channel  
   
   
   
2740    
2741    
2742    
2743  Schoenebeck             Expires December 24, 2007              [Page 49]  Schoenebeck               Expires March 4, 2008                [Page 49]
2744    
2745  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2746    
2747    
2748                sampler channel
2749    
2750           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2751    
2752              number of output channels the sampler channel offers              number of output channels the sampler channel offers
# Line 2790  Internet-Draft    LinuxSampler Control P Line 2792  Internet-Draft    LinuxSampler Control P
2792    
2793              port number of the MIDI input device              port number of the MIDI input device
2794    
          MIDI_INPUT_CHANNEL -  
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires March 4, 2008                [Page 50]
 Schoenebeck             Expires December 24, 2007              [Page 50]  
2800    
2801  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2802    
2803    
2804             MIDI_INPUT_CHANNEL -
2805    
2806              the MIDI input channel number this sampler channel should              the MIDI input channel number this sampler channel should
2807              listen to or "ALL" to listen on all MIDI channels              listen to or "ALL" to listen on all MIDI channels
2808    
# Line 2846  Internet-Draft    LinuxSampler Control P Line 2848  Internet-Draft    LinuxSampler Control P
2848    
2849           "AUDIO_OUTPUT_ROUTING: 0,1"           "AUDIO_OUTPUT_ROUTING: 0,1"
2850    
          "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"  
   
2851    
2852    
2853    
2854    
2855  Schoenebeck             Expires December 24, 2007              [Page 51]  Schoenebeck               Expires March 4, 2008                [Page 51]
2856    
2857  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2858    
2859    
2860             "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2861    
2862           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
2863    
2864           "INSTRUMENT_NAME: Fazioli Piano"           "INSTRUMENT_NAME: Fazioli Piano"
# Line 2899  Internet-Draft    LinuxSampler Control P Line 2901  Internet-Draft    LinuxSampler Control P
2901    
2902    
2903    
 6.4.12.  Current number of active disk streams  
2904    
    The front-end can ask for the current number of active disk streams  
    on a sampler channel by sending the following command:  
2905    
2906    
2907    
2908    
2909    
2910  Schoenebeck             Expires December 24, 2007              [Page 52]  
2911    Schoenebeck               Expires March 4, 2008                [Page 52]
2912    
2913  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2914    
2915    
2916    6.4.12.  Current number of active disk streams
2917    
2918       The front-end can ask for the current number of active disk streams
2919       on a sampler channel by sending the following command:
2920    
2921        GET CHANNEL STREAM_COUNT <sampler-channel>        GET CHANNEL STREAM_COUNT <sampler-channel>
2922    
# Line 2956  Internet-Draft    LinuxSampler Control P Line 2961  Internet-Draft    LinuxSampler Control P
2961        will begin with the stream's ID in brackets followed by the        will begin with the stream's ID in brackets followed by the
2962        numerical representation of the fill size (either in bytes or        numerical representation of the fill size (either in bytes or
2963        percentage).  Note: due to efficiency reasons the fill states in        percentage).  Note: due to efficiency reasons the fill states in
       the response are not in particular order, thus the front-end has  
       to sort them by itself if necessary.  
2964    
    Examples:  
2965    
2966    
2967    Schoenebeck               Expires March 4, 2008                [Page 53]
2968    
2969    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2970    
2971    
2972  Schoenebeck             Expires December 24, 2007              [Page 53]        the response are not in particular order, thus the front-end has
2973          to sort them by itself if necessary.
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
2974    
2975       Examples:
2976    
2977        C: "GET CHANNEL BUFFER_FILL BYTES 4"        C: "GET CHANNEL BUFFER_FILL BYTES 4"
2978    
# Line 3013  Internet-Draft    LinuxSampler Control P Line 3018  Internet-Draft    LinuxSampler Control P
3018           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3019           error message           error message
3020    
    Examples:  
   
   
   
   
3021    
3022    
3023  Schoenebeck             Expires December 24, 2007              [Page 54]  Schoenebeck               Expires March 4, 2008                [Page 54]
3024    
3025  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3026    
3027    
3028       Examples:
3029    
3030    
3031    
3032  6.4.15.  Setting audio output type  6.4.15.  Setting audio output type
# Line 3071  Internet-Draft    LinuxSampler Control P Line 3073  Internet-Draft    LinuxSampler Control P
3073    
3074     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3075     "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)
    command, <audio-out> is the numerical ID of the sampler channel's  
    audio output channel which should be rerouted and <audio-in> is the  
3076    
3077    
3078    
3079  Schoenebeck             Expires December 24, 2007              [Page 55]  Schoenebeck               Expires March 4, 2008                [Page 55]
3080    
3081  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3082    
3083    
3084       command, <audio-out> is the numerical ID of the sampler channel's
3085       audio output channel which should be rerouted and <audio-in> is the
3086     numerical ID of the audio channel of the selected audio output device     numerical ID of the audio channel of the selected audio output device
3087     where <audio-out> should be routed to.     where <audio-out> should be routed to.
3088    
# Line 3126  Internet-Draft    LinuxSampler Control P Line 3128  Internet-Draft    LinuxSampler Control P
3128    
3129        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3130    
          if MIDI input device was set, but there are noteworthy issue(s)  
          related, providing an appropriate warning code and warning  
          message  
3131    
3132    
3133    
3134  Schoenebeck             Expires December 24, 2007              [Page 56]  
3135    Schoenebeck               Expires March 4, 2008                [Page 56]
3136    
3137  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3138    
3139    
3140             if MIDI input device was set, but there are noteworthy issue(s)
3141             related, providing an appropriate warning code and warning
3142             message
3143    
3144        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3145    
3146           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3179  Internet-Draft    LinuxSampler Control P Line 3183  Internet-Draft    LinuxSampler Control P
3183    
3184    
3185    
 6.4.19.  Setting MIDI input port  
   
    The front-end can alter the MIDI input port on a specific sampler  
    channel by sending the following command:  
3186    
3187    
3188    
3189    
3190    
3191  Schoenebeck             Expires December 24, 2007              [Page 57]  Schoenebeck               Expires March 4, 2008                [Page 57]
3192    
3193  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3194    
3195    
3196    6.4.19.  Setting MIDI input port
3197    
3198       The front-end can alter the MIDI input port on a specific sampler
3199       channel by sending the following command:
3200    
3201        SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>        SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>
3202    
# Line 3236  Internet-Draft    LinuxSampler Control P Line 3241  Internet-Draft    LinuxSampler Control P
3241    
3242           on success           on success
3243    
       "WRN:<warning-code>:<warning-message>" -  
3244    
          if MIDI input channel was set, but there are noteworthy  
          issue(s) related, providing an appropriate warning code and  
          warning message  
3245    
3246    
3247    Schoenebeck               Expires March 4, 2008                [Page 58]
 Schoenebeck             Expires December 24, 2007              [Page 58]  
3248    
3249  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3250    
3251    
3252          "WRN:<warning-code>:<warning-message>" -
3253    
3254             if MIDI input channel was set, but there are noteworthy
3255             issue(s) related, providing an appropriate warning code and
3256             warning message
3257    
3258        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3259    
# Line 3291  Internet-Draft    LinuxSampler Control P Line 3297  Internet-Draft    LinuxSampler Control P
3297    
3298    
3299    
 6.4.22.  Muting a sampler channel  
3300    
    The front-end can mute/unmute a specific sampler channel by sending  
    the following command:  
3301    
3302    
3303    Schoenebeck               Expires March 4, 2008                [Page 59]
3304    
3305    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3306    
3307    
3308    
3309    
3310  Schoenebeck             Expires December 24, 2007              [Page 59]  6.4.22.  Muting a sampler channel
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3311    
3312       The front-end can mute/unmute a specific sampler channel by sending
3313       the following command:
3314    
3315        SET CHANNEL MUTE <sampler-channel> <mute>        SET CHANNEL MUTE <sampler-channel> <mute>
3316    
# Line 3347  Internet-Draft    LinuxSampler Control P Line 3354  Internet-Draft    LinuxSampler Control P
3354    
3355     Possible Answers:     Possible Answers:
3356    
       "OK" -  
   
          on success  
   
   
3357    
3358    
3359    Schoenebeck               Expires March 4, 2008                [Page 60]
3360    
3361    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3362    
3363    
3364  Schoenebeck             Expires December 24, 2007              [Page 60]        "OK" -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3365    
3366             on success
3367    
3368        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3369    
# Line 3405  Internet-Draft    LinuxSampler Control P Line 3409  Internet-Draft    LinuxSampler Control P
3409           <map> with the respective numeric ID of the MIDI instrument map           <map> with the respective numeric ID of the MIDI instrument map
3410           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3411           command.  Once that map will be deleted, the sampler channel           command.  Once that map will be deleted, the sampler channel
          would fall back to "NONE".  
3412    
    Read chapter "MIDI Instrument Mapping" (Section 6.7) for details  
    regarding MIDI instrument mapping.  
3413    
3414    
3415    Schoenebeck               Expires March 4, 2008                [Page 61]
 Schoenebeck             Expires December 24, 2007              [Page 61]  
3416    
3417  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3418    
3419    
3420             would fall back to "NONE".
3421    
3422       Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3423       regarding MIDI instrument mapping.
3424    
3425     Possible Answers:     Possible Answers:
3426    
# Line 3460  Internet-Draft    LinuxSampler Control P Line 3465  Internet-Draft    LinuxSampler Control P
3465     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
3466     runtime performance, because for implementing channel effect sends,     runtime performance, because for implementing channel effect sends,
3467     separate (sampler channel local) audio buffers are needed to render     separate (sampler channel local) audio buffers are needed to render
    and mix the voices and route the audio signal afterwards to the  
    master outputs and effect send outputs (along with their respective  
    effect send levels).  A sampler channel without effect sends however  
    can mix its voices directly into the audio output devices's audio  
    buffers and is thus faster.  
3468    
3469    
3470    
3471  Schoenebeck             Expires December 24, 2007              [Page 62]  Schoenebeck               Expires March 4, 2008                [Page 62]
3472    
3473  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3474    
3475    
3476       and mix the voices and route the audio signal afterwards to the
3477       master outputs and effect send outputs (along with their respective
3478       effect send levels).  A sampler channel without effect sends however
3479       can mix its voices directly into the audio output devices's audio
3480       buffers and is thus faster.
3481    
3482     Possible Answers:     Possible Answers:
3483    
3484        "OK[<fx-send-id>]" -        "OK[<fx-send-id>]" -
# Line 3514  Internet-Draft    LinuxSampler Control P Line 3520  Internet-Draft    LinuxSampler Control P
3520    
3521        "OK" -        "OK" -
3522    
          on success  
3523    
       "ERR:<error-code>:<error-message>" -  
3524    
          in case it failed, providing an appropriate error code and  
          error message  
3525    
3526    
3527    Schoenebeck               Expires March 4, 2008                [Page 63]
3528    
3529    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3530    
3531    
3532  Schoenebeck             Expires December 24, 2007              [Page 63]           on success
3533    
3534  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007        "ERR:<error-code>:<error-message>" -
3535    
3536             in case it failed, providing an appropriate error code and
3537             error message
3538    
3539     Example:     Example:
3540    
# Line 3570  Internet-Draft    LinuxSampler Control P Line 3577  Internet-Draft    LinuxSampler Control P
3577    
3578     Possible Answers:     Possible Answers:
3579    
       The sampler will answer by returning a comma separated list with  
       all effect sends' numerical IDs on the given sampler channel.  
   
    Examples:  
   
3580    
3581    
3582    
3583    Schoenebeck               Expires March 4, 2008                [Page 64]
3584    
3585    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3586    
3587    
3588  Schoenebeck             Expires December 24, 2007              [Page 64]        The sampler will answer by returning a comma separated list with
3589          all effect sends' numerical IDs on the given sampler channel.
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3590    
3591       Examples:
3592    
3593        C: "LIST FX_SENDS 0"        C: "LIST FX_SENDS 0"
3594    
# Line 3627  Internet-Draft    LinuxSampler Control P Line 3632  Internet-Draft    LinuxSampler Control P
3632    
3633           LEVEL -           LEVEL -
3634    
             optionally dotted number reflecting the effect send's  
             current send level (where a value < 1.0 means attenuation  
             and a value > 1.0 means amplification)  
   
   
3635    
3636    
3637    
3638    
3639  Schoenebeck             Expires December 24, 2007              [Page 65]  Schoenebeck               Expires March 4, 2008                [Page 65]
3640    
3641  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3642    
3643    
3644                optionally dotted number reflecting the effect send's
3645                current send level (where a value < 1.0 means attenuation
3646                and a value > 1.0 means amplification)
3647    
3648           AUDIO_OUTPUT_ROUTING -           AUDIO_OUTPUT_ROUTING -
3649    
3650              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
# Line 3683  Internet-Draft    LinuxSampler Control P Line 3687  Internet-Draft    LinuxSampler Control P
3687    
3688     Possible Answers:     Possible Answers:
3689    
       "OK" -  
3690    
          on success  
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires March 4, 2008                [Page 66]
3696    
3697    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3698    
3699    
3700  Schoenebeck             Expires December 24, 2007              [Page 66]        "OK" -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3701    
3702             on success
3703    
3704        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3705    
# Line 3740  Internet-Draft    LinuxSampler Control P Line 3744  Internet-Draft    LinuxSampler Control P
3744    
3745     Possible Answers:     Possible Answers:
3746    
       "OK" -  
3747    
          on success  
3748    
3749    
3750    
3751    Schoenebeck               Expires March 4, 2008                [Page 67]
3752    
3753    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3754    
3755    
3756  Schoenebeck             Expires December 24, 2007              [Page 67]        "OK" -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3757    
3758             on success
3759    
3760        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3761    
# Line 3798  Internet-Draft    LinuxSampler Control P Line 3802  Internet-Draft    LinuxSampler Control P
3802           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3803           message           message
3804    
       "ERR:<error-code>:<error-message>" -  
   
   
3805    
3806    
3807    Schoenebeck               Expires March 4, 2008                [Page 68]
 Schoenebeck             Expires December 24, 2007              [Page 68]  
3808    
3809  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3810    
3811    
3812          "ERR:<error-code>:<error-message>" -
3813    
3814           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3815           error message           error message
# Line 3853  Internet-Draft    LinuxSampler Control P Line 3855  Internet-Draft    LinuxSampler Control P
3855    
3856     Example:     Example:
3857    
       C: "SET FX_SEND LEVEL 0 0 0.15"  
3858    
       S: "OK"  
3859    
3860    
3861    
3862    
3863  Schoenebeck             Expires December 24, 2007              [Page 69]  Schoenebeck               Expires March 4, 2008                [Page 69]
3864    
3865  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3866    
3867    
3868          C: "SET FX_SEND LEVEL 0 0 0.15"
3869    
3870          S: "OK"
3871    
3872  6.4.34.  Resetting a sampler channel  6.4.34.  Resetting a sampler channel
3873    
# Line 3908  Internet-Draft    LinuxSampler Control P Line 3912  Internet-Draft    LinuxSampler Control P
3912     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3913     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3914    
       SUBSCRIBE <event-id>  
   
    where <event-id> will be replaced by the respective event that client  
    wants to subscribe to.  
3915    
3916    
3917    
3918    
3919  Schoenebeck             Expires December 24, 2007              [Page 70]  Schoenebeck               Expires March 4, 2008                [Page 70]
3920    
3921  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3922    
3923    
3924          SUBSCRIBE <event-id>
3925    
3926       where <event-id> will be replaced by the respective event that client
3927       wants to subscribe to.
3928    
3929     Possible Answers:     Possible Answers:
3930    
3931        "OK" -        "OK" -
# Line 3964  Internet-Draft    LinuxSampler Control P Line 3969  Internet-Draft    LinuxSampler Control P
3969           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3970           message           message
3971    
       "ERR:<error-code>:<error-message>" -  
3972    
          in case it failed, providing an appropriate error code and  
          error message  
3973    
3974    
3975    Schoenebeck               Expires March 4, 2008                [Page 71]
3976    
3977    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3978    
3979    
3980  Schoenebeck             Expires December 24, 2007              [Page 71]        "ERR:<error-code>:<error-message>" -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3981    
3982             in case it failed, providing an appropriate error code and
3983             error message
3984    
3985     Examples:     Examples:
3986    
# Line 4019  Internet-Draft    LinuxSampler Control P Line 4024  Internet-Draft    LinuxSampler Control P
4024     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4025     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4026    
 6.6.  Global commands  
   
    The following commands have global impact on the sampler.  
4027    
4028    
4029    
4030    
4031    Schoenebeck               Expires March 4, 2008                [Page 72]
4032    
4033    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4034    
4035    
4036  Schoenebeck             Expires December 24, 2007              [Page 72]  6.6.  Global commands
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4037    
4038       The following commands have global impact on the sampler.
4039    
4040  6.6.1.  Current number of active voices  6.6.1.  Current number of active voices
4041    
# Line 4074  Internet-Draft    LinuxSampler Control P Line 4078  Internet-Draft    LinuxSampler Control P
4078    
4079    
4080    
 6.6.4.  General sampler informations  
   
    The client can ask for general informations about the LinuxSampler  
    instance by sending the following command:  
4081    
4082    
4083    
4084    
4085    
4086    
4087  Schoenebeck             Expires December 24, 2007              [Page 73]  Schoenebeck               Expires March 4, 2008                [Page 73]
4088    
4089  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4090    
4091    
4092    6.6.4.  General sampler informations
4093    
4094       The client can ask for general informations about the LinuxSampler
4095       instance by sending the following command:
4096    
4097        GET SERVER INFO        GET SERVER INFO
4098    
4099     Possible Answers:     Possible Answers:
# Line 4131  Internet-Draft    LinuxSampler Control P Line 4136  Internet-Draft    LinuxSampler Control P
4136    
4137     Possible Answers:     Possible Answers:
4138    
       The sampler will always answer by returning the optional dotted  
       floating point coefficient, reflecting the current global volume  
       attenuation.  
4139    
    Note: it is up to the respective sampler engine whether to obey that  
    global volume parameter or not, but in general all engines SHOULD use  
4140    
4141    
4142    
4143  Schoenebeck             Expires December 24, 2007              [Page 74]  Schoenebeck               Expires March 4, 2008                [Page 74]
4144    
4145  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4146    
4147    
4148          The sampler will always answer by returning the optional dotted
4149          floating point coefficient, reflecting the current global volume
4150          attenuation.
4151    
4152       Note: it is up to the respective sampler engine whether to obey that
4153       global volume parameter or not, but in general all engines SHOULD use
4154     this parameter.     this parameter.
4155    
4156  6.6.6.  Setting global volume attenuation  6.6.6.  Setting global volume attenuation
# Line 4188  Internet-Draft    LinuxSampler Control P Line 4194  Internet-Draft    LinuxSampler Control P
4194     maps which define which instrument to load on which MIDI program     maps which define which instrument to load on which MIDI program
4195     change message.     change message.
4196    
    By default, that is when the sampler is launched, there is no map,  
    thus the sampler will simply ignore all program change messages.  The  
    front-end has to explicitly create at least one map, add entries to  
    the map and tell the respective sampler channel(s) which MIDI  
    instrument map to use, so the sampler knows how to react on a given  
   
4197    
4198    
4199  Schoenebeck             Expires December 24, 2007              [Page 75]  Schoenebeck               Expires March 4, 2008                [Page 75]
4200    
4201  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4202    
4203    
4204       By default, that is when the sampler is launched, there is no map,
4205       thus the sampler will simply ignore all program change messages.  The
4206       front-end has to explicitly create at least one map, add entries to
4207       the map and tell the respective sampler channel(s) which MIDI
4208       instrument map to use, so the sampler knows how to react on a given
4209     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
4210     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
4211     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
# Line 4242  Internet-Draft    LinuxSampler Control P Line 4247  Internet-Draft    LinuxSampler Control P
4247    
4248        S: "OK[0]"        S: "OK[0]"
4249    
       C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"  
4250    
       S: "OK[1]"  
4251    
       C: "ADD MIDI_INSTRUMENT_MAP"  
4252    
4253    
4254    
4255    Schoenebeck               Expires March 4, 2008                [Page 76]
4256    
4257    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4258    
4259    
4260  Schoenebeck             Expires December 24, 2007              [Page 76]        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4261    
4262          S: "OK[1]"
4263    
4264          C: "ADD MIDI_INSTRUMENT_MAP"
4265    
4266        S: "OK[5]"        S: "OK[5]"
4267    
# Line 4299  Internet-Draft    LinuxSampler Control P Line 4305  Internet-Draft    LinuxSampler Control P
4305     The front-end can retrieve the current amount of MIDI instrument maps     The front-end can retrieve the current amount of MIDI instrument maps
4306     by sending the following command:     by sending the following command:
4307    
       GET MIDI_INSTRUMENT_MAPS  
   
    Possible Answers:  
   
4308    
4309    
4310    
4311    Schoenebeck               Expires March 4, 2008                [Page 77]
4312    
4313    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4314    
4315    
4316  Schoenebeck             Expires December 24, 2007              [Page 77]        GET MIDI_INSTRUMENT_MAPS
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4317    
4318       Possible Answers:
4319    
4320        The sampler will answer by returning the current number of MIDI        The sampler will answer by returning the current number of MIDI
4321        instrument maps.        instrument maps.
# Line 4357  Internet-Draft    LinuxSampler Control P Line 4361  Internet-Draft    LinuxSampler Control P
4361        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4362        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
4363        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
       character string to that setting category.  At the moment the  
       following categories are defined:  
4364    
4365    
4366    
4367    Schoenebeck               Expires March 4, 2008                [Page 78]
   
 Schoenebeck             Expires December 24, 2007              [Page 78]  
4368    
4369  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4370    
4371    
4372          character string to that setting category.  At the moment the
4373          following categories are defined:
4374    
4375    
4376    
# Line 4417  Internet-Draft    LinuxSampler Control P Line 4420  Internet-Draft    LinuxSampler Control P
4420    
4421    
4422    
4423    Schoenebeck               Expires March 4, 2008                [Page 79]
   
   
 Schoenebeck             Expires December 24, 2007              [Page 79]  
4424    
4425  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4426    
4427    
4428        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
# Line 4476  Internet-Draft    LinuxSampler Control P Line 4476  Internet-Draft    LinuxSampler Control P
4476    
4477    
4478    
4479  Schoenebeck             Expires December 24, 2007              [Page 80]  Schoenebeck               Expires March 4, 2008                [Page 80]
4480    
4481  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4482    
4483    
4484        "PERSISTENT" -        "PERSISTENT" -
# Line 4532  Internet-Draft    LinuxSampler Control P Line 4532  Internet-Draft    LinuxSampler Control P
4532    
4533    
4534    
4535  Schoenebeck             Expires December 24, 2007              [Page 81]  Schoenebeck               Expires March 4, 2008                [Page 81]
4536    
4537  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4538    
4539    
4540     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
# Line 4588  Internet-Draft    LinuxSampler Control P Line 4588  Internet-Draft    LinuxSampler Control P
4588    
4589    
4590    
4591  Schoenebeck             Expires December 24, 2007              [Page 82]  Schoenebeck               Expires March 4, 2008                [Page 82]
4592    
4593  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4594    
4595    
4596        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
# Line 4644  Internet-Draft    LinuxSampler Control P Line 4644  Internet-Draft    LinuxSampler Control P
4644    
4645    
4646    
4647  Schoenebeck             Expires December 24, 2007              [Page 83]  Schoenebeck               Expires March 4, 2008                [Page 83]
4648    
4649  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4650    
4651    
4652        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
# Line 4700  Internet-Draft    LinuxSampler Control P Line 4700  Internet-Draft    LinuxSampler Control P
4700    
4701    
4702    
4703  Schoenebeck             Expires December 24, 2007              [Page 84]  Schoenebeck               Expires March 4, 2008                [Page 84]
4704    
4705  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4706    
4707    
4708        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 4756  Internet-Draft    LinuxSampler Control P Line 4756  Internet-Draft    LinuxSampler Control P
4756    
4757    
4758    
4759  Schoenebeck             Expires December 24, 2007              [Page 85]  Schoenebeck               Expires March 4, 2008                [Page 85]
4760    
4761  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4762    
4763    
4764        C: "GET MIDI_INSTRUMENT INFO 1 45 120"        C: "GET MIDI_INSTRUMENT INFO 1 45 120"
# Line 4812  Internet-Draft    LinuxSampler Control P Line 4812  Internet-Draft    LinuxSampler Control P
4812    
4813    
4814    
4815  Schoenebeck             Expires December 24, 2007              [Page 86]  Schoenebeck               Expires March 4, 2008                [Page 86]
4816    
4817  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4818    
4819    
4820        C: "CLEAR MIDI_INSTRUMENTS ALL"        C: "CLEAR MIDI_INSTRUMENTS ALL"
# Line 4826  Internet-Draft    LinuxSampler Control P Line 4826  Internet-Draft    LinuxSampler Control P
4826     The following commands describe how to use and manage the instruments     The following commands describe how to use and manage the instruments
4827     database.     database.
4828    
4829       Notice:
4830    
4831          All command arguments representing a path or instrument/directory
4832          name support escape sequences as described in chapter "Character
4833          Set and Escape Sequences (Section 7.1)".
4834    
4835          All occurrences of a forward slash in instrument and directory
4836          names are escaped with its hex (\x2f) or octal (\057) escape
4837          sequence.
4838    
4839  6.8.1.  Creating a new instrument directory  6.8.1.  Creating a new instrument directory
4840    
4841     The front-end can add a new instrument directory to the instruments     The front-end can add a new instrument directory to the instruments
# Line 4854  Internet-Draft    LinuxSampler Control P Line 4864  Internet-Draft    LinuxSampler Control P
4864    
4865        S: "OK"        S: "OK"
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires March 4, 2008                [Page 87]
4872    
4873    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4874    
4875    
4876  6.8.2.  Deleting an instrument directory  6.8.2.  Deleting an instrument directory
4877    
4878     The front-end can delete a particular instrument directory from the     The front-end can delete a particular instrument directory from the
# Line 4865  Internet-Draft    LinuxSampler Control P Line 4884  Internet-Draft    LinuxSampler Control P
4884     The optional FORCE argument can be used to force the deletion of a     The optional FORCE argument can be used to force the deletion of a
4885     non-empty directory and all its content.     non-empty directory and all its content.
4886    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 87]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4887     Possible Answers:     Possible Answers:
4888    
4889        "OK" -        "OK" -
# Line 4909  Internet-Draft    LinuxSampler Control P Line 4920  Internet-Draft    LinuxSampler Control P
4920    
4921        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4922    
          if the given directory does not exist.  
   
    Example:  
   
       C: "GET DB_INSTRUMENT_DIRECTORIES '/'"  
   
       S: "2"  
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires March 4, 2008                [Page 88]
4928    
4929    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4930    
4931    
4932             if the given directory does not exist.
4933    
4934       Example:
4935    
4936  Schoenebeck             Expires December 24, 2007              [Page 88]        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4937    
4938          S: "2"
4939    
4940  6.8.4.  Listing all directories in specific directory  6.8.4.  Listing all directories in specific directory
4941    
# Line 4969  Internet-Draft    LinuxSampler Control P Line 4977  Internet-Draft    LinuxSampler Control P
4977        GET DB_INSTRUMENT_DIRECTORY INFO <dir>        GET DB_INSTRUMENT_DIRECTORY INFO <dir>
4978    
4979     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
4980    
4981    
4982    
4983    Schoenebeck               Expires March 4, 2008                [Page 89]
4984    
4985    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4986    
4987    
4988     directory the front-end is interested in.     directory the front-end is interested in.
4989    
4990     Possible Answers:     Possible Answers:
# Line 4977  Internet-Draft    LinuxSampler Control P Line 4993  Internet-Draft    LinuxSampler Control P
4993        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
4994        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
4995        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 89]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4996        following categories are defined:        following categories are defined:
4997    
4998    
4999    
5000           DESCRIPTION -           DESCRIPTION -
5001    
5002              A brief description of the directory content              A brief description of the directory content.  Note that the
5003                character string may contain escape sequences (Section 7.1).
5004    
5005           CREATED -           CREATED -
5006    
# Line 5023  Internet-Draft    LinuxSampler Control P Line 5032  Internet-Draft    LinuxSampler Control P
5032     The front-end can alter the name of a specific instrument directory     The front-end can alter the name of a specific instrument directory
5033     by sending the following command:     by sending the following command:
5034    
       SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>  
5035    
    Where <dir> is the absolute path name of the directory and <name> is  
    the new name for that directory.  
5036    
    Possible Answers:  
5037    
       "OK" -  
5038    
5039    Schoenebeck               Expires March 4, 2008                [Page 90]
5040    
5041    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5042    
5043    
5044          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5045    
5046       Where <dir> is the absolute path name of the directory and <name> is
5047       the new name for that directory.
5048    
5049  Schoenebeck             Expires December 24, 2007              [Page 90]     Possible Answers:
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5050    
5051          "OK" -
5052    
5053           on success           on success
5054    
# Line 5080  Internet-Draft    LinuxSampler Control P Line 5089  Internet-Draft    LinuxSampler Control P
5089    
5090     Example:     Example:
5091    
       C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/  
       Acoustic'"  
   
       S: "OK"  
   
   
   
5092    
5093    
5094    
5095    Schoenebeck               Expires March 4, 2008                [Page 91]
5096    
5097    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5098    
5099    
5100  Schoenebeck             Expires December 24, 2007              [Page 91]        C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5101          Acoustic'"
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5102    
5103          S: "OK"
5104    
5105  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
5106    
# Line 5135  Internet-Draft    LinuxSampler Control P Line 5140  Internet-Draft    LinuxSampler Control P
5140        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5141    
5142     Where <dir> is the absolute path name of the directory and <desc> is     Where <dir> is the absolute path name of the directory and <desc> is
5143     the new description for the directory.     the new description for the directory (encapsulated into apostrophes,
5144       supporting escape sequences as described in chapter "Character Set
5145       and Escape Sequences (Section 7.1)").
5146    
5147     Possible Answers:     Possible Answers:
5148    
       "OK" -  
   
          on success  
   
   
5149    
5150    
5151    Schoenebeck               Expires March 4, 2008                [Page 92]
5152    
5153    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5154    
5155    
5156  Schoenebeck             Expires December 24, 2007              [Page 92]        "OK" -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5157    
5158             on success
5159    
5160        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5161    
# Line 5182  Internet-Draft    LinuxSampler Control P Line 5186  Internet-Draft    LinuxSampler Control P
5186     NAME='<search-string>'     NAME='<search-string>'
5187    
5188        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5189        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5190          escape sequences as described in chapter "Character Set and Escape
5191          Sequences (Section 7.1)").
5192    
5193     CREATED='[<date-after>]..[<date-before>]'     CREATED='[<date-after>]..[<date-before>]'
5194    
# Line 5195  Internet-Draft    LinuxSampler Control P Line 5201  Internet-Draft    LinuxSampler Control P
5201    
5202     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5203    
       Restricts the search to directories, which date of last  
       modification satisfies the specified period, where <date-after>  
       and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-  
       after> is omitted the search is restricted to directories, which  
       are last modified before <date-before>.  If <date-before> is  
       omitted, the search is restricted to directories, which are last  
5204    
5205    
5206    
5207  Schoenebeck             Expires December 24, 2007              [Page 93]  Schoenebeck               Expires March 4, 2008                [Page 93]
5208    
5209  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5210    
5211    
5212          Restricts the search to directories, which date of last
5213          modification satisfies the specified period, where <date-after>
5214          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5215          after> is omitted the search is restricted to directories, which
5216          are last modified before <date-before>.  If <date-before> is
5217          omitted, the search is restricted to directories, which are last
5218        modified after <date-after>.        modified after <date-after>.
5219    
5220     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5221    
5222        Restricts the search to directories with description that        Restricts the search to directories with description that
5223        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5224          apostrophes, supporting escape sequences as described in chapter
5225          "Character Set and Escape Sequences (Section 7.1)").
5226    
5227     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5228     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
# Line 5249  Internet-Draft    LinuxSampler Control P Line 5257  Internet-Draft    LinuxSampler Control P
5257        [<instr_index>]        [<instr_index>]
5258    
5259     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5260    
5261    
5262    
5263    Schoenebeck               Expires March 4, 2008                [Page 94]
5264    
5265    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5266    
5267    
5268     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
5269     instruments (that are not already in the database) will be added,     instruments (that are not already in the database) will be added,
5270     <file_path> is the absolute path name of a file or directory in the     <file_path> is the absolute path name of a file or directory in the
# Line 5257  Internet-Draft    LinuxSampler Control P Line 5273  Internet-Draft    LinuxSampler Control P
5273     added to the instruments database.  If the optional <instr_index>     added to the instruments database.  If the optional <instr_index>
5274     (the index of the instrument within the given file) is supplied too,     (the index of the instrument within the given file) is supplied too,
5275     then only the specified instrument will be added.  In case a     then only the specified instrument will be added.  In case a
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 94]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5276     directory is supplied, the instruments in that directory will be     directory is supplied, the instruments in that directory will be
5277     added.  The OPTIONAL <mode> argument is only applied when a directory     added.  The OPTIONAL <mode> argument is only applied when a directory
5278     is provided as <file_path> and specifies how the scanning will be     is provided as <file_path> and specifies how the scanning will be
# Line 5306  Internet-Draft    LinuxSampler Control P Line 5314  Internet-Draft    LinuxSampler Control P
5314           numerical ID used to obtain status information about the job           numerical ID used to obtain status information about the job
5315           progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)           progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5316    
       "ERR:<error-code>:<error-message>" -  
   
          if an invalid path is specified.  
   
    Examples:  
5317    
5318    
5319    Schoenebeck               Expires March 4, 2008                [Page 95]
5320    
5321    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5322    
5323    
5324          "ERR:<error-code>:<error-message>" -
5325    
5326  Schoenebeck             Expires December 24, 2007              [Page 95]           if an invalid path is specified.
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5327    
5328       Examples:
5329    
5330        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5331        Bosendorfer 290.gig' 0"        Bosendorfer 290.gig' 0"
# Line 5364  Internet-Draft    LinuxSampler Control P Line 5370  Internet-Draft    LinuxSampler Control P
5370     including those located in subdirectories of the specified directory,     including those located in subdirectories of the specified directory,
5371     will be returned.     will be returned.
5372    
    Possible Answers:  
   
       The current number of instruments in the specified directory.  
   
5373    
5374    
5375    Schoenebeck               Expires March 4, 2008                [Page 96]
5376    
5377    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5378    
5379    
5380  Schoenebeck             Expires December 24, 2007              [Page 96]     Possible Answers:
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5381    
5382          The current number of instruments in the specified directory.
5383    
5384        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5385    
# Line 5419  Internet-Draft    LinuxSampler Control P Line 5423  Internet-Draft    LinuxSampler Control P
5423        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5424        Steinway D','/Piano Collection/Lite/Free Piano'"        Steinway D','/Piano Collection/Lite/Free Piano'"
5425    
 6.8.15.  Getting instrument information  
   
    The front-end can ask for the current settings of an instrument by  
    sending the following command:  
5426    
5427    
5428    
5429    
5430    
5431  Schoenebeck             Expires December 24, 2007              [Page 97]  Schoenebeck               Expires March 4, 2008                [Page 97]
5432    
5433  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5434    
5435    
5436    6.8.15.  Getting instrument information
5437    
5438       The front-end can ask for the current settings of an instrument by
5439       sending the following command:
5440    
5441        GET DB_INSTRUMENT INFO <instr_path>        GET DB_INSTRUMENT INFO <instr_path>
5442    
# Line 5450  Internet-Draft    LinuxSampler Control P Line 5455  Internet-Draft    LinuxSampler Control P
5455    
5456           INSTRUMENT_FILE -           INSTRUMENT_FILE -
5457    
5458              File name of the instrument.              File name of the instrument.  Note that the character string
5459                may contain escape sequences (Section 7.1).
5460    
5461           INSTRUMENT_NR -           INSTRUMENT_NR -
5462    
# Line 5474  Internet-Draft    LinuxSampler Control P Line 5480  Internet-Draft    LinuxSampler Control P
5480              instruments database, represented in "YYYY-MM-DD HH:MM:SS"              instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5481              format              format
5482    
          MODIFIED -  
5483    
             The date and time of the last modification of the  
             instrument's database settings, represented in "YYYY-MM-DD  
             HH:MM:SS" format  
5484    
5485    
5486    
5487    Schoenebeck               Expires March 4, 2008                [Page 98]
5488    
5489    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5490    
5491    
5492  Schoenebeck             Expires December 24, 2007              [Page 98]           MODIFIED -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5493    
5494                The date and time of the last modification of the
5495                instrument's database settings, represented in "YYYY-MM-DD
5496                HH:MM:SS" format
5497    
5498           DESCRIPTION -           DESCRIPTION -
5499    
5500              A brief description of the instrument              A brief description of the instrument.  Note that the
5501                character string may contain escape sequences (Section 7.1).
5502    
5503           IS_DRUM -           IS_DRUM -
5504    
# Line 5500  Internet-Draft    LinuxSampler Control P Line 5507  Internet-Draft    LinuxSampler Control P
5507    
5508           PRODUCT -           PRODUCT -
5509    
5510              The product title of the instrument              The product title of the instrument.  Note that the
5511                character string may contain escape sequences (Section 7.1).
5512    
5513           ARTISTS -           ARTISTS -
5514    
5515              Lists the artist names              Lists the artist names.  Note that the character string may
5516                contain escape sequences (Section 7.1).
5517    
5518           KEYWORDS -           KEYWORDS -
5519    
5520              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
5521              Keywords are separated with semicolon and blank.              Keywords are separated with semicolon and blank.  Note that
5522                the character string may contain escape sequences
5523                (Section 7.1).
5524    
5525     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5526    
# Line 5525  Internet-Draft    LinuxSampler Control P Line 5536  Internet-Draft    LinuxSampler Control P
5536    
5537           "FORMAT_VERSION: 2"           "FORMAT_VERSION: 2"
5538    
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires March 4, 2008                [Page 99]
5544    
5545    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5546    
5547    
5548           "SIZE: 2050871870"           "SIZE: 2050871870"
5549    
5550           "CREATED: 2007-02-05 10:23:12"           "CREATED: 2007-02-05 10:23:12"
# Line 5537  Internet-Draft    LinuxSampler Control P Line 5557  Internet-Draft    LinuxSampler Control P
5557    
5558           "PRODUCT: GRANDIOSO Bosendorfer 290"           "PRODUCT: GRANDIOSO Bosendorfer 290"
5559    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 99]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5560           "ARTISTS: Post Musical Instruments"           "ARTISTS: Post Musical Instruments"
5561    
5562           "KEYWORDS: Bosendorfer"           "KEYWORDS: Bosendorfer"
# Line 5579  Internet-Draft    LinuxSampler Control P Line 5591  Internet-Draft    LinuxSampler Control P
5591    
5592        S: "OK"        S: "OK"
5593    
 6.8.17.  Moving an instrument  
5594    
    The front-end can move a specific instrument to another directory by  
    sending the following command:  
5595    
       MOVE DB_INSTRUMENT <instr> <dst>  
5596    
    Where <instr> is the absolute path name of the instrument to move and  
    <dst> is the directory where the instrument will be moved to.  
5597    
    Possible Answers:  
5598    
5599    Schoenebeck               Expires March 4, 2008               [Page 100]
5600    
5601    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5602    
5603    
5604    6.8.17.  Moving an instrument
5605    
5606       The front-end can move a specific instrument to another directory by
5607       sending the following command:
5608    
5609          MOVE DB_INSTRUMENT <instr> <dst>
5610    
5611  Schoenebeck             Expires December 24, 2007             [Page 100]     Where <instr> is the absolute path name of the instrument to move and
5612       <dst> is the directory where the instrument will be moved to.
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5613    
5614       Possible Answers:
5615    
5616        "OK" -        "OK" -
5617    
# Line 5636  Internet-Draft    LinuxSampler Control P Line 5648  Internet-Draft    LinuxSampler Control P
5648    
5649        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5650    
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires March 4, 2008               [Page 101]
5656    
5657    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5658    
5659    
5660           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
5661           instrument with name equal to the name of the specified           instrument with name equal to the name of the specified
5662           instrument already exists in the destination directory.           instrument already exists in the destination directory.
# Line 5647  Internet-Draft    LinuxSampler Control P Line 5668  Internet-Draft    LinuxSampler Control P
5668    
5669        S: "OK"        S: "OK"
5670    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 101]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5671  6.8.19.  Changing the description of instrument  6.8.19.  Changing the description of instrument
5672    
5673     The front-end can alter the description of a specific instrument by     The front-end can alter the description of a specific instrument by
# Line 5665  Internet-Draft    LinuxSampler Control P Line 5676  Internet-Draft    LinuxSampler Control P
5676        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5677    
5678     Where <instr> is the absolute path name of the instrument and <desc>     Where <instr> is the absolute path name of the instrument and <desc>
5679     is the new description for the instrument.     is the new description for the instrument (encapsulated into
5680       apostrophes, supporting escape sequences as described in chapter
5681       "Character Set and Escape Sequences (Section 7.1)").
5682    
5683     Possible Answers:     Possible Answers:
5684    
# Line 5692  Internet-Draft    LinuxSampler Control P Line 5705  Internet-Draft    LinuxSampler Control P
5705        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5706    
5707     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5708    
5709    
5710    
5711    Schoenebeck               Expires March 4, 2008               [Page 102]
5712    
5713    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5714    
5715    
5716     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5717     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5718     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 5701  Internet-Draft    LinuxSampler Control P Line 5722  Internet-Draft    LinuxSampler Control P
5722     NAME='<search-string>'     NAME='<search-string>'
5723    
5724        Restricts the search to instruments, which names satisfy the        Restricts the search to instruments, which names satisfy the
5725        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5726          escape sequences as described in chapter "Character Set and Escape
5727          Sequences (Section 7.1)").
5728    
5729     SIZE=[<min>]..[<max>]     SIZE=[<min>]..[<max>]
5730    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 102]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5731        Restricts the search to instruments, which size is in the        Restricts the search to instruments, which size is in the
5732        specified range.  If <min> is omitted, the search results are        specified range.  If <min> is omitted, the search results are
5733        restricted to instruments with size less then or equal to <max>.        restricted to instruments with size less then or equal to <max>.
# Line 5741  Internet-Draft    LinuxSampler Control P Line 5756  Internet-Draft    LinuxSampler Control P
5756     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5757    
5758        Restricts the search to instruments with description that        Restricts the search to instruments with description that
5759        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5760          apostrophes, supporting escape sequences as described in chapter
5761          "Character Set and Escape Sequences (Section 7.1)").
5762    
5763     PRODUCT='<search-string>'     PRODUCT='<search-string>'
5764    
5765    
5766    
5767    Schoenebeck               Expires March 4, 2008               [Page 103]
5768    
5769    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5770    
5771    
5772        Restricts the search to instruments with product info that        Restricts the search to instruments with product info that
5773        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5774          apostrophes, supporting escape sequences as described in chapter
5775          "Character Set and Escape Sequences (Section 7.1)").
5776    
5777     ARTISTS='<search-string>'     ARTISTS='<search-string>'
5778    
5779        Restricts the search to instruments with artists info that        Restricts the search to instruments with artists info that
5780        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5781          apostrophes, supporting escape sequences as described in chapter
5782          "Character Set and Escape Sequences (Section 7.1)").
5783    
5784     KEYWORDS='<search-string>'     KEYWORDS='<search-string>'
5785    
5786        Restricts the search to instruments with keyword list that        Restricts the search to instruments with keyword list that
5787        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5788          apostrophes, supporting escape sequences as described in chapter
5789          "Character Set and Escape Sequences (Section 7.1)").
5790    
5791     IS_DRUM=true | false     IS_DRUM=true | false
5792    
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 103]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5793        Either true or false.  Restricts the search to drum kits or        Either true or false.  Restricts the search to drum kits or
5794        chromatic instruments.        chromatic instruments.
5795    
# Line 5796  Internet-Draft    LinuxSampler Control P Line 5817  Internet-Draft    LinuxSampler Control P
5817        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5818        290'"        290'"
5819    
5820    
5821    
5822    
5823    Schoenebeck               Expires March 4, 2008               [Page 104]
5824    
5825    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5826    
5827    
5828        S: "'/Piano Collection/Bosendorfer 290'"        S: "'/Piano Collection/Bosendorfer 290'"
5829    
5830        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
# Line 5816  Internet-Draft    LinuxSampler Control P Line 5845  Internet-Draft    LinuxSampler Control P
5845    
5846     Possible Answers:     Possible Answers:
5847    
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 104]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5848        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5849        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5850        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
# Line 5854  Internet-Draft    LinuxSampler Control P Line 5874  Internet-Draft    LinuxSampler Control P
5874    
5875     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5876    
5877    
5878    
5879    Schoenebeck               Expires March 4, 2008               [Page 105]
5880    
5881    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5882    
5883    
5884     Example:     Example:
5885    
5886        C: "GET DB_INSTRUMENTS_JOB INFO 2"        C: "GET DB_INSTRUMENTS_JOB INFO 2"
# Line 5868  Internet-Draft    LinuxSampler Control P Line 5895  Internet-Draft    LinuxSampler Control P
5895    
5896           "."           "."
5897    
5898    6.8.22.  Formatting the instruments database
5899    
5900       The front-end can remove all instruments and directories and re-
5901       create the instruments database structure (e.g., in case of a
5902       database corruption) by sending the following command:
5903    
5904          FORMAT INSTRUMENTS_DB
5905    
5906       Possible Answers:
5907    
5908          "OK" -
5909    
5910             on success
5911    
5912          "ERR:<error-code>:<error-message>" -
5913    
5914             If the formatting of the instruments database failed.
5915    
5916    6.9.  Editing Instruments
5917    
5918       The sampler allows to edit instruments while playing with the sampler
5919       by spawning an external (3rd party) instrument editor application for
5920       a given instrument.  The 3rd party instrument editor applications
5921       have to place a respective plugin DLL file into the sampler's plugins
5922       directory.  The sampler will automatically try to load all plugin
5923       DLLs in that directory on startup and only on startup!
5924    
5925       At the moment there is only one command for this feature set, but
5926       this will most probably change in future.
5927    
5928    6.9.1.  Opening an appropriate instrument editor application
5929    
5930       The front-end can request to open an appropriate instrument editor
5931       application by sending the following command:
5932    
5933    
5934    
5935  Schoenebeck             Expires December 24, 2007             [Page 105]  Schoenebeck               Expires March 4, 2008               [Page 106]
5936    
5937  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5938    
5939    
5940          EDIT INSTRUMENT <sampler-channel>
5941    
5942       Where <sampler-channel> should be replaced by the number of the
5943       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
5944       "LIST CHANNELS" (Section 6.4.4) command.
5945    
5946       The sampler will try to ask all registered instrument editors (or to
5947       be more specific: their sampler plugins) whether they are capable to
5948       handle the instrument on the given sampler channel.  The sampler will
5949       simply use the first instrument editor application which replied with
5950       a positive answer and spawn that instrument editor application within
5951       the sampler's process and provide that application access to the
5952       instrument's data structures, so both applications can share and
5953       access the same instruments data at the same time, thus allowing to
5954       immediately hear changes with the sampler made by the instrument
5955       editor.
5956    
5957       Note: consequently instrument editors are always spawned locally on
5958       the same machine where the sampler is running on!
5959    
5960       Possible Answers:
5961    
5962          "OK" -
5963    
5964             when an appropriate instrument editor was launched
5965    
5966          "WRN:<warning-code>:<warning-message>" -
5967    
5968             when an appropriate instrument editor was launched, but there
5969             are noteworthy issues
5970    
5971          "ERR:<error-code>:<error-message>" -
5972    
5973             when an appropriate instrument editor could not be launched
5974    
5975       Examples:
5976    
5977          C: "EDIT INSTRUMENT 0"
5978    
5979          S: "OK"
5980    
5981    
5982    
5983    
5984    
5985    
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck               Expires March 4, 2008               [Page 107]
5992    
5993    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5994    
5995    
5996  7.  Command Syntax  7.  Command Syntax
# Line 5932  Internet-Draft    LinuxSampler Control P Line 6044  Internet-Draft    LinuxSampler Control P
6044    
6045    
6046    
6047  Schoenebeck             Expires December 24, 2007             [Page 106]  Schoenebeck               Expires March 4, 2008               [Page 108]
6048    
6049  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6050    
6051    
6052        / LIST SP list_instruction        / LIST SP list_instruction
# Line 5961  Internet-Draft    LinuxSampler Control P Line 6073  Internet-Draft    LinuxSampler Control P
6073    
6074        / EDIT SP edit_instruction        / EDIT SP edit_instruction
6075    
6076          / FORMAT SP format_instruction
6077    
6078        / RESET        / RESET
6079    
6080        / QUIT        / QUIT
# Line 5969  Internet-Draft    LinuxSampler Control P Line 6083  Internet-Draft    LinuxSampler Control P
6083    
6084        CHANNEL        CHANNEL
6085    
6086        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6087    
6088        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6089    
6090        / DB_INSTRUMENTS SP scan_mode SP pathname SP pathname        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6091    
6092        / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6093    
6094        / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6095        instrument_index        instrument_index
6096    
6097        / DB_INSTRUMENTS SP pathname SP pathname        / DB_INSTRUMENTS SP db_path SP filename
   
       / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  
6098    
6099    
6100    
6101    
6102    
6103  Schoenebeck             Expires December 24, 2007             [Page 107]  Schoenebeck               Expires March 4, 2008               [Page 109]
6104    
6105  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6106    
6107    
6108          / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6109    
6110        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
6111    
6112        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
# Line 6039  Internet-Draft    LinuxSampler Control P Line 6153  Internet-Draft    LinuxSampler Control P
6153    
6154        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6155    
       / MISCELLANEOUS  
   
6156    
6157    
6158    
6159  Schoenebeck             Expires December 24, 2007             [Page 108]  Schoenebeck               Expires March 4, 2008               [Page 110]
6160    
6161  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6162    
6163    
6164          / MISCELLANEOUS
6165    
6166        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6167    
6168        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6095  Internet-Draft    LinuxSampler Control P Line 6209  Internet-Draft    LinuxSampler Control P
6209    
6210        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6211    
       / MISCELLANEOUS  
   
6212    
6213    
6214    
6215  Schoenebeck             Expires December 24, 2007             [Page 109]  Schoenebeck               Expires March 4, 2008               [Page 111]
6216    
6217  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6218    
6219    
6220          / MISCELLANEOUS
6221    
6222        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6223    
# Line 6138  Internet-Draft    LinuxSampler Control P Line 6252  Internet-Draft    LinuxSampler Control P
6252    
6253        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6254    
6255        / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6256    
6257        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6258    
6259        / DB_INSTRUMENT SP pathname        / DB_INSTRUMENT SP db_path
6260    
6261     get_instruction =     get_instruction =
6262    
# Line 6150  Internet-Draft    LinuxSampler Control P Line 6264  Internet-Draft    LinuxSampler Control P
6264    
6265        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
6266    
       / MIDI_INPUT_DRIVER SP INFO SP string  
   
6267    
6268    
6269    
6270    
6271  Schoenebeck             Expires December 24, 2007             [Page 110]  Schoenebeck               Expires March 4, 2008               [Page 112]
6272    
6273  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6274    
6275    
6276          / MIDI_INPUT_DRIVER SP INFO SP string
6277    
6278        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6279    
6280        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
# Line 6206  Internet-Draft    LinuxSampler Control P Line 6320  Internet-Draft    LinuxSampler Control P
6320    
6321        / SERVER SP INFO        / SERVER SP INFO
6322    
       / TOTAL_VOICE_COUNT  
6323    
6324    
6325    
6326    
6327    Schoenebeck               Expires March 4, 2008               [Page 113]
 Schoenebeck             Expires December 24, 2007             [Page 111]  
6328    
6329  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6330    
6331    
6332          / TOTAL_VOICE_COUNT
6333    
6334        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
6335    
6336        / MIDI_INSTRUMENTS SP midi_map        / MIDI_INSTRUMENTS SP midi_map
# Line 6233  Internet-Draft    LinuxSampler Control P Line 6347  Internet-Draft    LinuxSampler Control P
6347    
6348        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6349    
6350        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6351    
6352        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP db_path
6353    
6354        / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname        / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6355    
6356        / DB_INSTRUMENTS SP RECURSIVE SP pathname        / DB_INSTRUMENTS SP RECURSIVE SP db_path
6357    
6358        / DB_INSTRUMENTS SP pathname        / DB_INSTRUMENTS SP db_path
6359    
6360        / DB_INSTRUMENT SP INFO SP pathname        / DB_INSTRUMENT SP INFO SP db_path
6361    
6362        / DB_INSTRUMENTS_JOB SP INFO SP number        / DB_INSTRUMENTS_JOB SP INFO SP number
6363    
# Line 6260  Internet-Draft    LinuxSampler Control P Line 6374  Internet-Draft    LinuxSampler Control P
6374        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6375        param_val_list        param_val_list
6376    
6377        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
       param_val_list  
6378    
       / CHANNEL SP set_chan_instruction  
6379    
6380    
6381    
6382    
6383  Schoenebeck             Expires December 24, 2007             [Page 112]  Schoenebeck               Expires March 4, 2008               [Page 114]
6384    
6385  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6386    
6387    
6388          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6389          param_val_list
6390    
6391          / CHANNEL SP set_chan_instruction
6392    
6393        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6394    
# Line 6286  Internet-Draft    LinuxSampler Control P Line 6403  Internet-Draft    LinuxSampler Control P
6403        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6404        volume_value        volume_value
6405    
6406        / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6407    
6408        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6409          stringval_escaped
6410    
6411        / DB_INSTRUMENT SP NAME SP pathname SP dirname        / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6412    
6413        / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6414    
6415        / ECHO SP boolean        / ECHO SP boolean
6416    
# Line 6314  Internet-Draft    LinuxSampler Control P Line 6432  Internet-Draft    LinuxSampler Control P
6432    
6433     reset_instruction =     reset_instruction =
6434    
       CHANNEL SP sampler_channel  
6435    
    clear_instruction =  
6436    
       MIDI_INSTRUMENTS SP midi_map  
6437    
6438    
6439    Schoenebeck               Expires March 4, 2008               [Page 115]
6440    
6441    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6442    
6443    
6444          CHANNEL SP sampler_channel
6445    
6446  Schoenebeck             Expires December 24, 2007             [Page 113]     clear_instruction =
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
6447    
6448          MIDI_INSTRUMENTS SP midi_map
6449    
6450        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
6451    
6452     find_instruction =     find_instruction =
6453    
6454        DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list        DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6455    
6456        / DB_INSTRUMENTS SP pathname SP query_val_list        / DB_INSTRUMENTS SP db_path SP query_val_list
6457    
6458        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
6459        query_val_list        query_val_list
6460    
6461        / DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6462    
6463     move_instruction =     move_instruction =
6464    
6465        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6466    
6467        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6468    
6469     copy_instruction =     copy_instruction =
6470    
6471        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6472    
6473        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6474    
6475     destroy_instruction =     destroy_instruction =
6476    
# Line 6370  Internet-Draft    LinuxSampler Control P Line 6488  Internet-Draft    LinuxSampler Control P
6488    
6489     set_chan_instruction =     set_chan_instruction =
6490    
       AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index  
6491    
       / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index  
       SP audio_channel_index  
6492    
       / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name  
6493    
6494    
6495    Schoenebeck               Expires March 4, 2008               [Page 116]
6496    
6497    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6498    
6499    
6500  Schoenebeck             Expires December 24, 2007             [Page 114]        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
6501    
6502          / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
6503          SP audio_channel_index
6504    
6505          / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6506    
6507        / MIDI_INPUT SP sampler_channel SP device_index SP        / MIDI_INPUT SP sampler_channel SP device_index SP
6508        midi_input_port_index SP midi_input_channel_index        midi_input_port_index SP midi_input_channel_index
# Line 6413  Internet-Draft    LinuxSampler Control P Line 6532  Internet-Draft    LinuxSampler Control P
6532    
6533        INSTRUMENT SP sampler_channel        INSTRUMENT SP sampler_channel
6534    
6535       format_instruction =
6536    
6537          INSTRUMENTS_DB
6538    
6539     modal_arg =     modal_arg =
6540    
6541        /* epsilon (empty argument) */        /* epsilon (empty argument) */
# Line 6421  Internet-Draft    LinuxSampler Control P Line 6544  Internet-Draft    LinuxSampler Control P
6544    
6545     key_val_list =     key_val_list =
6546    
6547    
6548    
6549    
6550    
6551    Schoenebeck               Expires March 4, 2008               [Page 117]
6552    
6553    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6554    
6555    
6556        string '=' param_val_list        string '=' param_val_list
6557    
6558        / key_val_list SP string '=' param_val_list        / key_val_list SP string '=' param_val_list
# Line 6433  Internet-Draft    LinuxSampler Control P Line 6565  Internet-Draft    LinuxSampler Control P
6565    
6566     list_instruction =     list_instruction =
6567    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 115]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6568        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
6569    
6570        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 6461  Internet-Draft    LinuxSampler Control P Line 6585  Internet-Draft    LinuxSampler Control P
6585    
6586        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6587    
6588        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6589    
6590        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP db_path
6591    
6592        / DB_INSTRUMENTS SP RECURSIVE SP pathname        / DB_INSTRUMENTS SP RECURSIVE SP db_path
6593    
6594        / DB_INSTRUMENTS SP pathname        / DB_INSTRUMENTS SP db_path
6595    
6596     load_instr_args =     load_instr_args =
6597    
# Line 6477  Internet-Draft    LinuxSampler Control P Line 6601  Internet-Draft    LinuxSampler Control P
6601    
6602     load_engine_args =     load_engine_args =
6603    
6604    
6605    
6606    
6607    Schoenebeck               Expires March 4, 2008               [Page 118]
6608    
6609    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6610    
6611    
6612        engine_name SP sampler_channel        engine_name SP sampler_channel
6613    
6614     instr_load_mode =     instr_load_mode =
# Line 6489  Internet-Draft    LinuxSampler Control P Line 6621  Internet-Draft    LinuxSampler Control P
6621    
6622     device_index =     device_index =
6623    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 116]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6624        number        number
6625    
6626     audio_channel_index =     audio_channel_index =
# Line 6533  Internet-Draft    LinuxSampler Control P Line 6657  Internet-Draft    LinuxSampler Control P
6657    
6658        number        number
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires March 4, 2008               [Page 119]
6664    
6665    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6666    
6667    
6668     midi_ctrl =     midi_ctrl =
6669    
6670        number        number
# Line 6545  Internet-Draft    LinuxSampler Control P Line 6677  Internet-Draft    LinuxSampler Control P
6677    
6678     sampler_channel =     sampler_channel =
6679    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 117]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6680        number        number
6681    
6682     instrument_index =     instrument_index =
# Line 6567  Internet-Draft    LinuxSampler Control P Line 6691  Internet-Draft    LinuxSampler Control P
6691    
6692        string        string
6693    
6694     pathname =     filename =
   
       stringval  
6695    
6696     dirname =        path
6697    
6698        stringval     db_path =
6699    
6700     filename =        path
   
       stringval_escaped  
6701    
6702     map_name =     map_name =
6703    
# Line 6593  Internet-Draft    LinuxSampler Control P Line 6713  Internet-Draft    LinuxSampler Control P
6713    
6714     param_val_list =     param_val_list =
6715    
       param_val  
6716    
       / param_val_list','param_val  
6717    
    param_val =  
6718    
6719        string  Schoenebeck               Expires March 4, 2008               [Page 120]
6720    
6721    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6722    
6723    
6724          param_val
6725    
6726          / param_val_list','param_val
6727    
6728  Schoenebeck             Expires December 24, 2007             [Page 118]     param_val =
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
6729    
6730          string
6731    
6732        / stringval        / stringval
6733    
# Line 6623  Internet-Draft    LinuxSampler Control P Line 6743  Internet-Draft    LinuxSampler Control P
6743    
6744     query_val =     query_val =
6745    
6746        string        textval_escaped
6747    
6748        / stringval        / stringval_escaped
6749    
6750     scan_mode =     scan_mode =
6751    
# Line 6652  Internet-Draft    LinuxSampler Control P Line 6772  Internet-Draft    LinuxSampler Control P
6772    
6773    
6774    
6775    Schoenebeck               Expires March 4, 2008               [Page 121]
   
   
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 119]  
6776    
6777  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6778    
6779    
6780     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 6716  Internet-Draft    LinuxSampler Control P Line 6828  Internet-Draft    LinuxSampler Control P
6828    
6829    
6830    
6831  Schoenebeck             Expires December 24, 2007             [Page 120]  Schoenebeck               Expires March 4, 2008               [Page 122]
6832    
6833  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6834    
6835    
6836  8.  Events  8.  Events
# Line 6772  Internet-Draft    LinuxSampler Control P Line 6884  Internet-Draft    LinuxSampler Control P
6884    
6885    
6886    
6887  Schoenebeck             Expires December 24, 2007             [Page 121]  Schoenebeck               Expires March 4, 2008               [Page 123]
6888    
6889  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6890    
6891    
6892        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 6828  Internet-Draft    LinuxSampler Control P Line 6940  Internet-Draft    LinuxSampler Control P
6940    
6941    
6942    
6943  Schoenebeck             Expires December 24, 2007             [Page 122]  Schoenebeck               Expires March 4, 2008               [Page 124]
6944    
6945  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6946    
6947    
6948        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
# Line 6884  Internet-Draft    LinuxSampler Control P Line 6996  Internet-Draft    LinuxSampler Control P
6996    
6997    
6998    
6999  Schoenebeck             Expires December 24, 2007             [Page 123]  Schoenebeck               Expires March 4, 2008               [Page 125]
7000    
7001  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7002    
7003    
7004        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 6940  Internet-Draft    LinuxSampler Control P Line 7052  Internet-Draft    LinuxSampler Control P
7052    
7053    
7054    
7055  Schoenebeck             Expires December 24, 2007             [Page 124]  Schoenebeck               Expires March 4, 2008               [Page 126]
7056    
7057  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7058    
7059    
7060        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
# Line 6996  Internet-Draft    LinuxSampler Control P Line 7108  Internet-Draft    LinuxSampler Control P
7108    
7109    
7110    
7111  Schoenebeck             Expires December 24, 2007             [Page 125]  Schoenebeck               Expires March 4, 2008               [Page 127]
7112    
7113  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7114    
7115    
7116        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
# Line 7052  Internet-Draft    LinuxSampler Control P Line 7164  Internet-Draft    LinuxSampler Control P
7164    
7165    
7166    
7167  Schoenebeck             Expires December 24, 2007             [Page 126]  Schoenebeck               Expires March 4, 2008               [Page 128]
7168    
7169  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7170    
7171    
7172  8.18.  Number of database instrument directories changed  8.18.  Number of database instrument directories changed
# Line 7108  Internet-Draft    LinuxSampler Control P Line 7220  Internet-Draft    LinuxSampler Control P
7220    
7221    
7222    
7223  Schoenebeck             Expires December 24, 2007             [Page 127]  Schoenebeck               Expires March 4, 2008               [Page 129]
7224    
7225  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7226    
7227    
7228  8.20.  Number of database instruments changed  8.20.  Number of database instruments changed
# Line 7164  Internet-Draft    LinuxSampler Control P Line 7276  Internet-Draft    LinuxSampler Control P
7276    
7277    
7278    
7279  Schoenebeck             Expires December 24, 2007             [Page 128]  Schoenebeck               Expires March 4, 2008               [Page 130]
7280    
7281  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7282    
7283    
7284  8.22.  Database job status information changed  8.22.  Database job status information changed
# Line 7220  Internet-Draft    LinuxSampler Control P Line 7332  Internet-Draft    LinuxSampler Control P
7332    
7333    
7334    
7335  Schoenebeck             Expires December 24, 2007             [Page 129]  Schoenebeck               Expires March 4, 2008               [Page 131]
7336    
7337  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7338    
7339    
7340  9.  Security Considerations  9.  Security Considerations
# Line 7276  Internet-Draft    LinuxSampler Control P Line 7388  Internet-Draft    LinuxSampler Control P
7388    
7389    
7390    
7391  Schoenebeck             Expires December 24, 2007             [Page 130]  Schoenebeck               Expires March 4, 2008               [Page 132]
7392    
7393  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7394    
7395    
7396  10.  Acknowledgments  10.  Acknowledgments
# Line 7332  Internet-Draft    LinuxSampler Control P Line 7444  Internet-Draft    LinuxSampler Control P
7444    
7445    
7446    
7447  Schoenebeck             Expires December 24, 2007             [Page 131]  Schoenebeck               Expires March 4, 2008               [Page 133]
7448    
7449  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7450    
7451    
7452  11.  References  11.  References
# Line 7388  Internet-Draft    LinuxSampler Control P Line 7500  Internet-Draft    LinuxSampler Control P
7500    
7501    
7502    
7503  Schoenebeck             Expires December 24, 2007             [Page 132]  Schoenebeck               Expires March 4, 2008               [Page 134]
7504    
7505  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7506    
7507    
7508  Author's Address  Author's Address
# Line 7444  Author's Address Line 7556  Author's Address
7556    
7557    
7558    
7559  Schoenebeck             Expires December 24, 2007             [Page 133]  Schoenebeck               Expires March 4, 2008               [Page 135]
7560    
7561  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7562    
7563    
7564  Full Copyright Statement  Full Copyright Statement
# Line 7500  Acknowledgment Line 7612  Acknowledgment
7612    
7613    
7614    
7615  Schoenebeck             Expires December 24, 2007             [Page 134]  Schoenebeck               Expires March 4, 2008               [Page 136]
7616    
7617    

Legend:
Removed from v.1362  
changed lines
  Added in v.1363

  ViewVC Help
Powered by ViewVC