/[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 1251 by schoenebeck, Fri Jun 22 14:24:57 2007 UTC revision 1390 by schoenebeck, Sun Oct 7 14:07:48 2007 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: December 24, 2007                                 June 22, 2007  Expires: April 9, 2008                                   October 7, 2007
8    
9    
10                   LinuxSampler Control Protocol (draft)                   LinuxSampler Control Protocol (draft)
# Line 33  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on December 24, 2007.     This Internet-Draft will expire on April 9, 2008.
37    
38  Copyright Notice  Copyright Notice
39    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck             Expires December 24, 2007               [Page 1]  Schoenebeck               Expires April 9, 2008                 [Page 1]
56    
57  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck             Expires December 24, 2007               [Page 2]  Schoenebeck               Expires April 9, 2008                 [Page 2]
112    
113  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.  Getting all created MIDI input device list  . . . . .  37
# Line 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 April 9, 2008                 [Page 3]
168    
169  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
170    
171    
172         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
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
181         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76
182         6.7.2.  Delete one particular or all MIDI instrument maps . .  77         6.7.2.  Delete one particular or all MIDI instrument maps . .  77
183         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  78
184         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78
185         6.7.5.  Getting MIDI instrument map information . . . . . . .  78         6.7.5.  Getting MIDI instrument map information . . . . . . .  78
186         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79
187         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80
188         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  83
189         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
190                 instrument map  . . . . . . . . . . . . . . . . . . .  83                 instrument map  . . . . . . . . . . . . . . . . . . .  83
191         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84
192         6.7.11. Get current settings of MIDI instrument map entry . .  84         6.7.11. Get current settings of MIDI instrument map entry . .  85
193         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87
195         6.8.1.  Creating a new instrument directory . . . . . . . . .  87         6.8.1.  Creating a new instrument directory . . . . . . . . .  87
196         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  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  . . . . . .  89
198         6.8.4.  Listing all directories in specific directory . . . .  89         6.8.4.  Listing all directories in specific directory . . . .  89
199         6.8.5.  Getting instrument directory information  . . . . . .  89         6.8.5.  Getting instrument directory information  . . . . . .  90
200         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91
201         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91
202         6.8.8.  Copying instrument directories  . . . . . . . . . . .  92         6.8.8.  Copying instrument directories  . . . . . . . . . . .  92
203         6.8.9.  Changing the description of directory . . . . . . . .  92         6.8.9.  Changing the description of directory . . . . . . . .  93
204         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93
205         6.8.11. Adding instruments to the instruments database  . . .  94         6.8.11. Adding instruments to the instruments database  . . .  95
206         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96
207         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96         6.8.13. Getting amount of instruments . . . . . . . . . . . .  97
208         6.8.14. Listing all instruments in specific directory . . . .  97         6.8.14. Listing all instruments in specific directory . . . .  97
209         6.8.15. Getting instrument information  . . . . . . . . . . .  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 . . . . . . . . . . . . . . . . . 102
213         6.8.19. Changing the description of instrument  . . . . . . . 102         6.8.19. Changing the description of instrument  . . . . . . . 102
214         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103
215         6.8.21. Getting job status information  . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . . . 107
218     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 121         6.9.1.  Opening an appropriate instrument editor
219       8.1.  Number of audio output devices changed  . . . . . . . . . 121                 application . . . . . . . . . . . . . . . . . . . . . 107
220    
221    
222    
223  Schoenebeck             Expires December 24, 2007               [Page 4]  Schoenebeck               Expires April 9, 2008                 [Page 4]
224    
225  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
226    
227    
228       8.2.  Audio output device's settings changed  . . . . . . . . . 121     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 109
229       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 121       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 122
230       8.4.  MIDI input device's settings changed  . . . . . . . . . . 122     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
231       8.5.  Number of sampler channels changed  . . . . . . . . . . . 122       8.1.  Number of audio output devices changed  . . . . . . . . . 126
232       8.6.  Number of active voices changed . . . . . . . . . . . . . 122       8.2.  Audio output device's settings changed  . . . . . . . . . 126
233       8.7.  Number of active disk streams changed . . . . . . . . . . 123       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 126
234       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 123       8.4.  MIDI input device's settings changed  . . . . . . . . . . 127
235       8.9.  Channel information changed . . . . . . . . . . . . . . . 123       8.5.  Number of sampler channels changed  . . . . . . . . . . . 127
236       8.10. Number of effect sends changed  . . . . . . . . . . . . . 124       8.6.  Number of active voices changed . . . . . . . . . . . . . 127
237       8.11. Effect send information changed . . . . . . . . . . . . . 124       8.7.  Number of active disk streams changed . . . . . . . . . . 128
238       8.12. Total number of active voices changed . . . . . . . . . . 124       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 128
239       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 125       8.9.  Channel information changed . . . . . . . . . . . . . . . 128
240       8.14. MIDI instrument map information changed . . . . . . . . . 125       8.10. Number of effect sends changed  . . . . . . . . . . . . . 129
241       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 125       8.11. Effect send information changed . . . . . . . . . . . . . 129
242       8.16. MIDI instrument information changed . . . . . . . . . . . 126       8.12. Total number of active voices changed . . . . . . . . . . 129
243       8.17. Global settings changed . . . . . . . . . . . . . . . . . 126       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 130
244       8.18. Number of database instrument directories changed . . . . 127       8.14. MIDI instrument map information changed . . . . . . . . . 130
245       8.19. Database instrument directory information changed . . . . 127       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 130
246       8.20. Number of database instruments changed  . . . . . . . . . 128       8.16. MIDI instrument information changed . . . . . . . . . . . 131
247       8.21. Database instrument information changed . . . . . . . . . 128       8.17. Global settings changed . . . . . . . . . . . . . . . . . 131
248       8.22. Database job status information changed . . . . . . . . . 129       8.18. Number of database instrument directories changed . . . . 132
249       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 129       8.19. Database instrument directory information changed . . . . 132
250     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 130       8.20. Number of database instruments changed  . . . . . . . . . 133
251     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 131       8.21. Database instrument information changed . . . . . . . . . 133
252     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 132       8.22. Database job status information changed . . . . . . . . . 134
253     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 133       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 134
254     Intellectual Property and Copyright Statements  . . . . . . . . . 134     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 135
255       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 136
256       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 137
257       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 138
258       Intellectual Property and Copyright Statements  . . . . . . . . . 139
259    
260    
261    
# Line 272  Internet-Draft    LinuxSampler Control P Line 276  Internet-Draft    LinuxSampler Control P
276    
277    
278    
279    Schoenebeck               Expires April 9, 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)     October 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft    LinuxSampler Control P Line 332  Internet-Draft    LinuxSampler Control P
332    
333    
334    
335  Schoenebeck             Expires December 24, 2007               [Page 6]  Schoenebeck               Expires April 9, 2008                 [Page 6]
336    
337  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 388  Internet-Draft    LinuxSampler Control P Line 388  Internet-Draft    LinuxSampler Control P
388    
389    
390    
391  Schoenebeck             Expires December 24, 2007               [Page 7]  Schoenebeck               Expires April 9, 2008                 [Page 7]
392    
393  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft    LinuxSampler Control P Line 444  Internet-Draft    LinuxSampler Control P
444    
445    
446    
447  Schoenebeck             Expires December 24, 2007               [Page 8]  Schoenebeck               Expires April 9, 2008                 [Page 8]
448    
449  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft    LinuxSampler Control P Line 500  Internet-Draft    LinuxSampler Control P
500    
501    
502    
503  Schoenebeck             Expires December 24, 2007               [Page 9]  Schoenebeck               Expires April 9, 2008                 [Page 9]
504    
505  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft    LinuxSampler Control P Line 556  Internet-Draft    LinuxSampler Control P
556    
557    
558    
559  Schoenebeck             Expires December 24, 2007              [Page 10]  Schoenebeck               Expires April 9, 2008                [Page 10]
560    
561  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft    LinuxSampler Control P Line 612  Internet-Draft    LinuxSampler Control P
612    
613    
614    
615  Schoenebeck             Expires December 24, 2007              [Page 11]  Schoenebeck               Expires April 9, 2008                [Page 11]
616    
617  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft    LinuxSampler Control P Line 668  Internet-Draft    LinuxSampler Control P
668    
669    
670    
671  Schoenebeck             Expires December 24, 2007              [Page 12]  Schoenebeck               Expires April 9, 2008                [Page 12]
672    
673  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft    LinuxSampler Control P Line 724  Internet-Draft    LinuxSampler Control P
724    
725    
726    
727  Schoenebeck             Expires December 24, 2007              [Page 13]  Schoenebeck               Expires April 9, 2008                [Page 13]
728    
729  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft    LinuxSampler Control P Line 780  Internet-Draft    LinuxSampler Control P
780    
781    
782    
783  Schoenebeck             Expires December 24, 2007              [Page 14]  Schoenebeck               Expires April 9, 2008                [Page 14]
784    
785  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft    LinuxSampler Control P Line 836  Internet-Draft    LinuxSampler Control P
836    
837    
838    
839  Schoenebeck             Expires December 24, 2007              [Page 15]  Schoenebeck               Expires April 9, 2008                [Page 15]
840    
841  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft    LinuxSampler Control P Line 892  Internet-Draft    LinuxSampler Control P
892    
893    
894    
895  Schoenebeck             Expires December 24, 2007              [Page 16]  Schoenebeck               Expires April 9, 2008                [Page 16]
896    
897  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft    LinuxSampler Control P Line 948  Internet-Draft    LinuxSampler Control P
948    
949    
950    
951  Schoenebeck             Expires December 24, 2007              [Page 17]  Schoenebeck               Expires April 9, 2008                [Page 17]
952    
953  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft    LinuxSampler Control P Line 1004  Internet-Draft    LinuxSampler Control P
1004    
1005    
1006    
1007  Schoenebeck             Expires December 24, 2007              [Page 18]  Schoenebeck               Expires April 9, 2008                [Page 18]
1008    
1009  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft    LinuxSampler Control P Line 1060  Internet-Draft    LinuxSampler Control P
1060    
1061    
1062    
1063  Schoenebeck             Expires December 24, 2007              [Page 19]  Schoenebeck               Expires April 9, 2008                [Page 19]
1064    
1065  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft    LinuxSampler Control P Line 1116  Internet-Draft    LinuxSampler Control P
1116    
1117    
1118    
1119  Schoenebeck             Expires December 24, 2007              [Page 20]  Schoenebeck               Expires April 9, 2008                [Page 20]
1120    
1121  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft    LinuxSampler Control P Line 1172  Internet-Draft    LinuxSampler Control P
1172    
1173    
1174    
1175  Schoenebeck             Expires December 24, 2007              [Page 21]  Schoenebeck               Expires April 9, 2008                [Page 21]
1176    
1177  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft    LinuxSampler Control P Line 1228  Internet-Draft    LinuxSampler Control P
1228    
1229    
1230    
1231  Schoenebeck             Expires December 24, 2007              [Page 22]  Schoenebeck               Expires April 9, 2008                [Page 22]
1232    
1233  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft    LinuxSampler Control P Line 1284  Internet-Draft    LinuxSampler Control P
1284    
1285    
1286    
1287  Schoenebeck             Expires December 24, 2007              [Page 23]  Schoenebeck               Expires April 9, 2008                [Page 23]
1288    
1289  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft    LinuxSampler Control P Line 1340  Internet-Draft    LinuxSampler Control P
1340    
1341    
1342    
1343  Schoenebeck             Expires December 24, 2007              [Page 24]  Schoenebeck               Expires April 9, 2008                [Page 24]
1344    
1345  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft    LinuxSampler Control P Line 1396  Internet-Draft    LinuxSampler Control P
1396    
1397    
1398    
1399  Schoenebeck             Expires December 24, 2007              [Page 25]  Schoenebeck               Expires April 9, 2008                [Page 25]
1400    
1401  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft    LinuxSampler Control P Line 1452  Internet-Draft    LinuxSampler Control P
1452    
1453    
1454    
1455  Schoenebeck             Expires December 24, 2007              [Page 26]  Schoenebeck               Expires April 9, 2008                [Page 26]
1456    
1457  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft    LinuxSampler Control P Line 1508  Internet-Draft    LinuxSampler Control P
1508    
1509    
1510    
1511  Schoenebeck             Expires December 24, 2007              [Page 27]  Schoenebeck               Expires April 9, 2008                [Page 27]
1512    
1513  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft    LinuxSampler Control P Line 1564  Internet-Draft    LinuxSampler Control P
1564    
1565    
1566    
1567  Schoenebeck             Expires December 24, 2007              [Page 28]  Schoenebeck               Expires April 9, 2008                [Page 28]
1568    
1569  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft    LinuxSampler Control P Line 1620  Internet-Draft    LinuxSampler Control P
1620    
1621    
1622    
1623  Schoenebeck             Expires December 24, 2007              [Page 29]  Schoenebeck               Expires April 9, 2008                [Page 29]
1624    
1625  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft    LinuxSampler Control P Line 1676  Internet-Draft    LinuxSampler Control P
1676    
1677    
1678    
1679  Schoenebeck             Expires December 24, 2007              [Page 30]  Schoenebeck               Expires April 9, 2008                [Page 30]
1680    
1681  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft    LinuxSampler Control P Line 1732  Internet-Draft    LinuxSampler Control P
1732    
1733    
1734    
1735  Schoenebeck             Expires December 24, 2007              [Page 31]  Schoenebeck               Expires April 9, 2008                [Page 31]
1736    
1737  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft    LinuxSampler Control P Line 1788  Internet-Draft    LinuxSampler Control P
1788    
1789    
1790    
1791  Schoenebeck             Expires December 24, 2007              [Page 32]  Schoenebeck               Expires April 9, 2008                [Page 32]
1792    
1793  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft    LinuxSampler Control P Line 1844  Internet-Draft    LinuxSampler Control P
1844    
1845    
1846    
1847  Schoenebeck             Expires December 24, 2007              [Page 33]  Schoenebeck               Expires April 9, 2008                [Page 33]
1848    
1849  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft    LinuxSampler Control P Line 1900  Internet-Draft    LinuxSampler Control P
1900    
1901    
1902    
1903  Schoenebeck             Expires December 24, 2007              [Page 34]  Schoenebeck               Expires April 9, 2008                [Page 34]
1904    
1905  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft    LinuxSampler Control P Line 1956  Internet-Draft    LinuxSampler Control P
1956    
1957    
1958    
1959  Schoenebeck             Expires December 24, 2007              [Page 35]  Schoenebeck               Expires April 9, 2008                [Page 35]
1960    
1961  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft    LinuxSampler Control P Line 2012  Internet-Draft    LinuxSampler Control P
2012    
2013    
2014    
2015  Schoenebeck             Expires December 24, 2007              [Page 36]  Schoenebeck               Expires April 9, 2008                [Page 36]
2016    
2017  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft    LinuxSampler Control P Line 2068  Internet-Draft    LinuxSampler Control P
2068    
2069    
2070    
2071  Schoenebeck             Expires December 24, 2007              [Page 37]  Schoenebeck               Expires April 9, 2008                [Page 37]
2072    
2073  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft    LinuxSampler Control P Line 2124  Internet-Draft    LinuxSampler Control P
2124    
2125    
2126    
2127  Schoenebeck             Expires December 24, 2007              [Page 38]  Schoenebeck               Expires April 9, 2008                [Page 38]
2128    
2129  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft    LinuxSampler Control P Line 2180  Internet-Draft    LinuxSampler Control P
2180    
2181    
2182    
2183  Schoenebeck             Expires December 24, 2007              [Page 39]  Schoenebeck               Expires April 9, 2008                [Page 39]
2184    
2185  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft    LinuxSampler Control P Line 2236  Internet-Draft    LinuxSampler Control P
2236    
2237    
2238    
2239  Schoenebeck             Expires December 24, 2007              [Page 40]  Schoenebeck               Expires April 9, 2008                [Page 40]
2240    
2241  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft    LinuxSampler Control P Line 2292  Internet-Draft    LinuxSampler Control P
2292    
2293    
2294    
2295  Schoenebeck             Expires December 24, 2007              [Page 41]  Schoenebeck               Expires April 9, 2008                [Page 41]
2296    
2297  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 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 April 9, 2008                [Page 42]
2352    
2353  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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.  
   
    Possible Answers:  
2404    
       "OK" -  
2405    
2406    
2407    Schoenebeck               Expires April 9, 2008                [Page 43]
2408    
2409    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 44]
2464    
2465    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 45]
2520    
2521    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 46]
2576    
2577    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 47]
2632    
2633    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 48]
2688    
2689    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 49]
2744    
2745  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 December 24, 2007              [Page 50]  Schoenebeck               Expires April 9, 2008                [Page 50]
2800    
2801  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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
# 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 April 9, 2008                [Page 51]
2856    
2857  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
2858    
2859    
2860             "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2861    
2862           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
2863    
# 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 April 9, 2008                [Page 52]
2912    
2913  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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    
2923     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
# 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 April 9, 2008                [Page 53]
2968    
2969    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 54]
   
 Schoenebeck             Expires December 24, 2007              [Page 54]  
3024    
3025  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 55]
3080    
3081  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 56]
3136    
3137  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 57]
3192    
3193  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 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)     October 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 April 9, 2008                [Page 59]
3304    
3305    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3306    
3307    
3308    
 Schoenebeck             Expires December 24, 2007              [Page 59]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3309    
3310    6.4.22.  Muting a sampler channel
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 April 9, 2008                [Page 60]
3360    
3361    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 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)     October 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 3445  Internet-Draft    LinuxSampler Control P Line 3450  Internet-Draft    LinuxSampler Control P
3450     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3451     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3452     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3453     effect send entity.  The name does not have to be unique.     effect send entity.  The name does not have to be unique, but MUST be
3454       encapsulated into apostrophes and supports escape sequences as
3455       described in chapter "Character Set and Escape Sequences
3456       (Section 7.1)".
3457    
3458     By default, that is as initial routing, the effect send's audio     By default, that is as initial routing, the effect send's audio
3459     channels are automatically routed to the last audio channels of the     channels are automatically routed to the last audio channels of the
# Line 3457  Internet-Draft    LinuxSampler Control P Line 3465  Internet-Draft    LinuxSampler Control P
3465     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3466    
3467     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3468    
3469    
3470    
3471    Schoenebeck               Expires April 9, 2008                [Page 62]
3472    
3473    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3474    
3475    
3476     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
3477     runtime performance, because for implementing channel effect sends,     runtime performance, because for implementing channel effect sends,
3478     separate (sampler channel local) audio buffers are needed to render     separate (sampler channel local) audio buffers are needed to render
# Line 3466  Internet-Draft    LinuxSampler Control P Line 3482  Internet-Draft    LinuxSampler Control P
3482     can mix its voices directly into the audio output devices's audio     can mix its voices directly into the audio output devices's audio
3483     buffers and is thus faster.     buffers and is thus faster.
3484    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 62]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3485     Possible Answers:     Possible Answers:
3486    
3487        "OK[<fx-send-id>]" -        "OK[<fx-send-id>]" -
# Line 3512  Internet-Draft    LinuxSampler Control P Line 3521  Internet-Draft    LinuxSampler Control P
3521    
3522     Possible Answers:     Possible Answers:
3523    
       "OK" -  
3524    
          on success  
3525    
       "ERR:<error-code>:<error-message>" -  
3526    
3527           in case it failed, providing an appropriate error code and  Schoenebeck               Expires April 9, 2008                [Page 63]
3528           error message  
3529    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3530    
3531    
3532          "OK" -
3533    
3534             on success
3535    
3536  Schoenebeck             Expires December 24, 2007              [Page 63]        "ERR:<error-code>:<error-message>" -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3537    
3538             in case it failed, providing an appropriate error code and
3539             error message
3540    
3541     Example:     Example:
3542    
# Line 3568  Internet-Draft    LinuxSampler Control P Line 3577  Internet-Draft    LinuxSampler Control P
3577     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3578     (Section 6.4.4) command.     (Section 6.4.4) command.
3579    
    Possible Answers:  
   
       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 April 9, 2008                [Page 64]
3584    
3585    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3586    
3587    
3588       Possible Answers:
3589    
3590  Schoenebeck             Expires December 24, 2007              [Page 64]        The sampler will answer by returning a comma separated list with
3591          all effect sends' numerical IDs on the given sampler channel.
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3592    
3593       Examples:
3594    
3595        C: "LIST FX_SENDS 0"        C: "LIST FX_SENDS 0"
3596    
# Line 3625  Internet-Draft    LinuxSampler Control P Line 3632  Internet-Draft    LinuxSampler Control P
3632              a value between 0 and 127 reflecting the MIDI controller              a value between 0 and 127 reflecting the MIDI controller
3633              which is able to modify the effect send's send level              which is able to modify the effect send's send level
3634    
          LEVEL -  
   
             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 April 9, 2008                [Page 65]
3640    
3641    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3642    
3643    
3644  Schoenebeck             Expires December 24, 2007              [Page 65]           LEVEL -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3645    
3646                optionally dotted number reflecting the effect send's
3647                current send level (where a value < 1.0 means attenuation
3648                and a value > 1.0 means amplification)
3649    
3650           AUDIO_OUTPUT_ROUTING -           AUDIO_OUTPUT_ROUTING -
3651    
# Line 3679  Internet-Draft    LinuxSampler Control P Line 3685  Internet-Draft    LinuxSampler Control P
3685     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3686     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3687     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3688     effect send entity, which does not have to be unique.     effect send entity, which does not have to be unique (name MUST be
3689       encapsulated into apostrophes and supports escape sequences as
3690     Possible Answers:     described in chapter "Character Set and Escape Sequences
3691       (Section 7.1)").
       "OK" -  
   
          on success  
3692    
3693    
3694    
3695    Schoenebeck               Expires April 9, 2008                [Page 66]
3696    
3697    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
3698    
3699    
3700       Possible Answers:
3701    
3702  Schoenebeck             Expires December 24, 2007              [Page 66]        "OK" -
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
3703    
3704             on success
3705    
3706        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3707    
# Line 3740  Internet-Draft    LinuxSampler Control P Line 3746  Internet-Draft    LinuxSampler Control P
3746    
3747     Possible Answers:     Possible Answers:
3748    
       "OK" -  
   
          on success  
   
3749    
3750    
3751    Schoenebeck               Expires April 9, 2008                [Page 67]
3752    
3753    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 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)     October 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
3816    
# 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 April 9, 2008                [Page 69]
3864    
3865  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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    
3874     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
# 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 April 9, 2008                [Page 70]
3920    
3921  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 71]
3976    
3977    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 72]
4032    
4033    Internet-Draft    LinuxSampler Control Protocol (draft)     October 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 April 9, 2008                [Page 73]
4088    
4089  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 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    
# Line 4103  Internet-Draft    LinuxSampler Control P Line 4108  Internet-Draft    LinuxSampler Control P
4108    
4109           DESCRIPTION -           DESCRIPTION -
4110    
4111              arbitrary textual description about the sampler              arbitrary textual description about the sampler (note that
4112                the character string may contain escape sequences
4113                (Section 7.1))
4114    
4115           VERSION -           VERSION -
4116    
# Line 4131  Internet-Draft    LinuxSampler Control P Line 4138  Internet-Draft    LinuxSampler Control P
4138    
4139     Possible Answers:     Possible Answers:
4140    
4141    
4142    
4143    Schoenebeck               Expires April 9, 2008                [Page 74]
4144    
4145    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4146    
4147    
4148        The sampler will always answer by returning the optional dotted        The sampler will always answer by returning the optional dotted
4149        floating point coefficient, reflecting the current global volume        floating point coefficient, reflecting the current global volume
4150        attenuation.        attenuation.
4151    
4152     Note: it is up to the respective sampler engine whether to obey that     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     global volume parameter or not, but in general all engines SHOULD use
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 74]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
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 April 9, 2008                [Page 75]
 Schoenebeck             Expires December 24, 2007              [Page 75]  
4200    
4201  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4202    
4203    
4204       By default, that is when the sampler is launched, there is no map,
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 4222  Internet-Draft    LinuxSampler Control P Line 4227  Internet-Draft    LinuxSampler Control P
4227        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4228    
4229     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
4230     to the new map.  MIDI instrument Map names do not have to be unique.     to the new map.  MIDI instrument Map names do not have to be unique,
4231       but MUST be encapsulated into apostrophes and support escape
4232       sequences as described in chapter "Character Set and Escape Sequences
4233       (Section 7.1)".
4234    
4235     Possible Answers:     Possible Answers:
4236    
# Line 4240  Internet-Draft    LinuxSampler Control P Line 4248  Internet-Draft    LinuxSampler Control P
4248    
4249        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4250    
       S: "OK[0]"  
4251    
       C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"  
4252    
       S: "OK[1]"  
4253    
       C: "ADD MIDI_INSTRUMENT_MAP"  
4254    
4255    Schoenebeck               Expires April 9, 2008                [Page 76]
4256    
4257    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4258    
4259    
4260          S: "OK[0]"
4261    
4262          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4263    
4264  Schoenebeck             Expires December 24, 2007              [Page 76]        S: "OK[1]"
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4265    
4266          C: "ADD MIDI_INSTRUMENT_MAP"
4267    
4268        S: "OK[5]"        S: "OK[5]"
4269    
# Line 4294  Internet-Draft    LinuxSampler Control P Line 4302  Internet-Draft    LinuxSampler Control P
4302    
4303        S: "OK"        S: "OK"
4304    
 6.7.3.  Get amount of existing MIDI instrument maps  
4305    
    The front-end can retrieve the current amount of MIDI instrument maps  
    by sending the following command:  
4306    
       GET MIDI_INSTRUMENT_MAPS  
4307    
    Possible Answers:  
4308    
4309    
4310    
4311    Schoenebeck               Expires April 9, 2008                [Page 77]
4312    
4313    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4314    
4315    
4316    6.7.3.  Get amount of existing MIDI instrument maps
4317    
4318       The front-end can retrieve the current amount of MIDI instrument maps
4319       by sending the following command:
4320    
4321  Schoenebeck             Expires December 24, 2007              [Page 77]        GET MIDI_INSTRUMENT_MAPS
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4322    
4323       Possible Answers:
4324    
4325        The sampler will answer by returning the current number of MIDI        The sampler will answer by returning the current number of MIDI
4326        instrument maps.        instrument maps.
# Line 4352  Internet-Draft    LinuxSampler Control P Line 4361  Internet-Draft    LinuxSampler Control P
4361     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4362     (Section 6.7.4) command.     (Section 6.7.4) command.
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires April 9, 2008                [Page 78]
4368    
4369    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4370    
4371    
4372     Possible Answers:     Possible Answers:
4373    
4374        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 4362  Internet-Draft    LinuxSampler Control P Line 4379  Internet-Draft    LinuxSampler Control P
4379    
4380    
4381    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 78]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
   
   
4382           NAME -           NAME -
4383    
4384              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
# Line 4401  Internet-Draft    LinuxSampler Control P Line 4409  Internet-Draft    LinuxSampler Control P
4409        SET MIDI_INSTRUMENT_MAP NAME <map> <name>        SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4410    
4411     Where <map> is the numerical ID of the map and <name> the new custom     Where <map> is the numerical ID of the map and <name> the new custom
4412     name of the map, which does not have to be unique.     name of the map, which does not have to be unique (name MUST be
4413       encapsulated into apostrophes and supports escape sequences as
4414       described in chapter "Character Set and Escape Sequences
4415       (Section 7.1)").
4416    
4417     Possible Answers:     Possible Answers:
4418    
       "OK" -  
4419    
          on success  
4420    
       "ERR:<error-code>:<error-message>" -  
4421    
          in case the given map does not exist  
   
    Example:  
4422    
4423    Schoenebeck               Expires April 9, 2008                [Page 79]
4424    
4425    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4426    
4427    
4428          "OK" -
4429    
4430             on success
4431    
4432          "ERR:<error-code>:<error-message>" -
4433    
4434  Schoenebeck             Expires December 24, 2007              [Page 79]           in case the given map does not exist
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4435    
4436       Example:
4437    
4438        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4439    
# Line 4464  Internet-Draft    LinuxSampler Control P Line 4474  Internet-Draft    LinuxSampler Control P
4474           be freed from memory when not needed by any sampler channel           be freed from memory when not needed by any sampler channel
4475           anymore.           anymore.
4476    
4477    
4478    
4479    Schoenebeck               Expires April 9, 2008                [Page 80]
4480    
4481    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4482    
4483    
4484        "ON_DEMAND_HOLD" -        "ON_DEMAND_HOLD" -
4485    
4486           The instrument will be loaded when needed, that is when           The instrument will be loaded when needed, that is when
# Line 4474  Internet-Draft    LinuxSampler Control P Line 4491  Internet-Draft    LinuxSampler Control P
4491           instrument) are explicitly changed to "ON_DEMAND" and no           instrument) are explicitly changed to "ON_DEMAND" and no
4492           sampler channel is using the instrument anymore.           sampler channel is using the instrument anymore.
4493    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 80]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4494        "PERSISTENT" -        "PERSISTENT" -
4495    
4496           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
# Line 4515  Internet-Draft    LinuxSampler Control P Line 4525  Internet-Draft    LinuxSampler Control P
4525     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4526     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4527     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4528     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes, supporting escape sequences as described in chapter
4529     displaying an appropriate name for mapped instruments (using "GET     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4530     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     entry, useful for frontends for displaying an appropriate name for
4531       mapped instruments (using "GET MIDI_INSTRUMENT INFO"
4532    
4533    
4534    
4535    Schoenebeck               Expires April 9, 2008                [Page 81]
4536    
4537    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4538    
4539    
4540       (Section 6.7.11)).
4541    
4542     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4543     completely established in the sampler.  The OPTIONAL "NON_MODAL"     completely established in the sampler.  The OPTIONAL "NON_MODAL"
# Line 4529  Internet-Draft    LinuxSampler Control P Line 4549  Internet-Draft    LinuxSampler Control P
4549     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4550     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4551     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 81]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4552     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4553     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4554     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4573  Internet-Draft    LinuxSampler Control P Line 4585  Internet-Draft    LinuxSampler Control P
4585        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4586        'Silent Piano'"        'Silent Piano'"
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires April 9, 2008                [Page 82]
4592    
4593    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4594    
4595    
4596        S: "OK"        S: "OK"
4597    
4598        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
# Line 4585  Internet-Draft    LinuxSampler Control P Line 4605  Internet-Draft    LinuxSampler Control P
4605     The front-end can query the amount of currently existing entries in a     The front-end can query the amount of currently existing entries in a
4606     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4607    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 82]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4608        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
4609    
4610     The front-end can query the amount of currently existing entries in     The front-end can query the amount of currently existing entries in
# Line 4627  Internet-Draft    LinuxSampler Control P Line 4639  Internet-Draft    LinuxSampler Control P
4639     The front-end can query a list of all currently existing entries of     The front-end can query a list of all currently existing entries of
4640     all MIDI instrument maps by sending the following command:     all MIDI instrument maps by sending the following command:
4641    
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires April 9, 2008                [Page 83]
4648    
4649    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4650    
4651    
4652        LIST MIDI_INSTRUMENTS ALL        LIST MIDI_INSTRUMENTS ALL
4653    
4654     Possible Answers:     Possible Answers:
# Line 4641  Internet-Draft    LinuxSampler Control P Line 4663  Internet-Draft    LinuxSampler Control P
4663    
4664     Example:     Example:
4665    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 83]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4666        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
4667    
4668        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
# Line 4681  Internet-Draft    LinuxSampler Control P Line 4695  Internet-Draft    LinuxSampler Control P
4695    
4696        S: "OK"        S: "OK"
4697    
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires April 9, 2008                [Page 84]
4704    
4705    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4706    
4707    
4708  6.7.11.  Get current settings of MIDI instrument map entry  6.7.11.  Get current settings of MIDI instrument map entry
4709    
4710     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
# Line 4696  Internet-Draft    LinuxSampler Control P Line 4720  Internet-Draft    LinuxSampler Control P
4720    
4721     Possible Answers:     Possible Answers:
4722    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 84]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4723        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4724        answer line begins with the information category name followed by        answer line begins with the information category name followed by
4725        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 4737  Internet-Draft    LinuxSampler Control P Line 4752  Internet-Draft    LinuxSampler Control P
4752           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4753           cannot be changed.           cannot be changed.
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires April 9, 2008                [Page 85]
4760    
4761    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4762    
4763    
4764        "LOAD_MODE" -        "LOAD_MODE" -
4765    
4766           Life time of instrument (see "MAP MIDI_INSTRUMENT"           Life time of instrument (see "MAP MIDI_INSTRUMENT"
# Line 4752  Internet-Draft    LinuxSampler Control P Line 4776  Internet-Draft    LinuxSampler Control P
4776    
4777     Example:     Example:
4778    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 85]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4779        C: "GET MIDI_INSTRUMENT INFO 1 45 120"        C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4780    
4781        S: "NAME: Drums for Foo Song"        S: "NAME: Drums for Foo Song"
# Line 4794  Internet-Draft    LinuxSampler Control P Line 4809  Internet-Draft    LinuxSampler Control P
4809        CLEAR MIDI_INSTRUMENTS ALL        CLEAR MIDI_INSTRUMENTS ALL
4810    
4811     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4812    
4813    
4814    
4815    Schoenebeck               Expires April 9, 2008                [Page 86]
4816    
4817    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4818    
4819    
4820     only their entries, thus the map's settings like custom name will be     only their entries, thus the map's settings like custom name will be
4821     preservevd.     preservevd.
4822    
# Line 4809  Internet-Draft    LinuxSampler Control P Line 4832  Internet-Draft    LinuxSampler Control P
4832    
4833        S: "OK"        S: "OK"
4834    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 86]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4835        C: "CLEAR MIDI_INSTRUMENTS ALL"        C: "CLEAR MIDI_INSTRUMENTS ALL"
4836    
4837        S: "OK"        S: "OK"
# Line 4826  Internet-Draft    LinuxSampler Control P Line 4841  Internet-Draft    LinuxSampler Control P
4841     The following commands describe how to use and manage the instruments     The following commands describe how to use and manage the instruments
4842     database.     database.
4843    
4844       Notice:
4845    
4846          All command arguments representing a path or instrument/directory
4847          name support escape sequences as described in chapter "Character
4848          Set and Escape Sequences (Section 7.1)".
4849    
4850          All occurrences of a forward slash in instrument and directory
4851          names are escaped with its hex (\x2f) or octal (\057) escape
4852          sequence.
4853    
4854  6.8.1.  Creating a new instrument directory  6.8.1.  Creating a new instrument directory
4855    
4856     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 4838  Internet-Draft    LinuxSampler Control P Line 4863  Internet-Draft    LinuxSampler Control P
4863    
4864     Possible Answers:     Possible Answers:
4865    
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires April 9, 2008                [Page 87]
4872    
4873    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4874    
4875    
4876        "OK" -        "OK" -
4877    
4878           on success           on success
# Line 4865  Internet-Draft    LinuxSampler Control P Line 4900  Internet-Draft    LinuxSampler Control P
4900     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
4901     non-empty directory and all its content.     non-empty directory and all its content.
4902    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 87]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4903     Possible Answers:     Possible Answers:
4904    
4905        "OK" -        "OK" -
# Line 4890  Internet-Draft    LinuxSampler Control P Line 4917  Internet-Draft    LinuxSampler Control P
4917    
4918        S: "OK"        S: "OK"
4919    
4920    
4921    
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires April 9, 2008                [Page 88]
4928    
4929    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4930    
4931    
4932  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
4933    
4934     The front-end can retrieve the current amount of directories in a     The front-end can retrieve the current amount of directories in a
# Line 4917  Internet-Draft    LinuxSampler Control P Line 4956  Internet-Draft    LinuxSampler Control P
4956    
4957        S: "2"        S: "2"
4958    
   
   
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 88]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4959  6.8.4.  Listing all directories in specific directory  6.8.4.  Listing all directories in specific directory
4960    
4961     The front-end can retrieve the current list of directories in     The front-end can retrieve the current list of directories in
# Line 4950  Internet-Draft    LinuxSampler Control P Line 4977  Internet-Draft    LinuxSampler Control P
4977    
4978           if the given directory does not exist.           if the given directory does not exist.
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires April 9, 2008                [Page 89]
4984    
4985    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
4986    
4987    
4988     Example:     Example:
4989    
4990        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
# Line 4977  Internet-Draft    LinuxSampler Control P Line 5012  Internet-Draft    LinuxSampler Control P
5012        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5013        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
5014        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  
   
   
5015        following categories are defined:        following categories are defined:
5016    
5017    
5018    
5019           DESCRIPTION -           DESCRIPTION -
5020    
5021              A brief description of the directory content              A brief description of the directory content.  Note that the
5022                character string may contain escape sequences (Section 7.1).
5023    
5024           CREATED -           CREATED -
5025    
# Line 5005  Internet-Draft    LinuxSampler Control P Line 5033  Internet-Draft    LinuxSampler Control P
5033    
5034     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires April 9, 2008                [Page 90]
5040    
5041    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5042    
5043    
5044     Example:     Example:
5045    
5046        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
# Line 5032  Internet-Draft    LinuxSampler Control P Line 5068  Internet-Draft    LinuxSampler Control P
5068    
5069        "OK" -        "OK" -
5070    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 90]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5071           on success           on success
5072    
5073        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5060  Internet-Draft    LinuxSampler Control P Line 5087  Internet-Draft    LinuxSampler Control P
5087     The front-end can move a specific instrument directory by sending the     The front-end can move a specific instrument directory by sending the
5088     following command:     following command:
5089    
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires April 9, 2008                [Page 91]
5096    
5097    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5098    
5099    
5100        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5101    
5102     Where <dir> is the absolute path name of the directory to move and     Where <dir> is the absolute path name of the directory to move and
# Line 5085  Internet-Draft    LinuxSampler Control P Line 5122  Internet-Draft    LinuxSampler Control P
5122    
5123        S: "OK"        S: "OK"
5124    
   
   
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 91]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5125  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
5126    
5127     The front-end can copy a specific instrument directory by sending the     The front-end can copy a specific instrument directory by sending the
# Line 5120  Internet-Draft    LinuxSampler Control P Line 5145  Internet-Draft    LinuxSampler Control P
5145           exists in the destination directory.  Error is also thrown when           exists in the destination directory.  Error is also thrown when
5146           trying to copy a directory to a subdirectory of itself.           trying to copy a directory to a subdirectory of itself.
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires April 9, 2008                [Page 92]
5152    
5153    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5154    
5155    
5156     Example:     Example:
5157    
5158        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
# Line 5135  Internet-Draft    LinuxSampler Control P Line 5168  Internet-Draft    LinuxSampler Control P
5168        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5169    
5170     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
5171     the new description for the directory.     the new description for the directory (encapsulated into apostrophes,
5172       supporting escape sequences as described in chapter "Character Set
5173       and Escape Sequences (Section 7.1)").
5174    
5175     Possible Answers:     Possible Answers:
5176    
# Line 5143  Internet-Draft    LinuxSampler Control P Line 5178  Internet-Draft    LinuxSampler Control P
5178    
5179           on success           on success
5180    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 92]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5181        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5182    
5183           in case the given directory does not exists.           in case the given directory does not exists.
# Line 5176  Internet-Draft    LinuxSampler Control P Line 5201  Internet-Draft    LinuxSampler Control P
5201     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5202     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5203     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
5204    
5205    
5206    
5207    Schoenebeck               Expires April 9, 2008                [Page 93]
5208    
5209    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5210    
5211    
5212     form of "key1=val1 key2=val2 ...".  The following criterias are     form of "key1=val1 key2=val2 ...".  The following criterias are
5213     allowed:     allowed:
5214    
5215     NAME='<search-string>'     NAME='<search-string>'
5216    
5217        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5218        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5219          escape sequences as described in chapter "Character Set and Escape
5220          Sequences (Section 7.1)").
5221    
5222     CREATED='[<date-after>]..[<date-before>]'     CREATED='[<date-after>]..[<date-before>]'
5223    
# Line 5201  Internet-Draft    LinuxSampler Control P Line 5236  Internet-Draft    LinuxSampler Control P
5236        after> is omitted the search is restricted to directories, which        after> is omitted the search is restricted to directories, which
5237        are last modified before <date-before>.  If <date-before> is        are last modified before <date-before>.  If <date-before> is
5238        omitted, the search is restricted to directories, which are last        omitted, the search is restricted to directories, which are last
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 93]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5239        modified after <date-after>.        modified after <date-after>.
5240    
5241     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5242    
5243        Restricts the search to directories with description that        Restricts the search to directories with description that
5244        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5245          apostrophes, supporting escape sequences as described in chapter
5246          "Character Set and Escape Sequences (Section 7.1)").
5247    
5248     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5249     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
# Line 5227  Internet-Draft    LinuxSampler Control P Line 5256  Internet-Draft    LinuxSampler Control P
5256    
5257        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires April 9, 2008                [Page 94]
5264    
5265    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5266    
5267    
5268           if the given directory does not exist.           if the given directory does not exist.
5269    
5270     Example:     Example:
# Line 5257  Internet-Draft    LinuxSampler Control P Line 5295  Internet-Draft    LinuxSampler Control P
5295     added to the instruments database.  If the optional <instr_index>     added to the instruments database.  If the optional <instr_index>
5296     (the index of the instrument within the given file) is supplied too,     (the index of the instrument within the given file) is supplied too,
5297     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  
   
   
5298     directory is supplied, the instruments in that directory will be     directory is supplied, the instruments in that directory will be
5299     added.  The OPTIONAL <mode> argument is only applied when a directory     added.  The OPTIONAL <mode> argument is only applied when a directory
5300     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 5281  Internet-Draft    LinuxSampler Control P Line 5311  Internet-Draft    LinuxSampler Control P
5311           Only the instruments in the specified directory will be added,           Only the instruments in the specified directory will be added,
5312           the instruments in the subdirectories will not be processed.           the instruments in the subdirectories will not be processed.
5313    
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires April 9, 2008                [Page 95]
5320    
5321    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5322    
5323    
5324        "FLAT" -        "FLAT" -
5325    
5326           All instruments will be processed, including those in the           All instruments will be processed, including those in the
# Line 5312  Internet-Draft    LinuxSampler Control P Line 5352  Internet-Draft    LinuxSampler Control P
5352    
5353     Examples:     Examples:
5354    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 95]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5355        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5356        Bosendorfer 290.gig' 0"        Bosendorfer 290.gig' 0"
5357    
# Line 5338  Internet-Draft    LinuxSampler Control P Line 5369  Internet-Draft    LinuxSampler Control P
5369    
5370     Possible Answers:     Possible Answers:
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires April 9, 2008                [Page 96]
5376    
5377    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5378    
5379    
5380        "OK" -        "OK" -
5381    
5382           if the instrument is removed successfully           if the instrument is removed successfully
# Line 5368  Internet-Draft    LinuxSampler Control P Line 5407  Internet-Draft    LinuxSampler Control P
5407    
5408        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5409    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 96]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5410        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5411    
5412           if the given directory does not exist.           if the given directory does not exist.
# Line 5395  Internet-Draft    LinuxSampler Control P Line 5425  Internet-Draft    LinuxSampler Control P
5425        LIST DB_INSTRUMENTS [RECURSIVE] <dir>        LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5426    
5427     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5428    
5429    
5430    
5431    Schoenebeck               Expires April 9, 2008                [Page 97]
5432    
5433    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5434    
5435    
5436     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
5437     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5438     specified directory, will be returned.     specified directory, will be returned.
# Line 5424  Internet-Draft    LinuxSampler Control P Line 5462  Internet-Draft    LinuxSampler Control P
5462     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
5463     sending the following command:     sending the following command:
5464    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 97]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5465        GET DB_INSTRUMENT INFO <instr_path>        GET DB_INSTRUMENT INFO <instr_path>
5466    
5467     Where <instr_path> should be replaced by the absolute path name of     Where <instr_path> should be replaced by the absolute path name of
# Line 5450  Internet-Draft    LinuxSampler Control P Line 5479  Internet-Draft    LinuxSampler Control P
5479    
5480           INSTRUMENT_FILE -           INSTRUMENT_FILE -
5481    
5482              File name of the instrument.              File name of the instrument.  Note that the character string
5483                may contain escape sequences (Section 7.1).
5484    
5485    
5486    
5487    Schoenebeck               Expires April 9, 2008                [Page 98]
5488    
5489    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5490    
5491    
5492           INSTRUMENT_NR -           INSTRUMENT_NR -
5493    
# Line 5480  Internet-Draft    LinuxSampler Control P Line 5517  Internet-Draft    LinuxSampler Control P
5517              instrument's database settings, represented in "YYYY-MM-DD              instrument's database settings, represented in "YYYY-MM-DD
5518              HH:MM:SS" format              HH:MM:SS" format
5519    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 98]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5520           DESCRIPTION -           DESCRIPTION -
5521    
5522              A brief description of the instrument              A brief description of the instrument.  Note that the
5523                character string may contain escape sequences (Section 7.1).
5524    
5525           IS_DRUM -           IS_DRUM -
5526    
# Line 5500  Internet-Draft    LinuxSampler Control P Line 5529  Internet-Draft    LinuxSampler Control P
5529    
5530           PRODUCT -           PRODUCT -
5531    
5532              The product title of the instrument              The product title of the instrument.  Note that the
5533                character string may contain escape sequences (Section 7.1).
5534    
5535           ARTISTS -           ARTISTS -
5536    
5537              Lists the artist names              Lists the artist names.  Note that the character string may
5538                contain escape sequences (Section 7.1).
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires April 9, 2008                [Page 99]
5544    
5545    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5546    
5547    
5548           KEYWORDS -           KEYWORDS -
5549    
5550              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
5551              Keywords are separated with semicolon and blank.              Keywords are separated with semicolon and blank.  Note that
5552                the character string may contain escape sequences
5553                (Section 7.1).
5554    
5555     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5556    
# Line 5537  Internet-Draft    LinuxSampler Control P Line 5578  Internet-Draft    LinuxSampler Control P
5578    
5579           "PRODUCT: GRANDIOSO Bosendorfer 290"           "PRODUCT: GRANDIOSO Bosendorfer 290"
5580    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 99]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5581           "ARTISTS: Post Musical Instruments"           "ARTISTS: Post Musical Instruments"
5582    
5583           "KEYWORDS: Bosendorfer"           "KEYWORDS: Bosendorfer"
# Line 5561  Internet-Draft    LinuxSampler Control P Line 5594  Internet-Draft    LinuxSampler Control P
5594     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
5595     is the new name for that instrument.     is the new name for that instrument.
5596    
5597    
5598    
5599    Schoenebeck               Expires April 9, 2008               [Page 100]
5600    
5601    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5602    
5603    
5604     Possible Answers:     Possible Answers:
5605    
5606        "OK" -        "OK" -
# Line 5591  Internet-Draft    LinuxSampler Control P Line 5631  Internet-Draft    LinuxSampler Control P
5631    
5632     Possible Answers:     Possible Answers:
5633    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 100]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5634        "OK" -        "OK" -
5635    
5636           on success           on success
# Line 5618  Internet-Draft    LinuxSampler Control P Line 5648  Internet-Draft    LinuxSampler Control P
5648    
5649        S: "OK"        S: "OK"
5650    
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires April 9, 2008               [Page 101]
5656    
5657    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5658    
5659    
5660  6.8.18.  Copying instruments  6.8.18.  Copying instruments
5661    
5662     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 5647  Internet-Draft    LinuxSampler Control P Line 5686  Internet-Draft    LinuxSampler Control P
5686    
5687        S: "OK"        S: "OK"
5688    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 101]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5689  6.8.19.  Changing the description of instrument  6.8.19.  Changing the description of instrument
5690    
5691     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 5694  Internet-Draft    LinuxSampler Control P
5694        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5695    
5696     Where <instr> is the absolute path name of the instrument and <desc>     Where <instr> is the absolute path name of the instrument and <desc>
5697     is the new description for the instrument.     is the new description for the instrument (encapsulated into
5698       apostrophes, supporting escape sequences as described in chapter
5699       "Character Set and Escape Sequences (Section 7.1)").
5700    
5701     Possible Answers:     Possible Answers:
5702    
# Line 5673  Internet-Draft    LinuxSampler Control P Line 5704  Internet-Draft    LinuxSampler Control P
5704    
5705           on success           on success
5706    
5707    
5708    
5709    
5710    
5711    Schoenebeck               Expires April 9, 2008               [Page 102]
5712    
5713    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5714    
5715    
5716        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5717    
5718           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5701  Internet-Draft    LinuxSampler Control P Line 5741  Internet-Draft    LinuxSampler Control P
5741     NAME='<search-string>'     NAME='<search-string>'
5742    
5743        Restricts the search to instruments, which names satisfy the        Restricts the search to instruments, which names satisfy the
5744        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5745          escape sequences as described in chapter "Character Set and Escape
5746          Sequences (Section 7.1)").
5747    
5748     SIZE=[<min>]..[<max>]     SIZE=[<min>]..[<max>]
5749    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 102]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5750        Restricts the search to instruments, which size is in the        Restricts the search to instruments, which size is in the
5751        specified range.  If <min> is omitted, the search results are        specified range.  If <min> is omitted, the search results are
5752        restricted to instruments with size less then or equal to <max>.        restricted to instruments with size less then or equal to <max>.
# Line 5728  Internet-Draft    LinuxSampler Control P Line 5762  Internet-Draft    LinuxSampler Control P
5762        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
5763        instruments created after <date-after>.        instruments created after <date-after>.
5764    
5765    
5766    
5767    Schoenebeck               Expires April 9, 2008               [Page 103]
5768    
5769    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5770    
5771    
5772     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5773    
5774        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 5741  Internet-Draft    LinuxSampler Control P Line 5782  Internet-Draft    LinuxSampler Control P
5782     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5783    
5784        Restricts the search to instruments with description that        Restricts the search to instruments with description that
5785        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5786          apostrophes, supporting escape sequences as described in chapter
5787          "Character Set and Escape Sequences (Section 7.1)").
5788    
5789     PRODUCT='<search-string>'     PRODUCT='<search-string>'
5790    
5791        Restricts the search to instruments with product info that        Restricts the search to instruments with product info that
5792        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5793          apostrophes, supporting escape sequences as described in chapter
5794          "Character Set and Escape Sequences (Section 7.1)").
5795    
5796     ARTISTS='<search-string>'     ARTISTS='<search-string>'
5797    
5798        Restricts the search to instruments with artists info that        Restricts the search to instruments with artists info that
5799        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5800          apostrophes, supporting escape sequences as described in chapter
5801          "Character Set and Escape Sequences (Section 7.1)").
5802    
5803     KEYWORDS='<search-string>'     KEYWORDS='<search-string>'
5804    
5805        Restricts the search to instruments with keyword list that        Restricts the search to instruments with keyword list that
5806        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5807          apostrophes, supporting escape sequences as described in chapter
5808          "Character Set and Escape Sequences (Section 7.1)").
5809    
5810     IS_DRUM=true | false     IS_DRUM=true | false
5811    
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 103]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5812        Either true or false.  Restricts the search to drum kits or        Either true or false.  Restricts the search to drum kits or
5813        chromatic instruments.        chromatic instruments.
5814    
# Line 5778  Internet-Draft    LinuxSampler Control P Line 5818  Internet-Draft    LinuxSampler Control P
5818        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
5819        families.        families.
5820    
5821    
5822    
5823    Schoenebeck               Expires April 9, 2008               [Page 104]
5824    
5825    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5826    
5827    
5828     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5829     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
5830    
# Line 5816  Internet-Draft    LinuxSampler Control P Line 5863  Internet-Draft    LinuxSampler Control P
5863    
5864     Possible Answers:     Possible Answers:
5865    
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 104]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5866        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5867        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5868        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
# Line 5835  Internet-Draft    LinuxSampler Control P Line 5873  Internet-Draft    LinuxSampler Control P
5873    
5874           FILES_TOTAL -           FILES_TOTAL -
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires April 9, 2008               [Page 105]
5880    
5881    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5882    
5883    
5884              The total number of files scheduled for scanning              The total number of files scheduled for scanning
5885    
5886           FILES_SCANNED -           FILES_SCANNED -
# Line 5868  Internet-Draft    LinuxSampler Control P Line 5914  Internet-Draft    LinuxSampler Control P
5914    
5915           "."           "."
5916    
5917    6.8.22.  Formatting the instruments database
5918    
5919       The front-end can remove all instruments and directories and re-
5920       create the instruments database structure (e.g., in case of a
5921       database corruption) by sending the following command:
5922    
5923          FORMAT INSTRUMENTS_DB
5924    
5925       Possible Answers:
5926    
5927          "OK" -
5928    
5929             on success
5930    
5931    
5932    
5933  Schoenebeck             Expires December 24, 2007             [Page 105]  
5934    
5935    Schoenebeck               Expires April 9, 2008               [Page 106]
5936    
5937  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5938    
5939    
5940          "ERR:<error-code>:<error-message>" -
5941    
5942             If the formatting of the instruments database failed.
5943    
5944    6.9.  Editing Instruments
5945    
5946       The sampler allows to edit instruments while playing with the sampler
5947       by spawning an external (3rd party) instrument editor application for
5948       a given instrument.  The 3rd party instrument editor applications
5949       have to place a respective plugin DLL file into the sampler's plugins
5950       directory.  The sampler will automatically try to load all plugin
5951       DLLs in that directory on startup and only on startup!
5952    
5953       At the moment there is only one command for this feature set, but
5954       this will most probably change in future.
5955    
5956    6.9.1.  Opening an appropriate instrument editor application
5957    
5958       The front-end can request to open an appropriate instrument editor
5959       application by sending the following command:
5960    
5961          EDIT INSTRUMENT <sampler-channel>
5962    
5963       Where <sampler-channel> should be replaced by the number of the
5964       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
5965       "LIST CHANNELS" (Section 6.4.4) command.
5966    
5967       The sampler will try to ask all registered instrument editors (or to
5968       be more specific: their sampler plugins) whether they are capable to
5969       handle the instrument on the given sampler channel.  The sampler will
5970       simply use the first instrument editor application which replied with
5971       a positive answer and spawn that instrument editor application within
5972       the sampler's process and provide that application access to the
5973       instrument's data structures, so both applications can share and
5974       access the same instruments data at the same time, thus allowing to
5975       immediately hear changes with the sampler made by the instrument
5976       editor.
5977    
5978       Note: consequently instrument editors are always spawned locally on
5979       the same machine where the sampler is running on!
5980    
5981       Possible Answers:
5982    
5983          "OK" -
5984    
5985             when an appropriate instrument editor was launched
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck               Expires April 9, 2008               [Page 107]
5992    
5993    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
5994    
5995    
5996          "WRN:<warning-code>:<warning-message>" -
5997    
5998             when an appropriate instrument editor was launched, but there
5999             are noteworthy issues
6000    
6001          "ERR:<error-code>:<error-message>" -
6002    
6003             when an appropriate instrument editor could not be launched
6004    
6005       Examples:
6006    
6007          C: "EDIT INSTRUMENT 0"
6008    
6009          S: "OK"
6010    
6011    
6012    
6013    
6014    
6015    
6016    
6017    
6018    
6019    
6020    
6021    
6022    
6023    
6024    
6025    
6026    
6027    
6028    
6029    
6030    
6031    
6032    
6033    
6034    
6035    
6036    
6037    
6038    
6039    
6040    
6041    
6042    
6043    
6044    
6045    
6046    
6047    Schoenebeck               Expires April 9, 2008               [Page 108]
6048    
6049    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6050    
6051    
6052  7.  Command Syntax  7.  Command Syntax
# Line 5932  Internet-Draft    LinuxSampler Control P Line 6100  Internet-Draft    LinuxSampler Control P
6100    
6101    
6102    
6103  Schoenebeck             Expires December 24, 2007             [Page 106]  Schoenebeck               Expires April 9, 2008               [Page 109]
6104    
6105  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6106    
6107    
6108        / LIST SP list_instruction        / LIST SP list_instruction
# Line 5961  Internet-Draft    LinuxSampler Control P Line 6129  Internet-Draft    LinuxSampler Control P
6129    
6130        / EDIT SP edit_instruction        / EDIT SP edit_instruction
6131    
6132          / FORMAT SP format_instruction
6133    
6134        / RESET        / RESET
6135    
6136        / QUIT        / QUIT
# Line 5969  Internet-Draft    LinuxSampler Control P Line 6139  Internet-Draft    LinuxSampler Control P
6139    
6140        CHANNEL        CHANNEL
6141    
6142        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6143    
6144        / 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
6145    
6146        / DB_INSTRUMENTS SP scan_mode SP pathname SP pathname        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6147    
6148        / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6149    
6150        / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6151        instrument_index        instrument_index
6152    
6153        / DB_INSTRUMENTS SP pathname SP pathname        / DB_INSTRUMENTS SP db_path SP filename
   
       / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  
6154    
6155    
6156    
6157    
6158    
6159  Schoenebeck             Expires December 24, 2007             [Page 107]  Schoenebeck               Expires April 9, 2008               [Page 110]
6160    
6161  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6162    
6163    
6164          / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6165    
6166        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
6167    
6168        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
# Line 6039  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 108]  Schoenebeck               Expires April 9, 2008               [Page 111]
6216    
6217  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6218    
6219    
6220          / MISCELLANEOUS
6221    
6222        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6223    
# Line 6095  Internet-Draft    LinuxSampler Control P Line 6265  Internet-Draft    LinuxSampler Control P
6265    
6266        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6267    
       / MISCELLANEOUS  
   
6268    
6269    
6270    
6271  Schoenebeck             Expires December 24, 2007             [Page 109]  Schoenebeck               Expires April 9, 2008               [Page 112]
6272    
6273  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6274    
6275    
6276          / MISCELLANEOUS
6277    
6278        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6279    
6280        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6138  Internet-Draft    LinuxSampler Control P Line 6308  Internet-Draft    LinuxSampler Control P
6308    
6309        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6310    
6311        / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6312    
6313        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6314    
6315        / DB_INSTRUMENT SP pathname        / DB_INSTRUMENT SP db_path
6316    
6317     get_instruction =     get_instruction =
6318    
# Line 6150  Internet-Draft    LinuxSampler Control P Line 6320  Internet-Draft    LinuxSampler Control P
6320    
6321        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
6322    
       / MIDI_INPUT_DRIVER SP INFO SP string  
   
6323    
6324    
6325    
6326    
6327  Schoenebeck             Expires December 24, 2007             [Page 110]  Schoenebeck               Expires April 9, 2008               [Page 113]
6328    
6329  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6330    
6331    
6332          / MIDI_INPUT_DRIVER SP INFO SP string
6333    
6334        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6335    
6336        / 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 6376  Internet-Draft    LinuxSampler Control P
6376    
6377        / SERVER SP INFO        / SERVER SP INFO
6378    
       / TOTAL_VOICE_COUNT  
   
6379    
6380    
6381    
6382    
6383  Schoenebeck             Expires December 24, 2007             [Page 111]  Schoenebeck               Expires April 9, 2008               [Page 114]
6384    
6385  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6386    
6387    
6388          / TOTAL_VOICE_COUNT
6389    
6390        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
6391    
6392        / MIDI_INSTRUMENTS SP midi_map        / MIDI_INSTRUMENTS SP midi_map
# Line 6233  Internet-Draft    LinuxSampler Control P Line 6403  Internet-Draft    LinuxSampler Control P
6403    
6404        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6405    
6406        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6407    
6408        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP db_path
6409    
6410        / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname        / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6411    
6412        / DB_INSTRUMENTS SP RECURSIVE SP pathname        / DB_INSTRUMENTS SP RECURSIVE SP db_path
6413    
6414        / DB_INSTRUMENTS SP pathname        / DB_INSTRUMENTS SP db_path
6415    
6416        / DB_INSTRUMENT SP INFO SP pathname        / DB_INSTRUMENT SP INFO SP db_path
6417    
6418        / DB_INSTRUMENTS_JOB SP INFO SP number        / DB_INSTRUMENTS_JOB SP INFO SP number
6419    
# Line 6260  Internet-Draft    LinuxSampler Control P Line 6430  Internet-Draft    LinuxSampler Control P
6430        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6431        param_val_list        param_val_list
6432    
6433        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
       param_val_list  
6434    
       / CHANNEL SP set_chan_instruction  
6435    
6436    
6437    
6438    
6439  Schoenebeck             Expires December 24, 2007             [Page 112]  Schoenebeck               Expires April 9, 2008               [Page 115]
6440    
6441  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6442    
6443    
6444          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6445          param_val_list
6446    
6447          / CHANNEL SP set_chan_instruction
6448    
6449        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6450    
# Line 6286  Internet-Draft    LinuxSampler Control P Line 6459  Internet-Draft    LinuxSampler Control P
6459        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6460        volume_value        volume_value
6461    
6462        / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6463    
6464        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6465          stringval_escaped
6466    
6467        / DB_INSTRUMENT SP NAME SP pathname SP dirname        / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6468    
6469        / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6470    
6471        / ECHO SP boolean        / ECHO SP boolean
6472    
# Line 6314  Internet-Draft    LinuxSampler Control P Line 6488  Internet-Draft    LinuxSampler Control P
6488    
6489     reset_instruction =     reset_instruction =
6490    
       CHANNEL SP sampler_channel  
6491    
    clear_instruction =  
6492    
       MIDI_INSTRUMENTS SP midi_map  
6493    
6494    
6495    Schoenebeck               Expires April 9, 2008               [Page 116]
6496    
6497    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6498    
6499    
6500          CHANNEL SP sampler_channel
6501    
6502  Schoenebeck             Expires December 24, 2007             [Page 113]     clear_instruction =
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
6503    
6504          MIDI_INSTRUMENTS SP midi_map
6505    
6506        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
6507    
6508     find_instruction =     find_instruction =
6509    
6510        DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list        DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6511    
6512        / DB_INSTRUMENTS SP pathname SP query_val_list        / DB_INSTRUMENTS SP db_path SP query_val_list
6513    
6514        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
6515        query_val_list        query_val_list
6516    
6517        / DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6518    
6519     move_instruction =     move_instruction =
6520    
6521        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6522    
6523        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6524    
6525     copy_instruction =     copy_instruction =
6526    
6527        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6528    
6529        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6530    
6531     destroy_instruction =     destroy_instruction =
6532    
# Line 6370  Internet-Draft    LinuxSampler Control P Line 6544  Internet-Draft    LinuxSampler Control P
6544    
6545     set_chan_instruction =     set_chan_instruction =
6546    
       AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index  
6547    
       / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index  
       SP audio_channel_index  
6548    
       / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name  
6549    
6550    
6551    Schoenebeck               Expires April 9, 2008               [Page 117]
6552    
6553    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6554    
6555    
6556  Schoenebeck             Expires December 24, 2007             [Page 114]        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
6557    
6558          / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
6559          SP audio_channel_index
6560    
6561          / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6562    
6563        / MIDI_INPUT SP sampler_channel SP device_index SP        / MIDI_INPUT SP sampler_channel SP device_index SP
6564        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 6588  Internet-Draft    LinuxSampler Control P
6588    
6589        INSTRUMENT SP sampler_channel        INSTRUMENT SP sampler_channel
6590    
6591       format_instruction =
6592    
6593          INSTRUMENTS_DB
6594    
6595     modal_arg =     modal_arg =
6596    
6597        /* epsilon (empty argument) */        /* epsilon (empty argument) */
# Line 6421  Internet-Draft    LinuxSampler Control P Line 6600  Internet-Draft    LinuxSampler Control P
6600    
6601     key_val_list =     key_val_list =
6602    
6603    
6604    
6605    
6606    
6607    Schoenebeck               Expires April 9, 2008               [Page 118]
6608    
6609    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6610    
6611    
6612        string '=' param_val_list        string '=' param_val_list
6613    
6614        / key_val_list SP string '=' param_val_list        / key_val_list SP string '=' param_val_list
# Line 6433  Internet-Draft    LinuxSampler Control P Line 6621  Internet-Draft    LinuxSampler Control P
6621    
6622     list_instruction =     list_instruction =
6623    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 115]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6624        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
6625    
6626        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 6461  Internet-Draft    LinuxSampler Control P Line 6641  Internet-Draft    LinuxSampler Control P
6641    
6642        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6643    
6644        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6645    
6646        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP db_path
6647    
6648        / DB_INSTRUMENTS SP RECURSIVE SP pathname        / DB_INSTRUMENTS SP RECURSIVE SP db_path
6649    
6650        / DB_INSTRUMENTS SP pathname        / DB_INSTRUMENTS SP db_path
6651    
6652     load_instr_args =     load_instr_args =
6653    
# Line 6477  Internet-Draft    LinuxSampler Control P Line 6657  Internet-Draft    LinuxSampler Control P
6657    
6658     load_engine_args =     load_engine_args =
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires April 9, 2008               [Page 119]
6664    
6665    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6666    
6667    
6668        engine_name SP sampler_channel        engine_name SP sampler_channel
6669    
6670     instr_load_mode =     instr_load_mode =
# Line 6489  Internet-Draft    LinuxSampler Control P Line 6677  Internet-Draft    LinuxSampler Control P
6677    
6678     device_index =     device_index =
6679    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 116]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6680        number        number
6681    
6682     audio_channel_index =     audio_channel_index =
# Line 6533  Internet-Draft    LinuxSampler Control P Line 6713  Internet-Draft    LinuxSampler Control P
6713    
6714        number        number
6715    
6716    
6717    
6718    
6719    Schoenebeck               Expires April 9, 2008               [Page 120]
6720    
6721    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6722    
6723    
6724     midi_ctrl =     midi_ctrl =
6725    
6726        number        number
# Line 6545  Internet-Draft    LinuxSampler Control P Line 6733  Internet-Draft    LinuxSampler Control P
6733    
6734     sampler_channel =     sampler_channel =
6735    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 117]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6736        number        number
6737    
6738     instrument_index =     instrument_index =
# Line 6567  Internet-Draft    LinuxSampler Control P Line 6747  Internet-Draft    LinuxSampler Control P
6747    
6748        string        string
6749    
6750     pathname =     filename =
   
       stringval  
   
    dirname =  
6751    
6752        stringval        path
6753    
6754     filename =     db_path =
6755    
6756        stringval_escaped        path
6757    
6758     map_name =     map_name =
6759    
6760        stringval        stringval_escaped
6761    
6762     entry_name =     entry_name =
6763    
6764        stringval        stringval_escaped
6765    
6766     fx_send_name =     fx_send_name =
6767    
6768        stringval        stringval_escaped
6769    
6770     param_val_list =     param_val_list =
6771    
       param_val  
6772    
       / param_val_list','param_val  
6773    
    param_val =  
6774    
6775        string  Schoenebeck               Expires April 9, 2008               [Page 121]
6776    
6777    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6778    
6779    
6780          param_val
6781    
6782          / param_val_list','param_val
6783    
6784  Schoenebeck             Expires December 24, 2007             [Page 118]     param_val =
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
6785    
6786          string
6787    
6788        / stringval        / stringval
6789    
# Line 6623  Internet-Draft    LinuxSampler Control P Line 6799  Internet-Draft    LinuxSampler Control P
6799    
6800     query_val =     query_val =
6801    
6802        string        text_escaped
6803    
6804        / stringval        / stringval_escaped
6805    
6806     scan_mode =     scan_mode =
6807    
# Line 6652  Internet-Draft    LinuxSampler Control P Line 6828  Internet-Draft    LinuxSampler Control P
6828    
6829    
6830    
6831    Schoenebeck               Expires April 9, 2008               [Page 122]
   
   
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 119]  
6832    
6833  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6834    
6835    
6836     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 6700  Internet-Draft    LinuxSampler Control P Line 6868  Internet-Draft    LinuxSampler Control P
6868     (that is as double backslash), whereas in the old versions a single     (that is as double backslash), whereas in the old versions a single
6869     backslash was sufficient.     backslash was sufficient.
6870    
6871       The following LSCP commands support escape sequences as part of their
6872       filename / path based arguments:
6873    
6874          "LOAD INSTRUMENT" (Section 6.4.1)
6875    
6876          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
6877    
6878          "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
6879    
6880          "ADD DB_INSTRUMENTS" (Section 6.8.11)
6881    
6882          "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires April 9, 2008               [Page 123]
6888    
6889    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6890    
6891    
6892          "REMOVE DB_INSTRUMENT" (Section 6.8.12)
6893    
6894          "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
6895    
6896          "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
6897    
6898          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
6899    
6900          "GET DB_INSTRUMENTS" (Section 6.8.13)
6901    
6902          "LIST DB_INSTRUMENTS" (Section 6.8.14)
6903    
6904          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
6905    
6906          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
6907    
6908          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
6909    
6910          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
6911    
6912          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
6913    
6914          "FIND DB_INSTRUMENTS" (Section 6.8.20)
6915    
6916          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
6917    
6918          "MOVE DB_INSTRUMENT" (Section 6.8.17)
6919    
6920          "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
6921    
6922          "COPY DB_INSTRUMENT" (Section 6.8.18)
6923    
6924          "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
6925    
6926       Note that the forward slash character ('/') has a special meaning in
6927       filename / path based arguments: it acts as separator of the nodes in
6928       the path, thus if a directory- or filename includes a forward slash
6929       (not intended as path node separator), you MUST escape that slash
6930       either with the respective hex escape sequence ("\x2f") or with the
6931       respective octal escape sequence ("\057").
6932    
6933  Schoenebeck             Expires December 24, 2007             [Page 120]     The following LSCP commands even support escape sequences as part of
6934       at least one of their text-based arguments (i.e. entity name,
6935       description):
6936    
6937          "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck               Expires April 9, 2008               [Page 124]
6944    
6945  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
6946    
6947    
6948          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
6949    
6950          "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
6951    
6952          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
6953    
6954          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
6955    
6956          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
6957    
6958          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
6959    
6960          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
6961    
6962       Please note that these lists are manually maintained.  If you find a
6963       command that also supports escape sequences we forgot to mention
6964       here, please report it!
6965    
6966    
6967    
6968    
6969    
6970    
6971    
6972    
6973    
6974    
6975    
6976    
6977    
6978    
6979    
6980    
6981    
6982    
6983    
6984    
6985    
6986    
6987    
6988    
6989    
6990    
6991    
6992    
6993    
6994    
6995    
6996    
6997    
6998    
6999    Schoenebeck               Expires April 9, 2008               [Page 125]
7000    
7001    Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7002    
7003    
7004  8.  Events  8.  Events
# Line 6772  Internet-Draft    LinuxSampler Control P Line 7052  Internet-Draft    LinuxSampler Control P
7052    
7053    
7054    
7055  Schoenebeck             Expires December 24, 2007             [Page 121]  Schoenebeck               Expires April 9, 2008               [Page 126]
7056    
7057  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7058    
7059    
7060        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 6828  Internet-Draft    LinuxSampler Control P Line 7108  Internet-Draft    LinuxSampler Control P
7108    
7109    
7110    
7111  Schoenebeck             Expires December 24, 2007             [Page 122]  Schoenebeck               Expires April 9, 2008               [Page 127]
7112    
7113  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7114    
7115    
7116        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
# Line 6884  Internet-Draft    LinuxSampler Control P Line 7164  Internet-Draft    LinuxSampler Control P
7164    
7165    
7166    
7167  Schoenebeck             Expires December 24, 2007             [Page 123]  Schoenebeck               Expires April 9, 2008               [Page 128]
7168    
7169  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7170    
7171    
7172        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 6940  Internet-Draft    LinuxSampler Control P Line 7220  Internet-Draft    LinuxSampler Control P
7220    
7221    
7222    
7223  Schoenebeck             Expires December 24, 2007             [Page 124]  Schoenebeck               Expires April 9, 2008               [Page 129]
7224    
7225  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7226    
7227    
7228        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
# Line 6996  Internet-Draft    LinuxSampler Control P Line 7276  Internet-Draft    LinuxSampler Control P
7276    
7277    
7278    
7279  Schoenebeck             Expires December 24, 2007             [Page 125]  Schoenebeck               Expires April 9, 2008               [Page 130]
7280    
7281  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7282    
7283    
7284        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
# Line 7052  Internet-Draft    LinuxSampler Control P Line 7332  Internet-Draft    LinuxSampler Control P
7332    
7333    
7334    
7335  Schoenebeck             Expires December 24, 2007             [Page 126]  Schoenebeck               Expires April 9, 2008               [Page 131]
7336    
7337  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7338    
7339    
7340  8.18.  Number of database instrument directories changed  8.18.  Number of database instrument directories changed
# Line 7108  Internet-Draft    LinuxSampler Control P Line 7388  Internet-Draft    LinuxSampler Control P
7388    
7389    
7390    
7391  Schoenebeck             Expires December 24, 2007             [Page 127]  Schoenebeck               Expires April 9, 2008               [Page 132]
7392    
7393  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7394    
7395    
7396  8.20.  Number of database instruments changed  8.20.  Number of database instruments changed
# Line 7164  Internet-Draft    LinuxSampler Control P Line 7444  Internet-Draft    LinuxSampler Control P
7444    
7445    
7446    
7447  Schoenebeck             Expires December 24, 2007             [Page 128]  Schoenebeck               Expires April 9, 2008               [Page 133]
7448    
7449  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7450    
7451    
7452  8.22.  Database job status information changed  8.22.  Database job status information changed
# Line 7220  Internet-Draft    LinuxSampler Control P Line 7500  Internet-Draft    LinuxSampler Control P
7500    
7501    
7502    
7503  Schoenebeck             Expires December 24, 2007             [Page 129]  Schoenebeck               Expires April 9, 2008               [Page 134]
7504    
7505  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7506    
7507    
7508  9.  Security Considerations  9.  Security Considerations
# Line 7276  Internet-Draft    LinuxSampler Control P Line 7556  Internet-Draft    LinuxSampler Control P
7556    
7557    
7558    
7559  Schoenebeck             Expires December 24, 2007             [Page 130]  Schoenebeck               Expires April 9, 2008               [Page 135]
7560    
7561  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7562    
7563    
7564  10.  Acknowledgments  10.  Acknowledgments
# Line 7332  Internet-Draft    LinuxSampler Control P Line 7612  Internet-Draft    LinuxSampler Control P
7612    
7613    
7614    
7615  Schoenebeck             Expires December 24, 2007             [Page 131]  Schoenebeck               Expires April 9, 2008               [Page 136]
7616    
7617  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7618    
7619    
7620  11.  References  11.  References
# Line 7388  Internet-Draft    LinuxSampler Control P Line 7668  Internet-Draft    LinuxSampler Control P
7668    
7669    
7670    
7671  Schoenebeck             Expires December 24, 2007             [Page 132]  Schoenebeck               Expires April 9, 2008               [Page 137]
7672    
7673  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7674    
7675    
7676  Author's Address  Author's Address
# Line 7444  Author's Address Line 7724  Author's Address
7724    
7725    
7726    
7727  Schoenebeck             Expires December 24, 2007             [Page 133]  Schoenebeck               Expires April 9, 2008               [Page 138]
7728    
7729  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft    LinuxSampler Control Protocol (draft)     October 2007
7730    
7731    
7732  Full Copyright Statement  Full Copyright Statement
# Line 7500  Acknowledgment Line 7780  Acknowledgment
7780    
7781    
7782    
7783  Schoenebeck             Expires December 24, 2007             [Page 134]  Schoenebeck               Expires April 9, 2008               [Page 139]
7784    
7785    
Legend:
Removed from v.1251  
changed lines
  Added in v.1390
  ViewVC Help
Powered by ViewVC