/[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 1201 by iliev, Thu May 24 14:22:39 2007 UTC revision 1363 by schoenebeck, Sun Sep 30 21:51:14 2007 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: November 25, 2007                                  May 24, 2007  Expires: March 4, 2008                                    September 2007
8    
9    
10                       LinuxSampler Control Protocol                   LinuxSampler Control Protocol (draft)
11                                  LSCP 1.2                                LSCP 1.2cvs
12    
13  Status of this Memo  Status of this Memo
14    
# 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 November 25, 2007.     This Internet-Draft will expire on March 4, 2008.
37    
38  Copyright Notice  Copyright Notice
39    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck             Expires November 25, 2007               [Page 1]  Schoenebeck               Expires March 4, 2008                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck             Expires November 25, 2007               [Page 2]  Schoenebeck               Expires March 4, 2008                 [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.  Getting all created MIDI input device list  . . . . .  37
# Line 125  Internet-Draft        LinuxSampler Contr Line 125  Internet-Draft        LinuxSampler Contr
125         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
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  . . . . . . . . . . . .  45         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 . . . . . . . . . . . .  47         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 . . . . . . . . . . . . . .  54         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 154  Internet-Draft        LinuxSampler Contr Line 154  Internet-Draft        LinuxSampler Contr
154         6.4.30. Changing effect send's name . . . . . . . . . . . . .  66         6.4.30. Changing effect send's name . . . . . . . . . . . . .  66
155         6.4.31. Altering effect send's audio routing  . . . . . . . .  67         6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157         6.4.33. Altering effect send's send level . . . . . . . . . .  68         6.4.33. Altering effect send's send level . . . . . . . . . .  69
158         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  69         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70
159       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70
160         6.5.1.  Register front-end for receiving event messages . . .  70         6.5.1.  Register front-end for receiving event messages . . .  70
161         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
162                 messages  . . . . . . . . . . . . . . . . . . . . . .  71                 messages  . . . . . . . . . . . . . . . . . . . . . .  71
163         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  71         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  72
164    
165    
166    
167  Schoenebeck             Expires November 25, 2007               [Page 3]  Schoenebeck               Expires March 4, 2008                 [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
170    
171    
172         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
173       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  73
174         6.6.1.  Current number of active voices . . . . . . . . . . .  72         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 . . . . . . . . . .  74         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 . .  76         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 . . . . .  77
184         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  77         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 . . . .  79         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  . . .  82
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  . . . .  83         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 . .  84
193         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  86       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87
195         6.8.1.  Creating a new instrument directory . . . . . . . . .  86         6.8.1.  Creating a new instrument directory . . . . . . . . .  87
196         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88
197         6.8.3.  Getting amount of instrument directories  . . . . . .  88         6.8.3.  Getting amount of instrument directories  . . . . . .  88
198         6.8.4.  Listing all directories in specific directory . . . .  88         6.8.4.  Listing all directories in specific directory . . . .  89
199         6.8.5.  Getting instrument directory information  . . . . . .  89         6.8.5.  Getting instrument directory information  . . . . . .  89
200         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90
201         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  90         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91
202         6.8.8.  Copying instrument directories  . . . . . . . . . . .  91         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 . . . . . . . .  92
204         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  92         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  . . .  94
206         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  95         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96
207         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96
208         6.8.14. Listing all instruments in specific directory . . . .  96         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  . . . . . . . . . . . . . . .  99         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 . . . . . . . . . . . . . . . . . 100         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 101
213         6.8.19. Changing the description of instrument  . . . . . . . 101         6.8.19. Changing the description of instrument  . . . . . . . 102
214         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 101         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102
215         6.8.21. Getting job status information  . . . . . . . . . . . 104         6.8.21. Getting job status information  . . . . . . . . . . . 105
216     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 106         6.8.22. Formatting the instruments database . . . . . . . . . 106
217     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 120       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 106
218       8.1.  Number of audio output devices changed  . . . . . . . . . 120         6.9.1.  Opening an appropriate instrument editor
219       8.2.  Audio output device's settings changed  . . . . . . . . . 120                 application . . . . . . . . . . . . . . . . . . . . . 106
220    
221    
222    
223  Schoenebeck             Expires November 25, 2007               [Page 4]  Schoenebeck               Expires March 4, 2008                 [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
226    
227    
228       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 120     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 108
229       8.4.  MIDI input device's settings changed  . . . . . . . . . . 121       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 121
230       8.5.  Number of sampler channels changed  . . . . . . . . . . . 121     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
231       8.6.  Number of active voices changed . . . . . . . . . . . . . 121       8.1.  Number of audio output devices changed  . . . . . . . . . 123
232       8.7.  Number of active disk streams changed . . . . . . . . . . 122       8.2.  Audio output device's settings changed  . . . . . . . . . 123
233       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 122       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 123
234       8.9.  Channel information changed . . . . . . . . . . . . . . . 122       8.4.  MIDI input device's settings changed  . . . . . . . . . . 124
235       8.10. Number of effect sends changed  . . . . . . . . . . . . . 123       8.5.  Number of sampler channels changed  . . . . . . . . . . . 124
236       8.11. Effect send information changed . . . . . . . . . . . . . 123       8.6.  Number of active voices changed . . . . . . . . . . . . . 124
237       8.12. Total number of active voices changed . . . . . . . . . . 123       8.7.  Number of active disk streams changed . . . . . . . . . . 125
238       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 124       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 125
239       8.14. MIDI instrument map information changed . . . . . . . . . 124       8.9.  Channel information changed . . . . . . . . . . . . . . . 125
240       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 124       8.10. Number of effect sends changed  . . . . . . . . . . . . . 126
241       8.16. MIDI instrument information changed . . . . . . . . . . . 125       8.11. Effect send information changed . . . . . . . . . . . . . 126
242       8.17. Global settings changed . . . . . . . . . . . . . . . . . 125       8.12. Total number of active voices changed . . . . . . . . . . 126
243       8.18. Number of database instrument directories changed . . . . 126       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 127
244       8.19. Database instrument directory information changed . . . . 126       8.14. MIDI instrument map information changed . . . . . . . . . 127
245       8.20. Number of database instruments changed  . . . . . . . . . 127       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 127
246       8.21. Database instrument information changed . . . . . . . . . 127       8.16. MIDI instrument information changed . . . . . . . . . . . 128
247       8.22. Database job status information changed . . . . . . . . . 128       8.17. Global settings changed . . . . . . . . . . . . . . . . . 128
248       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 128       8.18. Number of database instrument directories changed . . . . 129
249     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 129       8.19. Database instrument directory information changed . . . . 129
250     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 130       8.20. Number of database instruments changed  . . . . . . . . . 130
251     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 131       8.21. Database instrument information changed . . . . . . . . . 130
252     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 132       8.22. Database job status information changed . . . . . . . . . 131
253     Intellectual Property and Copyright Statements  . . . . . . . . . 133       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 131
254       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 132
255       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 133
256       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 134
257       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 135
258       Intellectual Property and Copyright Statements  . . . . . . . . . 136
259    
260    
261    
# Line 271  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279    Schoenebeck               Expires March 4, 2008                 [Page 5]
   
   
   
   
 Schoenebeck             Expires November 25, 2007               [Page 5]  
280    
281  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 294  Internet-Draft        LinuxSampler Contr Line 294  Internet-Draft        LinuxSampler Contr
294     end) and server (LinuxSampler) respectively.  Lines in examples must     end) and server (LinuxSampler) respectively.  Lines in examples must
295     be interpreted as every line being CRLF terminated (carriage return     be interpreted as every line being CRLF terminated (carriage return
296     character followed by line feed character as defined in the ASCII     character followed by line feed character as defined in the ASCII
297     standard), thus the following example:     standard [RFC20]), thus the following example:
298    
299        C: "some line"        C: "some line"
300    
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck             Expires November 25, 2007               [Page 6]  Schoenebeck               Expires March 4, 2008                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck             Expires November 25, 2007               [Page 7]  Schoenebeck               Expires March 4, 2008                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck             Expires November 25, 2007               [Page 8]  Schoenebeck               Expires March 4, 2008                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck             Expires November 25, 2007               [Page 9]  Schoenebeck               Expires March 4, 2008                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck             Expires November 25, 2007              [Page 10]  Schoenebeck               Expires March 4, 2008                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck             Expires November 25, 2007              [Page 11]  Schoenebeck               Expires March 4, 2008                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck             Expires November 25, 2007              [Page 12]  Schoenebeck               Expires March 4, 2008                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck             Expires November 25, 2007              [Page 13]  Schoenebeck               Expires March 4, 2008                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck             Expires November 25, 2007              [Page 14]  Schoenebeck               Expires March 4, 2008                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck             Expires November 25, 2007              [Page 15]  Schoenebeck               Expires March 4, 2008                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck             Expires November 25, 2007              [Page 16]  Schoenebeck               Expires March 4, 2008                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck             Expires November 25, 2007              [Page 17]  Schoenebeck               Expires March 4, 2008                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck             Expires November 25, 2007              [Page 18]  Schoenebeck               Expires March 4, 2008                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck             Expires November 25, 2007              [Page 19]  Schoenebeck               Expires March 4, 2008                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck             Expires November 25, 2007              [Page 20]  Schoenebeck               Expires March 4, 2008                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck             Expires November 25, 2007              [Page 21]  Schoenebeck               Expires March 4, 2008                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck             Expires November 25, 2007              [Page 22]  Schoenebeck               Expires March 4, 2008                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck             Expires November 25, 2007              [Page 23]  Schoenebeck               Expires March 4, 2008                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck             Expires November 25, 2007              [Page 24]  Schoenebeck               Expires March 4, 2008                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck             Expires November 25, 2007              [Page 25]  Schoenebeck               Expires March 4, 2008                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck             Expires November 25, 2007              [Page 26]  Schoenebeck               Expires March 4, 2008                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck             Expires November 25, 2007              [Page 27]  Schoenebeck               Expires March 4, 2008                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck             Expires November 25, 2007              [Page 28]  Schoenebeck               Expires March 4, 2008                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck             Expires November 25, 2007              [Page 29]  Schoenebeck               Expires March 4, 2008                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck             Expires November 25, 2007              [Page 30]  Schoenebeck               Expires March 4, 2008                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck             Expires November 25, 2007              [Page 31]  Schoenebeck               Expires March 4, 2008                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck             Expires November 25, 2007              [Page 32]  Schoenebeck               Expires March 4, 2008                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck             Expires November 25, 2007              [Page 33]  Schoenebeck               Expires March 4, 2008                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck             Expires November 25, 2007              [Page 34]  Schoenebeck               Expires March 4, 2008                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck             Expires November 25, 2007              [Page 35]  Schoenebeck               Expires March 4, 2008                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck             Expires November 25, 2007              [Page 36]  Schoenebeck               Expires March 4, 2008                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck             Expires November 25, 2007              [Page 37]  Schoenebeck               Expires March 4, 2008                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck             Expires November 25, 2007              [Page 38]  Schoenebeck               Expires March 4, 2008                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck             Expires November 25, 2007              [Page 39]  Schoenebeck               Expires March 4, 2008                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck             Expires November 25, 2007              [Page 40]  Schoenebeck               Expires March 4, 2008                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck             Expires November 25, 2007              [Page 41]  Schoenebeck               Expires March 4, 2008                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2328  Internet-Draft        LinuxSampler Contr Line 2328  Internet-Draft        LinuxSampler Contr
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 Contr Line 2344  Internet-Draft        LinuxSampler Contr
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 November 25, 2007              [Page 42]  Schoenebeck               Expires March 4, 2008                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2354    
2355    
2356          "ERR:<error-code>:<error-message>" -
2357    
2358           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2359           error message           error message
2360    
2361     Example:     Example:
2362    
2363          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2364    
2365          S: "OK"
2366    
2367          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2368    
2369          S: "OK"
2370    
2371  6.4.  Configuring sampler channels  6.4.  Configuring sampler channels
2372    
# Line 2380  Internet-Draft        LinuxSampler Contr Line 2388  Internet-Draft        LinuxSampler Contr
2388     of the sampler channel the instrument should be assigned to.  Each     of the sampler channel the instrument should be assigned to.  Each
2389     sampler channel can only have one instrument.     sampler channel can only have one instrument.
2390    
2391       Notice: since LSCP 1.2 the <filename> argument supports escape
2392       characters for special characters (see chapter "Character Set and
2393       Escape Sequences (Section 7.1)" for details) and accordingly
2394       backslash characters in the filename MUST now be escaped as well!
2395    
2396     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
2397     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2398     been fully loaded and the channel is ready to be used while NON_MODAL     been fully loaded and the channel is ready to be used while NON_MODAL
# Line 2388  Internet-Draft        LinuxSampler Contr Line 2401  Internet-Draft        LinuxSampler Contr
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
2404    
2405    
2406    
2407    Schoenebeck               Expires March 4, 2008                [Page 43]
2408    
2409    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2410    
2411    
2412     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
2413     process should any errors be detected at that point.     process should any errors be detected at that point.
2414    
# Line 2401  Internet-Draft        LinuxSampler Contr Line 2422  Internet-Draft        LinuxSampler Contr
2422    
2423           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2424           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 43]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2425           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
2426           file), providing an appropriate warning code and warning           file), providing an appropriate warning code and warning
2427           message           message
# Line 2443  Internet-Draft        LinuxSampler Contr Line 2456  Internet-Draft        LinuxSampler Contr
2456    
2457     Possible Answers:     Possible Answers:
2458    
2459    
2460    
2461    
2462    
2463    Schoenebeck               Expires March 4, 2008                [Page 44]
2464    
2465    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2466    
2467    
2468        "OK" -        "OK" -
2469    
2470           in case the engine was successfully deployed           in case the engine was successfully deployed
# Line 2458  Internet-Draft        LinuxSampler Contr Line 2480  Internet-Draft        LinuxSampler Contr
2480           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2481           error message           error message
2482    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 44]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2483     Example:     Example:
2484    
2485    
# Line 2498  Internet-Draft        LinuxSampler Contr Line 2513  Internet-Draft        LinuxSampler Contr
2513    
2514     Possible Answers:     Possible Answers:
2515    
2516    
2517    
2518    
2519    Schoenebeck               Expires March 4, 2008                [Page 45]
2520    
2521    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2522    
2523    
2524        LinuxSampler will answer by returning a comma separated list with        LinuxSampler will answer by returning a comma separated list with
2525        all sampler channels numerical IDs.        all sampler channels numerical IDs.
2526    
# Line 2512  Internet-Draft        LinuxSampler Contr Line 2535  Internet-Draft        LinuxSampler Contr
2535     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2536     list by sending the following command:     list by sending the following command:
2537    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2538        ADD CHANNEL        ADD CHANNEL
2539    
2540     This will increment the sampler channel count by one and the new     This will increment the sampler channel count by one and the new
# Line 2557  Internet-Draft        LinuxSampler Contr Line 2571  Internet-Draft        LinuxSampler Contr
2571    
2572    
2573    
2574    
2575    Schoenebeck               Expires March 4, 2008                [Page 46]
2576    
2577    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2578    
2579    
2580    
2581    
2582  6.4.6.  Removing a sampler channel  6.4.6.  Removing a sampler channel
2583    
2584     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
# Line 2570  Internet-Draft        LinuxSampler Contr Line 2592  Internet-Draft        LinuxSampler Contr
2592    
2593     Possible Answers:     Possible Answers:
2594    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2595        "OK" -        "OK" -
2596    
2597           in case the given sampler channel could be removed           in case the given sampler channel could be removed
# Line 2610  Internet-Draft        LinuxSampler Contr Line 2625  Internet-Draft        LinuxSampler Contr
2625    
2626     Example:     Example:
2627    
2628    
2629    
2630    
2631    Schoenebeck               Expires March 4, 2008                [Page 47]
2632    
2633    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2634    
2635    
2636        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2637    
2638        S: "4"        S: "4"
# Line 2623  Internet-Draft        LinuxSampler Contr Line 2646  Internet-Draft        LinuxSampler Contr
2646    
2647     Possible Answers:     Possible Answers:
2648    
   
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2649        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
2650        engines' names encapsulated into apostrophes (').  Engine names        engines' names encapsulated into apostrophes (').  Engine names
2651        can consist of lower and upper cases, digits and underlines ("_"        can consist of lower and upper cases, digits and underlines ("_"
# Line 2668  Internet-Draft        LinuxSampler Contr Line 2681  Internet-Draft        LinuxSampler Contr
2681    
2682              arbitrary description text about the engine              arbitrary description text about the engine
2683    
2684    
2685    
2686    
2687    Schoenebeck               Expires March 4, 2008                [Page 48]
2688    
2689    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2690    
2691    
2692           VERSION -           VERSION -
2693    
2694              arbitrary character string regarding the engine's version              arbitrary character string regarding the engine's version
# Line 2680  Internet-Draft        LinuxSampler Contr Line 2701  Internet-Draft        LinuxSampler Contr
2701    
2702        S: "DESCRIPTION: this is Joe's custom sampler engine"        S: "DESCRIPTION: this is Joe's custom sampler engine"
2703    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2704           "VERSION: testing-1.0"           "VERSION: testing-1.0"
2705    
2706           "."           "."
# Line 2725  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
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
2740    
2741    
2742    
2743    Schoenebeck               Expires March 4, 2008                [Page 49]
2744    
2745    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2746    
2747    
2748              sampler channel              sampler channel
2749    
2750           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
# Line 2737  Internet-Draft        LinuxSampler Contr Line 2757  Internet-Draft        LinuxSampler Contr
2757              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
2758              of the selected audio output device each sampler output              of the selected audio output device each sampler output
2759              channel is routed to, e.g. "0,3" would mean the engine's              channel is routed to, e.g. "0,3" would mean the engine's
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 49]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2760              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
2761              device and the engine's output channel 1 is routed to the              device and the engine's output channel 1 is routed to the
2762              channel 3 of the audio output device              channel 3 of the audio output device
# Line 2780  Internet-Draft        LinuxSampler Contr Line 2792  Internet-Draft        LinuxSampler Contr
2792    
2793              port number of the MIDI input device              port number of the MIDI input device
2794    
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires March 4, 2008                [Page 50]
2800    
2801    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2802    
2803    
2804           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2805    
2806              the MIDI input channel number this sampler channel should              the MIDI input channel number this sampler channel should
# Line 2791  Internet-Draft        LinuxSampler Contr Line 2812  Internet-Draft        LinuxSampler Contr
2812              (where a value < 1.0 means attenuation and a value > 1.0              (where a value < 1.0 means attenuation and a value > 1.0
2813              means amplification)              means amplification)
2814    
   
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2815           MUTE -           MUTE -
2816    
2817              Determines whether the channel is muted, "true" if the              Determines whether the channel is muted, "true" if the
# Line 2837  Internet-Draft        LinuxSampler Contr Line 2848  Internet-Draft        LinuxSampler Contr
2848    
2849           "AUDIO_OUTPUT_ROUTING: 0,1"           "AUDIO_OUTPUT_ROUTING: 0,1"
2850    
2851    
2852    
2853    
2854    
2855    Schoenebeck               Expires March 4, 2008                [Page 51]
2856    
2857    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2858    
2859    
2860           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2861    
2862           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
# Line 2849  Internet-Draft        LinuxSampler Contr Line 2869  Internet-Draft        LinuxSampler Contr
2869    
2870           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2871    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2872           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2873    
2874           "VOLUME: 1.0"           "VOLUME: 1.0"
# Line 2889  Internet-Draft        LinuxSampler Contr Line 2901  Internet-Draft        LinuxSampler Contr
2901    
2902    
2903    
2904    
2905    
2906    
2907    
2908    
2909    
2910    
2911    Schoenebeck               Expires March 4, 2008                [Page 52]
2912    
2913    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2914    
2915    
2916  6.4.12.  Current number of active disk streams  6.4.12.  Current number of active disk streams
2917    
2918     The front-end can ask for the current number of active disk streams     The front-end can ask for the current number of active disk streams
# Line 2905  Internet-Draft        LinuxSampler Contr Line 2929  Internet-Draft        LinuxSampler Contr
2929        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
2930        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
2931        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2932        return "NA" for not available.        return "NA" for not available.
2933    
2934     Example:     Example:
# Line 2945  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
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
2964    
2965    
2966    
2967    Schoenebeck               Expires March 4, 2008                [Page 53]
2968    
2969    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2970    
2971    
2972        the response are not in particular order, thus the front-end has        the response are not in particular order, thus the front-end has
2973        to sort them by itself if necessary.        to sort them by itself if necessary.
2974    
# Line 2960  Internet-Draft        LinuxSampler Contr Line 2984  Internet-Draft        LinuxSampler Contr
2984    
2985        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2986    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2987        S: ""        S: ""
2988    
2989  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 3003  Internet-Draft        LinuxSampler Contr Line 3018  Internet-Draft        LinuxSampler Contr
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    
3021    
3022    
3023    Schoenebeck               Expires March 4, 2008                [Page 54]
3024    
3025    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3026    
3027    
3028     Examples:     Examples:
3029    
3030    
# Line 3017  Internet-Draft        LinuxSampler Contr Line 3039  Internet-Draft        LinuxSampler Contr
3039        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3040        type>        type>
3041    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3042     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3043     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
3044    
# Line 3059  Internet-Draft        LinuxSampler Contr Line 3073  Internet-Draft        LinuxSampler Contr
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)
3076    
3077    
3078    
3079    Schoenebeck               Expires March 4, 2008                [Page 55]
3080    
3081    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3082    
3083    
3084     command, <audio-out> is the numerical ID of the sampler channel's     command, <audio-out> is the numerical ID of the sampler channel's
3085     audio output channel which should be rerouted and <audio-in> is the     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
# Line 3072  Internet-Draft        LinuxSampler Contr Line 3094  Internet-Draft        LinuxSampler Contr
3094    
3095        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3096    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3097           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3098           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3099           warning message           warning message
# Line 3115  Internet-Draft        LinuxSampler Contr Line 3128  Internet-Draft        LinuxSampler Contr
3128    
3129        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck               Expires March 4, 2008                [Page 56]
3136    
3137    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3138    
3139    
3140           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
3141           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3142           message           message
# Line 3128  Internet-Draft        LinuxSampler Contr Line 3150  Internet-Draft        LinuxSampler Contr
3150    
3151    
3152    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3153  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
3154    
3155     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 3170  Internet-Draft        LinuxSampler Contr Line 3183  Internet-Draft        LinuxSampler Contr
3183    
3184    
3185    
3186    
3187    
3188    
3189    
3190    
3191    Schoenebeck               Expires March 4, 2008                [Page 57]
3192    
3193    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3194    
3195    
3196  6.4.19.  Setting MIDI input port  6.4.19.  Setting MIDI input port
3197    
3198     The front-end can alter the MIDI input port on a specific sampler     The front-end can alter the MIDI input port on a specific sampler
# Line 3184  Internet-Draft        LinuxSampler Contr Line 3207  Internet-Draft        LinuxSampler Contr
3207    
3208        "OK" -        "OK" -
3209    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3210           on success           on success
3211    
3212        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3227  Internet-Draft        LinuxSampler Contr Line 3241  Internet-Draft        LinuxSampler Contr
3241    
3242           on success           on success
3243    
3244    
3245    
3246    
3247    Schoenebeck               Expires March 4, 2008                [Page 58]
3248    
3249    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3250    
3251    
3252        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3253    
3254           if MIDI input channel was set, but there are noteworthy           if MIDI input channel was set, but there are noteworthy
# Line 3242  Internet-Draft        LinuxSampler Contr Line 3264  Internet-Draft        LinuxSampler Contr
3264    
3265    
3266    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 58]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
   
   
3267  6.4.21.  Setting channel volume  6.4.21.  Setting channel volume
3268    
3269     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
# Line 3284  Internet-Draft        LinuxSampler Contr Line 3297  Internet-Draft        LinuxSampler Contr
3297    
3298    
3299    
3300    
3301    
3302    
3303    Schoenebeck               Expires March 4, 2008                [Page 59]
3304    
3305    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3306    
3307    
3308    
3309    
3310  6.4.22.  Muting a sampler channel  6.4.22.  Muting a sampler channel
3311    
3312     The front-end can mute/unmute a specific sampler channel by sending     The front-end can mute/unmute a specific sampler channel by sending
# Line 3298  Internet-Draft        LinuxSampler Contr Line 3321  Internet-Draft        LinuxSampler Contr
3321    
3322     Possible Answers:     Possible Answers:
3323    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3324        "OK" -        "OK" -
3325    
3326           on success           on success
# Line 3338  Internet-Draft        LinuxSampler Contr Line 3354  Internet-Draft        LinuxSampler Contr
3354    
3355     Possible Answers:     Possible Answers:
3356    
3357    
3358    
3359    Schoenebeck               Expires March 4, 2008                [Page 60]
3360    
3361    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3362    
3363    
3364        "OK" -        "OK" -
3365    
3366           on success           on success
# Line 3353  Internet-Draft        LinuxSampler Contr Line 3376  Internet-Draft        LinuxSampler Contr
3376           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3377           error message           error message
3378    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3379     Examples:     Examples:
3380    
3381    
# Line 3394  Internet-Draft        LinuxSampler Contr Line 3409  Internet-Draft        LinuxSampler Contr
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
3412    
3413    
3414    
3415    Schoenebeck               Expires March 4, 2008                [Page 61]
3416    
3417    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3418    
3419    
3420           would fall back to "NONE".           would fall back to "NONE".
3421    
3422     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
# Line 3410  Internet-Draft        LinuxSampler Contr Line 3433  Internet-Draft        LinuxSampler Contr
3433           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3434           error message           error message
3435    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3436     Examples:     Examples:
3437    
3438    
# Line 3449  Internet-Draft        LinuxSampler Contr Line 3465  Internet-Draft        LinuxSampler Contr
3465     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
3466     runtime performance, because for implementing channel effect sends,     runtime performance, because for implementing channel effect sends,
3467     separate (sampler channel local) audio buffers are needed to render     separate (sampler channel local) audio buffers are needed to render
3468    
3469    
3470    
3471    Schoenebeck               Expires March 4, 2008                [Page 62]
3472    
3473    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3474    
3475    
3476     and mix the voices and route the audio signal afterwards to the     and mix the voices and route the audio signal afterwards to the
3477     master outputs and effect send outputs (along with their respective     master outputs and effect send outputs (along with their respective
3478     effect send levels).  A sampler channel without effect sends however     effect send levels).  A sampler channel without effect sends however
# Line 3463  Internet-Draft        LinuxSampler Contr Line 3487  Internet-Draft        LinuxSampler Contr
3487           channel, where <fx-send-id> reflects the unique ID of the newly           channel, where <fx-send-id> reflects the unique ID of the newly
3488           created effect send entity           created effect send entity
3489    
   
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3490        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3491    
3492           when a new effect send could not be added, i.e. due to invalid           when a new effect send could not be added, i.e. due to invalid
# Line 3506  Internet-Draft        LinuxSampler Contr Line 3520  Internet-Draft        LinuxSampler Contr
3520    
3521        "OK" -        "OK" -
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck               Expires March 4, 2008                [Page 63]
3528    
3529    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3530    
3531    
3532           on success           on success
3533    
3534        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3519  Internet-Draft        LinuxSampler Contr Line 3542  Internet-Draft        LinuxSampler Contr
3542    
3543        S: "OK"        S: "OK"
3544    
   
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3545  6.4.27.  Getting amount of effect sends on a sampler channel  6.4.27.  Getting amount of effect sends on a sampler channel
3546    
3547     The front-end can ask for the amount of effect sends on a specific     The front-end can ask for the amount of effect sends on a specific
# Line 3564  Internet-Draft        LinuxSampler Contr Line 3577  Internet-Draft        LinuxSampler Contr
3577    
3578     Possible Answers:     Possible Answers:
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires March 4, 2008                [Page 64]
3584    
3585    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3586    
3587    
3588        The sampler will answer by returning a comma separated list with        The sampler will answer by returning a comma separated list with
3589        all effect sends' numerical IDs on the given sampler channel.        all effect sends' numerical IDs on the given sampler channel.
3590    
# Line 3577  Internet-Draft        LinuxSampler Contr Line 3598  Internet-Draft        LinuxSampler Contr
3598    
3599        S: ""        S: ""
3600    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 64]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3601  6.4.29.  Getting effect send information  6.4.29.  Getting effect send information
3602    
3603     The front-end can ask for the current settings of an effect send     The front-end can ask for the current settings of an effect send
# Line 3619  Internet-Draft        LinuxSampler Contr Line 3632  Internet-Draft        LinuxSampler Contr
3632    
3633           LEVEL -           LEVEL -
3634    
3635    
3636    
3637    
3638    
3639    Schoenebeck               Expires March 4, 2008                [Page 65]
3640    
3641    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3642    
3643    
3644              optionally dotted number reflecting the effect send's              optionally dotted number reflecting the effect send's
3645              current send level (where a value < 1.0 means attenuation              current send level (where a value < 1.0 means attenuation
3646              and a value > 1.0 means amplification)              and a value > 1.0 means amplification)
# Line 3633  Internet-Draft        LinuxSampler Contr Line 3655  Internet-Draft        LinuxSampler Contr
3655              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3656              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3657    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3658     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3659    
3660     Example:     Example:
# Line 3673  Internet-Draft        LinuxSampler Contr Line 3687  Internet-Draft        LinuxSampler Contr
3687    
3688     Possible Answers:     Possible Answers:
3689    
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires March 4, 2008                [Page 66]
3696    
3697    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3698    
3699    
3700        "OK" -        "OK" -
3701    
3702           on success           on success
# Line 3688  Internet-Draft        LinuxSampler Contr Line 3712  Internet-Draft        LinuxSampler Contr
3712    
3713        S: "OK"        S: "OK"
3714    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3715  6.4.31.  Altering effect send's audio routing  6.4.31.  Altering effect send's audio routing
3716    
3717     The front-end can alter the destination of an effect send's audio     The front-end can alter the destination of an effect send's audio
# Line 3729  Internet-Draft        LinuxSampler Contr Line 3744  Internet-Draft        LinuxSampler Contr
3744    
3745     Possible Answers:     Possible Answers:
3746    
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires March 4, 2008                [Page 67]
3752    
3753    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3754    
3755    
3756        "OK" -        "OK" -
3757    
3758           on success           on success
# Line 3746  Internet-Draft        LinuxSampler Contr Line 3770  Internet-Draft        LinuxSampler Contr
3770    
3771     Example:     Example:
3772    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3773        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3774    
3775        S: "OK"        S: "OK"
# Line 3785  Internet-Draft        LinuxSampler Contr Line 3802  Internet-Draft        LinuxSampler Contr
3802           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3803           message           message
3804    
3805    
3806    
3807    Schoenebeck               Expires March 4, 2008                [Page 68]
3808    
3809    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3810    
3811    
3812        "ERR:<error-code>:<error-message>" -        "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
# Line 3801  Internet-Draft        LinuxSampler Contr Line 3825  Internet-Draft        LinuxSampler Contr
3825     The front-end can alter the current send level of an effect send     The front-end can alter the current send level of an effect send
3826     entity by sending the following command:     entity by sending the following command:
3827    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3828        SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>        SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3829    
3830     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
# Line 3839  Internet-Draft        LinuxSampler Contr Line 3855  Internet-Draft        LinuxSampler Contr
3855    
3856     Example:     Example:
3857    
3858    
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires March 4, 2008                [Page 69]
3864    
3865    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3866    
3867    
3868        C: "SET FX_SEND LEVEL 0 0 0.15"        C: "SET FX_SEND LEVEL 0 0 0.15"
3869    
3870        S: "OK"        S: "OK"
# Line 3857  Internet-Draft        LinuxSampler Contr Line 3883  Internet-Draft        LinuxSampler Contr
3883    
3884     Possible Answers:     Possible Answers:
3885    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3886        "OK" -        "OK" -
3887    
3888           on success           on success
# Line 3894  Internet-Draft        LinuxSampler Contr Line 3912  Internet-Draft        LinuxSampler Contr
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    
3915    
3916    
3917    
3918    
3919    Schoenebeck               Expires March 4, 2008                [Page 70]
3920    
3921    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3922    
3923    
3924        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3925    
3926     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
# Line 3911  Internet-Draft        LinuxSampler Contr Line 3938  Internet-Draft        LinuxSampler Contr
3938           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3939           message           message
3940    
   
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3941        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3942    
3943           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3952  Internet-Draft        LinuxSampler Contr Line 3969  Internet-Draft        LinuxSampler Contr
3969           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3970           message           message
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires March 4, 2008                [Page 71]
3976    
3977    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3978    
3979    
3980        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3981    
3982           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3969  Internet-Draft        LinuxSampler Contr Line 3994  Internet-Draft        LinuxSampler Contr
3994        SET ECHO <value>        SET ECHO <value>
3995    
3996     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3997     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
3998     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
3999     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 4007  Internet-Draft        LinuxSampler Contr Line 4024  Internet-Draft        LinuxSampler Contr
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    
4027    
4028    
4029    
4030    
4031    Schoenebeck               Expires March 4, 2008                [Page 72]
4032    
4033    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4034    
4035    
4036  6.6.  Global commands  6.6.  Global commands
4037    
4038     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
# Line 4023  Internet-Draft        LinuxSampler Contr Line 4049  Internet-Draft        LinuxSampler Contr
4049        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4050        voices on the sampler.        voices on the sampler.
4051    
   
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4052  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
4053    
4054     The front-end can ask for the maximum number of active voices by     The front-end can ask for the maximum number of active voices by
# Line 4062  Internet-Draft        LinuxSampler Contr Line 4078  Internet-Draft        LinuxSampler Contr
4078    
4079    
4080    
4081    
4082    
4083    
4084    
4085    
4086    
4087    Schoenebeck               Expires March 4, 2008                [Page 73]
4088    
4089    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4090    
4091    
4092  6.6.4.  General sampler informations  6.6.4.  General sampler informations
4093    
4094     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
# Line 4081  Internet-Draft        LinuxSampler Contr Line 4108  Internet-Draft        LinuxSampler Contr
4108    
4109           DESCRIPTION -           DESCRIPTION -
4110    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4111              arbitrary textual description about the sampler              arbitrary textual description about the sampler
4112    
4113           VERSION -           VERSION -
# Line 4117  Internet-Draft        LinuxSampler Contr Line 4136  Internet-Draft        LinuxSampler Contr
4136    
4137     Possible Answers:     Possible Answers:
4138    
4139    
4140    
4141    
4142    
4143    Schoenebeck               Expires March 4, 2008                [Page 74]
4144    
4145    Internet-Draft    LinuxSampler Control Protocol (draft)   September 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.
# Line 4137  Internet-Draft        LinuxSampler Contr Line 4165  Internet-Draft        LinuxSampler Contr
4165     might usually be in the range between 0.0 and 1.0, that is for     might usually be in the range between 0.0 and 1.0, that is for
4166     attenuating the overall volume.     attenuating the overall volume.
4167    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4168     Possible Answers:     Possible Answers:
4169    
4170        "OK" -        "OK" -
# Line 4174  Internet-Draft        LinuxSampler Contr Line 4194  Internet-Draft        LinuxSampler Contr
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    
4197    
4198    
4199    Schoenebeck               Expires March 4, 2008                [Page 75]
4200    
4201    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4202    
4203    
4204     By default, that is when the sampler is launched, there is no map,     By default, that is when the sampler is launched, there is no map,
4205     thus the sampler will simply ignore all program change messages.  The     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     front-end has to explicitly create at least one map, add entries to
# Line 4192  Internet-Draft        LinuxSampler Contr Line 4219  Internet-Draft        LinuxSampler Contr
4219     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4220     current MIDI instrument map.     current MIDI instrument map.
4221    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4222  6.7.1.  Create a new MIDI instrument map  6.7.1.  Create a new MIDI instrument map
4223    
4224     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
# Line 4229  Internet-Draft        LinuxSampler Contr Line 4247  Internet-Draft        LinuxSampler Contr
4247    
4248        S: "OK[0]"        S: "OK[0]"
4249    
4250    
4251    
4252    
4253    
4254    
4255    Schoenebeck               Expires March 4, 2008                [Page 76]
4256    
4257    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4258    
4259    
4260        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4261    
4262        S: "OK[1]"        S: "OK[1]"
# Line 4250  Internet-Draft        LinuxSampler Contr Line 4278  Internet-Draft        LinuxSampler Contr
4278     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4279     following command:     following command:
4280    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4281        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4282    
4283     Possible Answers:     Possible Answers:
# Line 4284  Internet-Draft        LinuxSampler Contr Line 4305  Internet-Draft        LinuxSampler Contr
4305     The front-end can retrieve the current amount of MIDI instrument maps     The front-end can retrieve the current amount of MIDI instrument maps
4306     by sending the following command:     by sending the following command:
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires March 4, 2008                [Page 77]
4312    
4313    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4314    
4315    
4316        GET MIDI_INSTRUMENT_MAPS        GET MIDI_INSTRUMENT_MAPS
4317    
4318     Possible Answers:     Possible Answers:
# Line 4303  Internet-Draft        LinuxSampler Contr Line 4332  Internet-Draft        LinuxSampler Contr
4332     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4333     following command:     following command:
4334    
   
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4335        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4336    
4337     Possible Answers:     Possible Answers:
# Line 4342  Internet-Draft        LinuxSampler Contr Line 4361  Internet-Draft        LinuxSampler Contr
4361        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4362        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
4363        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
4364    
4365    
4366    
4367    Schoenebeck               Expires March 4, 2008                [Page 78]
4368    
4369    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4370    
4371    
4372        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
4373        following categories are defined:        following categories are defined:
4374    
# Line 4361  Internet-Draft        LinuxSampler Contr Line 4388  Internet-Draft        LinuxSampler Contr
4388    
4389     Example:     Example:
4390    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4391        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4392    
4393        S: "NAME: Standard Map"        S: "NAME: Standard Map"
# Line 4399  Internet-Draft        LinuxSampler Contr Line 4418  Internet-Draft        LinuxSampler Contr
4418    
4419     Example:     Example:
4420    
4421    
4422    
4423    Schoenebeck               Expires March 4, 2008                [Page 79]
4424    
4425    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4426    
4427    
4428        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4429    
4430        S: "OK"        S: "OK"
# Line 4417  Internet-Draft        LinuxSampler Contr Line 4443  Internet-Draft        LinuxSampler Contr
4443     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4444     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4445     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4446     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
4447     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes,
4448     <instrument_index> the index (integer value) of the instrument within     supporting escape sequences as described in chapter "Character Set
4449     the given file, <volume_value> reflects the master volume of the     and Escape Sequences (Section 7.1)"), <instrument_index> the index
4450     instrument as optionally dotted number (where a value < 1.0 means     (integer value) of the instrument within the given file,
4451     attenuation and a value > 1.0 means amplification).  This parameter     <volume_value> reflects the master volume of the instrument as
4452     easily allows to adjust the volume of all intruments within a custom     optionally dotted number (where a value < 1.0 means attenuation and a
4453     instrument map without having to adjust their instrument files.  The     value > 1.0 means amplification).  This parameter easily allows to
4454     OPTIONAL <instr_load_mode> argument defines the life time of the     adjust the volume of all intruments within a custom instrument map
4455     instrument, that is when the instrument should be loaded, when freed     without having to adjust their instrument files.  The OPTIONAL
4456     and has exactly the following possibilities:     <instr_load_mode> argument defines the life time of the instrument,
4457       that is when the instrument should be loaded, when freed and has
4458       exactly the following possibilities:
4459    
4460        "ON_DEMAND" -        "ON_DEMAND" -
4461    
# Line 4454  Internet-Draft        LinuxSampler Contr Line 4474  Internet-Draft        LinuxSampler Contr
4474           instrument) are explicitly changed to "ON_DEMAND" and no           instrument) are explicitly changed to "ON_DEMAND" and no
4475           sampler channel is using the instrument anymore.           sampler channel is using the instrument anymore.
4476    
4477    
4478    
4479    Schoenebeck               Expires March 4, 2008                [Page 80]
4480    
4481    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4482    
4483    
4484        "PERSISTENT" -        "PERSISTENT" -
4485    
4486           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
# Line 4473  Internet-Draft        LinuxSampler Contr Line 4500  Internet-Draft        LinuxSampler Contr
4500           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
4501           that is it will not change the mode.           that is it will not change the mode.
4502    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4503     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
4504     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
4505     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
# Line 4510  Internet-Draft        LinuxSampler Contr Line 4529  Internet-Draft        LinuxSampler Contr
4529     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4530     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4531     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
4532    
4533    
4534    
4535    Schoenebeck               Expires March 4, 2008                [Page 81]
4536    
4537    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4538    
4539    
4540     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4541     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4542     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4528  Internet-Draft        LinuxSampler Contr Line 4555  Internet-Draft        LinuxSampler Contr
4555    
4556     Examples:     Examples:
4557    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4558        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4559        0.8 PERSISTENT"        0.8 PERSISTENT"
4560    
# Line 4567  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585     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
4586     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires March 4, 2008                [Page 82]
4592    
4593    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4594    
4595    
4596        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
4597    
4598     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 4585  Internet-Draft        LinuxSampler Contr Line 4611  Internet-Draft        LinuxSampler Contr
4611    
4612        S: "234"        S: "234"
4613    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4614        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
4615    
4616        S: "954"        S: "954"
# Line 4623  Internet-Draft        LinuxSampler Contr Line 4641  Internet-Draft        LinuxSampler Contr
4641    
4642     Example:     Example:
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires March 4, 2008                [Page 83]
4648    
4649    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4650    
4651    
4652        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
4653    
4654        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 4641  Internet-Draft        LinuxSampler Contr Line 4667  Internet-Draft        LinuxSampler Contr
4667    
4668     Possible Answers:     Possible Answers:
4669    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4670        "OK" -        "OK" -
4671    
4672           usually           usually
# Line 4678  Internet-Draft        LinuxSampler Contr Line 4696  Internet-Draft        LinuxSampler Contr
4696    
4697     Possible Answers:     Possible Answers:
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires March 4, 2008                [Page 84]
4704    
4705    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4706    
4707    
4708        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4709        answer line begins with the information category name followed by        answer line begins with the information category name followed by
4710        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 4696  Internet-Draft        LinuxSampler Contr Line 4723  Internet-Draft        LinuxSampler Contr
4723    
4724           Name of the engine to be deployed for this instrument.           Name of the engine to be deployed for this instrument.
4725    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4726        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4727    
4728           File name of the instrument.           File name of the instrument.
# Line 4734  Internet-Draft        LinuxSampler Contr Line 4752  Internet-Draft        LinuxSampler Contr
4752    
4753     Example:     Example:
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires March 4, 2008                [Page 85]
4760    
4761    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4762    
4763    
4764        C: "GET MIDI_INSTRUMENT INFO 1 45 120"        C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4765    
4766        S: "NAME: Drums for Foo Song"        S: "NAME: Drums for Foo Song"
# Line 4752  Internet-Draft        LinuxSampler Contr Line 4779  Internet-Draft        LinuxSampler Contr
4779    
4780           "."           "."
4781    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 85]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4782  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
4783    
4784     The front-end can clear a whole MIDI instrument map, that is delete     The front-end can clear a whole MIDI instrument map, that is delete
# Line 4791  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809    
4810        S: "OK"        S: "OK"
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires March 4, 2008                [Page 86]
4816    
4817    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4818    
4819    
4820        C: "CLEAR MIDI_INSTRUMENTS ALL"        C: "CLEAR MIDI_INSTRUMENTS ALL"
4821    
4822        S: "OK"        S: "OK"
# Line 4800  Internet-Draft        LinuxSampler Contr Line 4826  Internet-Draft        LinuxSampler Contr
4826     The following commands describe how to use and manage the instruments     The following commands describe how to use and manage the instruments
4827     database.     database.
4828    
4829       Notice:
4830    
4831          All command arguments representing a path or instrument/directory
4832          name support escape sequences as described in chapter "Character
4833          Set and Escape Sequences (Section 7.1)".
4834    
4835          All occurrences of a forward slash in instrument and directory
4836          names are escaped with its hex (\x2f) or octal (\057) escape
4837          sequence.
4838    
4839  6.8.1.  Creating a new instrument directory  6.8.1.  Creating a new instrument directory
4840    
4841     The front-end can add a new instrument directory to the instruments     The front-end can add a new instrument directory to the instruments
# Line 4810  Internet-Draft        LinuxSampler Contr Line 4846  Internet-Draft        LinuxSampler Contr
4846     Where <dir> is the absolute path name of the directory to be created     Where <dir> is the absolute path name of the directory to be created
4847     (encapsulated into apostrophes).     (encapsulated into apostrophes).
4848    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4849     Possible Answers:     Possible Answers:
4850    
4851        "OK" -        "OK" -
# Line 4835  Internet-Draft        LinuxSampler Contr Line 4864  Internet-Draft        LinuxSampler Contr
4864    
4865        S: "OK"        S: "OK"
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires March 4, 2008                [Page 87]
4872    
4873    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4874    
4875    
4876  6.8.2.  Deleting an instrument directory  6.8.2.  Deleting an instrument directory
4877    
4878     The front-end can delete a particular instrument directory from the     The front-end can delete a particular instrument directory from the
# Line 4863  Internet-Draft        LinuxSampler Contr Line 4901  Internet-Draft        LinuxSampler Contr
4901    
4902        S: "OK"        S: "OK"
4903    
   
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4904  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
4905    
4906     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 4892  Internet-Draft        LinuxSampler Contr Line 4920  Internet-Draft        LinuxSampler Contr
4920    
4921        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires March 4, 2008                [Page 88]
4928    
4929    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4930    
4931    
4932           if the given directory does not exist.           if the given directory does not exist.
4933    
4934     Example:     Example:
# Line 4921  Internet-Draft        LinuxSampler Contr Line 4958  Internet-Draft        LinuxSampler Contr
4958    
4959           if the given directory does not exist.           if the given directory does not exist.
4960    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4961     Example:     Example:
4962    
4963        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
# Line 4948  Internet-Draft        LinuxSampler Contr Line 4977  Internet-Draft        LinuxSampler Contr
4977        GET DB_INSTRUMENT_DIRECTORY INFO <dir>        GET DB_INSTRUMENT_DIRECTORY INFO <dir>
4978    
4979     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
4980    
4981    
4982    
4983    Schoenebeck               Expires March 4, 2008                [Page 89]
4984    
4985    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4986    
4987    
4988     directory the front-end is interested in.     directory the front-end is interested in.
4989    
4990     Possible Answers:     Possible Answers:
# Line 4962  Internet-Draft        LinuxSampler Contr Line 4999  Internet-Draft        LinuxSampler Contr
4999    
5000           DESCRIPTION -           DESCRIPTION -
5001    
5002              A brief description of the directory content              A brief description of the directory content.  Note that the
5003                character string may contain escape sequences (Section 7.1).
5004    
5005           CREATED -           CREATED -
5006    
# Line 4978  Internet-Draft        LinuxSampler Contr Line 5016  Internet-Draft        LinuxSampler Contr
5016    
5017     Example:     Example:
5018    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5019        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
5020    
5021        S: "DESCRIPTION: Piano collection of instruments in GigaSampler        S: "DESCRIPTION: Piano collection of instruments in GigaSampler
# Line 5001  Internet-Draft        LinuxSampler Contr Line 5032  Internet-Draft        LinuxSampler Contr
5032     The front-end can alter the name of a specific instrument directory     The front-end can alter the name of a specific instrument directory
5033     by sending the following command:     by sending the following command:
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires March 4, 2008                [Page 90]
5040    
5041    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5042    
5043    
5044        SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>        SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5045    
5046     Where <dir> is the absolute path name of the directory and <name> is     Where <dir> is the absolute path name of the directory and <name> is
# Line 5034  Internet-Draft        LinuxSampler Contr Line 5074  Internet-Draft        LinuxSampler Contr
5074     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
5075     <dst> is the location where the directory will be moved to.     <dst> is the location where the directory will be moved to.
5076    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5077     Possible Answers:     Possible Answers:
5078    
5079        "OK" -        "OK" -
# Line 5056  Internet-Draft        LinuxSampler Contr Line 5089  Internet-Draft        LinuxSampler Contr
5089    
5090     Example:     Example:
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires March 4, 2008                [Page 91]
5096    
5097    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5098    
5099    
5100        C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/        C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5101        Acoustic'"        Acoustic'"
5102    
# Line 5089  Internet-Draft        LinuxSampler Contr Line 5130  Internet-Draft        LinuxSampler Contr
5130        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5131        '/Acoustic/Pianos'"        '/Acoustic/Pianos'"
5132    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5133        S: "OK"        S: "OK"
5134    
5135  6.8.9.  Changing the description of directory  6.8.9.  Changing the description of directory
# Line 5107  Internet-Draft        LinuxSampler Contr Line 5140  Internet-Draft        LinuxSampler Contr
5140        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5141    
5142     Where <dir> is the absolute path name of the directory and <desc> is     Where <dir> is the absolute path name of the directory and <desc> is
5143     the new description for the directory.     the new description for the directory (encapsulated into apostrophes,
5144       supporting escape sequences as described in chapter "Character Set
5145       and Escape Sequences (Section 7.1)").
5146    
5147     Possible Answers:     Possible Answers:
5148    
5149    
5150    
5151    Schoenebeck               Expires March 4, 2008                [Page 92]
5152    
5153    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5154    
5155    
5156        "OK" -        "OK" -
5157    
5158           on success           on success
# Line 5144  Internet-Draft        LinuxSampler Contr Line 5186  Internet-Draft        LinuxSampler Contr
5186     NAME='<search-string>'     NAME='<search-string>'
5187    
5188        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5189        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5190          escape sequences as described in chapter "Character Set and Escape
5191          Sequences (Section 7.1)").
   
 Schoenebeck             Expires November 25, 2007              [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
5192    
5193     CREATED='[<date-after>]..[<date-before>]'     CREATED='[<date-after>]..[<date-before>]'
5194    
# Line 5164  Internet-Draft        LinuxSampler Contr Line 5201  Internet-Draft        LinuxSampler Contr
5201    
5202     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires March 4, 2008                [Page 93]
5208    
5209    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5210    
5211    
5212        Restricts the search to directories, which date of last        Restricts the search to directories, which date of last
5213        modification satisfies the specified period, where <date-after>        modification satisfies the specified period, where <date-after>
5214        and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-        and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
# Line 5175  Internet-Draft        LinuxSampler Contr Line 5220  Internet-Draft        LinuxSampler Contr
5220     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5221    
5222        Restricts the search to directories with description that        Restricts the search to directories with description that
5223        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5224          apostrophes, supporting escape sequences as described in chapter
5225          "Character Set and Escape Sequences (Section 7.1)").
5226    
5227     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5228     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
# Line 5201  Internet-Draft        LinuxSampler Contr Line 5248  Internet-Draft        LinuxSampler Contr
5248    
5249        S: "'/Piano Collection','/Percussions'"        S: "'/Piano Collection','/Percussions'"
5250    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5251  6.8.11.  Adding instruments to the instruments database  6.8.11.  Adding instruments to the instruments database
5252    
5253     The front-end can add one or more instruments to the instruments     The front-end can add one or more instruments to the instruments
# Line 5218  Internet-Draft        LinuxSampler Contr Line 5257  Internet-Draft        LinuxSampler Contr
5257        [<instr_index>]        [<instr_index>]
5258    
5259     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5260    
5261    
5262    
5263    Schoenebeck               Expires March 4, 2008                [Page 94]
5264    
5265    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5266    
5267    
5268     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
5269     instruments (that are not already in the database) will be added,     instruments (that are not already in the database) will be added,
5270     <file_path> is the absolute path name of a file or directory in the     <file_path> is the absolute path name of a file or directory in the
# Line 5257  Internet-Draft        LinuxSampler Contr Line 5304  Internet-Draft        LinuxSampler Contr
5304    
5305     Possible Answers:     Possible Answers:
5306    
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5307        "OK" -        "OK" -
5308    
5309           on success when NON_MODAL is not supplied           on success when NON_MODAL is not supplied
# Line 5275  Internet-Draft        LinuxSampler Contr Line 5314  Internet-Draft        LinuxSampler Contr
5314           numerical ID used to obtain status information about the job           numerical ID used to obtain status information about the job
5315           progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)           progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5316    
5317    
5318    
5319    Schoenebeck               Expires March 4, 2008                [Page 95]
5320    
5321    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5322    
5323    
5324        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5325    
5326           if an invalid path is specified.           if an invalid path is specified.
# Line 5312  Internet-Draft        LinuxSampler Contr Line 5358  Internet-Draft        LinuxSampler Contr
5358    
5359        S: "OK"        S: "OK"
5360    
   
   
   
   
 Schoenebeck             Expires November 25, 2007              [Page 95]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5361  6.8.13.  Getting amount of instruments  6.8.13.  Getting amount of instruments
5362    
5363     The front-end can retrieve the current amount of instruments in a     The front-end can retrieve the current amount of instruments in a
# Line 5333  Internet-Draft        LinuxSampler Contr Line 5370  Internet-Draft        LinuxSampler Contr
5370     including those located in subdirectories of the specified directory,     including those located in subdirectories of the specified directory,
5371     will be returned.     will be returned.
5372    
5373    
5374    
5375    Schoenebeck               Expires March 4, 2008                [Page 96]
5376    
5377    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5378    
5379    
5380     Possible Answers:     Possible Answers:
5381    
5382        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
# Line 5370  Internet-Draft        LinuxSampler Contr Line 5414  Internet-Draft        LinuxSampler Contr
5414    
5415     Example:     Example:
5416    
   
   
 Schoenebeck             Expires November 25, 2007              [Page 96]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5417        C: "LIST DB_INSTRUMENTS '/Piano Collection'"        C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5418    
5419        S: "'Bosendorfer 290','Steinway D'"        S: "'Bosendorfer 290','Steinway D'"
# Line 5386  Internet-Draft        LinuxSampler Contr Line 5423  Internet-Draft        LinuxSampler Contr
5423        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5424        Steinway D','/Piano Collection/Lite/Free Piano'"        Steinway D','/Piano Collection/Lite/Free Piano'"
5425    
5426    
5427    
5428    
5429    
5430    
5431    Schoenebeck               Expires March 4, 2008                [Page 97]
5432    
5433    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5434    
5435    
5436  6.8.15.  Getting instrument information  6.8.15.  Getting instrument information
5437    
5438     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
# Line 5408  Internet-Draft        LinuxSampler Contr Line 5455  Internet-Draft        LinuxSampler Contr
5455    
5456           INSTRUMENT_FILE -           INSTRUMENT_FILE -
5457    
5458              File name of the instrument.              File name of the instrument.  Note that the character string
5459                may contain escape sequences (Section 7.1).
5460    
5461           INSTRUMENT_NR -           INSTRUMENT_NR -
5462    
# Line 5424  Internet-Draft        LinuxSampler Contr Line 5472  Internet-Draft        LinuxSampler Contr
5472    
5473           SIZE -           SIZE -
5474    
5475                The size of the instrument in bytes.
5476    
5477             CREATED -
5478    
5479                The date and time when the instrument is added in the
5480                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5481                format
5482    
5483    
 Schoenebeck             Expires November 25, 2007              [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
5484    
5485    
             The size of the instrument in bytes.  
5486    
5487           CREATED -  Schoenebeck               Expires March 4, 2008                [Page 98]
5488    
5489    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5490    
             The date and time when the instrument is added in the  
             instruments database, represented in "YYYY-MM-DD HH:MM:SS"  
             format  
5491    
5492           MODIFIED -           MODIFIED -
5493    
# Line 5449  Internet-Draft        LinuxSampler Contr Line 5497  Internet-Draft        LinuxSampler Contr
5497    
5498           DESCRIPTION -           DESCRIPTION -
5499    
5500              A brief description of the instrument              A brief description of the instrument.  Note that the
5501                character string may contain escape sequences (Section 7.1).
5502    
5503           IS_DRUM -           IS_DRUM -
5504    
# Line 5458  Internet-Draft        LinuxSampler Contr Line 5507  Internet-Draft        LinuxSampler Contr
5507    
5508           PRODUCT -           PRODUCT -
5509    
5510              The product title of the instrument              The product title of the instrument.  Note that the
5511                character string may contain escape sequences (Section 7.1).
5512    
5513           ARTISTS -           ARTISTS -
5514    
5515              Lists the artist names              Lists the artist names.  Note that the character string may
5516                contain escape sequences (Section 7.1).
5517    
5518           KEYWORDS -           KEYWORDS -
5519    
5520              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
5521              Keywords are separated with semicolon and blank.              Keywords are separated with semicolon and blank.  Note that
5522                the character string may contain escape sequences
5523                (Section 7.1).
5524    
5525     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5526    
# Line 5481  Internet-Draft        LinuxSampler Contr Line 5534  Internet-Draft        LinuxSampler Contr
5534    
5535           "FORMAT_FAMILY: GIG"           "FORMAT_FAMILY: GIG"
5536    
5537             "FORMAT_VERSION: 2"
5538    
5539    
5540    
5541    
 Schoenebeck             Expires November 25, 2007              [Page 98]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
5542    
5543    Schoenebeck               Expires March 4, 2008                [Page 99]
5544    
5545    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5546    
          "FORMAT_VERSION: 2"  
5547    
5548           "SIZE: 2050871870"           "SIZE: 2050871870"
5549    
# Line 5540  Internet-Draft        LinuxSampler Contr Line 5594  Internet-Draft        LinuxSampler Contr
5594    
5595    
5596    
5597  Schoenebeck             Expires November 25, 2007              [Page 99]  
5598    
5599    Schoenebeck               Expires March 4, 2008               [Page 100]
5600    
5601  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5602    
5603    
5604  6.8.17.  Moving an instrument  6.8.17.  Moving an instrument
# Line 5596  Internet-Draft        LinuxSampler Contr Line 5652  Internet-Draft        LinuxSampler Contr
5652    
5653    
5654    
5655  Schoenebeck             Expires November 25, 2007             [Page 100]  Schoenebeck               Expires March 4, 2008               [Page 101]
5656    
5657  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5658    
5659    
5660           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
# Line 5620  Internet-Draft        LinuxSampler Contr Line 5676  Internet-Draft        LinuxSampler Contr
5676        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5677    
5678     Where <instr> is the absolute path name of the instrument and <desc>     Where <instr> is the absolute path name of the instrument and <desc>
5679     is the new description for the instrument.     is the new description for the instrument (encapsulated into
5680       apostrophes, supporting escape sequences as described in chapter
5681       "Character Set and Escape Sequences (Section 7.1)").
5682    
5683     Possible Answers:     Possible Answers:
5684    
# Line 5647  Internet-Draft        LinuxSampler Contr Line 5705  Internet-Draft        LinuxSampler Contr
5705        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5706    
5707     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
    directory to search in.  If NON_RECURSIVE is specified, the  
    directories located in subdirectories of the specified directory will  
5708    
5709    
5710    
5711  Schoenebeck             Expires November 25, 2007             [Page 101]  Schoenebeck               Expires March 4, 2008               [Page 102]
5712    
5713  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5714    
5715    
5716       directory to search in.  If NON_RECURSIVE is specified, the
5717       directories located in subdirectories of the specified directory will
5718     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
5719     form of "key1=val1 key2=val2 ...".  The following criterias are     form of "key1=val1 key2=val2 ...".  The following criterias are
5720     allowed:     allowed:
# Line 5664  Internet-Draft        LinuxSampler Contr Line 5722  Internet-Draft        LinuxSampler Contr
5722     NAME='<search-string>'     NAME='<search-string>'
5723    
5724        Restricts the search to instruments, which names satisfy the        Restricts the search to instruments, which names satisfy the
5725        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5726          escape sequences as described in chapter "Character Set and Escape
5727          Sequences (Section 7.1)").
5728    
5729     SIZE=[<min>]..[<max>]     SIZE=[<min>]..[<max>]
5730    
# Line 5696  Internet-Draft        LinuxSampler Contr Line 5756  Internet-Draft        LinuxSampler Contr
5756     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5757    
5758        Restricts the search to instruments with description that        Restricts the search to instruments with description that
5759        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5760          apostrophes, supporting escape sequences as described in chapter
5761          "Character Set and Escape Sequences (Section 7.1)").
5762    
5763     PRODUCT='<search-string>'     PRODUCT='<search-string>'
5764    
       Restricts the search to instruments with product info that  
       satisfies the supplied search string.  
   
    ARTISTS='<search-string>'  
5765    
5766    
5767    Schoenebeck               Expires March 4, 2008               [Page 103]
5768    
5769    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5770    
5771    
5772  Schoenebeck             Expires November 25, 2007             [Page 102]        Restricts the search to instruments with product info that
5773          satisfies the supplied search string (encapsulated into
5774  Internet-Draft        LinuxSampler Control Protocol             May 2007        apostrophes, supporting escape sequences as described in chapter
5775          "Character Set and Escape Sequences (Section 7.1)").
5776    
5777       ARTISTS='<search-string>'
5778    
5779        Restricts the search to instruments with artists info that        Restricts the search to instruments with artists info that
5780        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5781          apostrophes, supporting escape sequences as described in chapter
5782          "Character Set and Escape Sequences (Section 7.1)").
5783    
5784     KEYWORDS='<search-string>'     KEYWORDS='<search-string>'
5785    
5786        Restricts the search to instruments with keyword list that        Restricts the search to instruments with keyword list that
5787        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5788          apostrophes, supporting escape sequences as described in chapter
5789          "Character Set and Escape Sequences (Section 7.1)").
5790    
5791     IS_DRUM=true | false     IS_DRUM=true | false
5792    
# Line 5750  Internet-Draft        LinuxSampler Contr Line 5817  Internet-Draft        LinuxSampler Contr
5817        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5818        290'"        290'"
5819    
       S: "'/Piano Collection/Bosendorfer 290'"  
   
       C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01  
       09:30:13..'"  
   
       S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/  
       Steinway D'"  
   
5820    
5821    
5822    
5823    Schoenebeck               Expires March 4, 2008               [Page 104]
5824    
5825    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5826    
5827    
5828          S: "'/Piano Collection/Bosendorfer 290'"
5829    
5830  Schoenebeck             Expires November 25, 2007             [Page 103]        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
5831          09:30:13..'"
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
5832    
5833          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5834          Steinway D'"
5835    
5836  6.8.21.  Getting job status information  6.8.21.  Getting job status information
5837    
# Line 5810  Internet-Draft        LinuxSampler Contr Line 5874  Internet-Draft        LinuxSampler Contr
5874    
5875     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5876    
    Example:  
   
       C: "GET DB_INSTRUMENTS_JOB INFO 2"  
   
       S: "FILES_TOTAL: 12"  
5877    
5878    
5879    Schoenebeck               Expires March 4, 2008               [Page 105]
5880    
5881    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5882    
5883    
5884       Example:
5885    
5886  Schoenebeck             Expires November 25, 2007             [Page 104]        C: "GET DB_INSTRUMENTS_JOB INFO 2"
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
5887    
5888          S: "FILES_TOTAL: 12"
5889    
5890           "FILES_SCANNED: 7"           "FILES_SCANNED: 7"
5891    
# Line 5833  Internet-Draft        LinuxSampler Contr Line 5895  Internet-Draft        LinuxSampler Contr
5895    
5896           "."           "."
5897    
5898    6.8.22.  Formatting the instruments database
5899    
5900       The front-end can remove all instruments and directories and re-
5901       create the instruments database structure (e.g., in case of a
5902       database corruption) by sending the following command:
5903    
5904          FORMAT INSTRUMENTS_DB
5905    
5906       Possible Answers:
5907    
5908          "OK" -
5909    
5910             on success
5911    
5912          "ERR:<error-code>:<error-message>" -
5913    
5914             If the formatting of the instruments database failed.
5915    
5916    6.9.  Editing Instruments
5917    
5918       The sampler allows to edit instruments while playing with the sampler
5919       by spawning an external (3rd party) instrument editor application for
5920       a given instrument.  The 3rd party instrument editor applications
5921       have to place a respective plugin DLL file into the sampler's plugins
5922       directory.  The sampler will automatically try to load all plugin
5923       DLLs in that directory on startup and only on startup!
5924    
5925       At the moment there is only one command for this feature set, but
5926       this will most probably change in future.
5927    
5928    6.9.1.  Opening an appropriate instrument editor application
5929    
5930       The front-end can request to open an appropriate instrument editor
5931       application by sending the following command:
5932    
5933    
5934    
5935    Schoenebeck               Expires March 4, 2008               [Page 106]
5936    
5937    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5938    
5939    
5940          EDIT INSTRUMENT <sampler-channel>
5941    
5942       Where <sampler-channel> should be replaced by the number of the
5943       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
5944       "LIST CHANNELS" (Section 6.4.4) command.
5945    
5946       The sampler will try to ask all registered instrument editors (or to
5947       be more specific: their sampler plugins) whether they are capable to
5948       handle the instrument on the given sampler channel.  The sampler will
5949       simply use the first instrument editor application which replied with
5950       a positive answer and spawn that instrument editor application within
5951       the sampler's process and provide that application access to the
5952       instrument's data structures, so both applications can share and
5953       access the same instruments data at the same time, thus allowing to
5954       immediately hear changes with the sampler made by the instrument
5955       editor.
5956    
5957       Note: consequently instrument editors are always spawned locally on
5958       the same machine where the sampler is running on!
5959    
5960       Possible Answers:
5961    
5962          "OK" -
5963    
5964             when an appropriate instrument editor was launched
5965    
5966          "WRN:<warning-code>:<warning-message>" -
5967    
5968             when an appropriate instrument editor was launched, but there
5969             are noteworthy issues
5970    
5971          "ERR:<error-code>:<error-message>" -
5972    
5973             when an appropriate instrument editor could not be launched
5974    
5975       Examples:
5976    
5977          C: "EDIT INSTRUMENT 0"
5978    
5979          S: "OK"
5980    
5981    
5982    
# Line 5874  Internet-Draft        LinuxSampler Contr Line 5988  Internet-Draft        LinuxSampler Contr
5988    
5989    
5990    
5991    Schoenebeck               Expires March 4, 2008               [Page 107]
   
 Schoenebeck             Expires November 25, 2007             [Page 105]  
5992    
5993  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5994    
5995    
5996  7.  Command Syntax  7.  Command Syntax
# Line 5932  Internet-Draft        LinuxSampler Contr Line 6044  Internet-Draft        LinuxSampler Contr
6044    
6045    
6046    
6047  Schoenebeck             Expires November 25, 2007             [Page 106]  Schoenebeck               Expires March 4, 2008               [Page 108]
6048    
6049  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6050    
6051    
6052        / LIST SP list_instruction        / LIST SP list_instruction
# Line 5959  Internet-Draft        LinuxSampler Contr Line 6071  Internet-Draft        LinuxSampler Contr
6071    
6072        / COPY SP copy_instruction        / COPY SP copy_instruction
6073    
6074          / EDIT SP edit_instruction
6075    
6076          / FORMAT SP format_instruction
6077    
6078        / RESET        / RESET
6079    
6080        / QUIT        / QUIT
# Line 5967  Internet-Draft        LinuxSampler Contr Line 6083  Internet-Draft        LinuxSampler Contr
6083    
6084        CHANNEL        CHANNEL
6085    
6086        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6087    
6088        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6089    
6090        / DB_INSTRUMENTS SP scan_mode SP pathname SP pathname        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6091    
6092        / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6093    
6094        / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6095        instrument_index        instrument_index
6096    
6097        / DB_INSTRUMENTS SP pathname SP pathname        / DB_INSTRUMENTS SP db_path SP filename
6098    
       / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  
6099    
       / MIDI_INSTRUMENT_MAP  
6100    
6101    
6102    
6103    Schoenebeck               Expires March 4, 2008               [Page 109]
6104    
6105    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6106    
6107    
6108  Schoenebeck             Expires November 25, 2007             [Page 107]        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6109    
6110          / MIDI_INSTRUMENT_MAP
6111    
6112        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
6113    
# Line 6037  Internet-Draft        LinuxSampler Contr Line 6153  Internet-Draft        LinuxSampler Contr
6153    
6154        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6155    
       / MISCELLANEOUS  
6156    
       / TOTAL_VOICE_COUNT  
6157    
6158    
6159    Schoenebeck               Expires March 4, 2008               [Page 110]
6160    
6161    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6162    
6163    
6164  Schoenebeck             Expires November 25, 2007             [Page 108]        / MISCELLANEOUS
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6165    
6166          / TOTAL_VOICE_COUNT
6167    
6168        / GLOBAL_INFO        / GLOBAL_INFO
6169    
# Line 6093  Internet-Draft        LinuxSampler Contr Line 6209  Internet-Draft        LinuxSampler Contr
6209    
6210        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6211    
       / MISCELLANEOUS  
6212    
       / TOTAL_VOICE_COUNT  
6213    
6214    
6215    Schoenebeck               Expires March 4, 2008               [Page 111]
6216    
6217    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6218    
6219    
6220  Schoenebeck             Expires November 25, 2007             [Page 109]        / MISCELLANEOUS
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6221    
6222          / TOTAL_VOICE_COUNT
6223    
6224        / GLOBAL_INFO        / GLOBAL_INFO
6225    
# Line 6136  Internet-Draft        LinuxSampler Contr Line 6252  Internet-Draft        LinuxSampler Contr
6252    
6253        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6254    
6255        / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6256    
6257        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6258    
6259        / DB_INSTRUMENT SP pathname        / DB_INSTRUMENT SP db_path
6260    
6261     get_instruction =     get_instruction =
6262    
# Line 6148  Internet-Draft        LinuxSampler Contr Line 6264  Internet-Draft        LinuxSampler Contr
6264    
6265        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
6266    
       / MIDI_INPUT_DRIVER SP INFO SP string  
6267    
       / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string  
6268    
6269    
6270    
6271    Schoenebeck               Expires March 4, 2008               [Page 112]
6272    
6273    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6274    
6275    
6276  Schoenebeck             Expires November 25, 2007             [Page 110]        / MIDI_INPUT_DRIVER SP INFO SP string
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6277    
6278          / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6279    
6280        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6281        key_val_list        key_val_list
# Line 6204  Internet-Draft        LinuxSampler Contr Line 6320  Internet-Draft        LinuxSampler Contr
6320    
6321        / SERVER SP INFO        / SERVER SP INFO
6322    
       / TOTAL_VOICE_COUNT  
6323    
       / TOTAL_VOICE_COUNT_MAX  
6324    
6325    
6326    
6327    Schoenebeck               Expires March 4, 2008               [Page 113]
6328    
6329    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6330    
6331    
6332  Schoenebeck             Expires November 25, 2007             [Page 111]        / TOTAL_VOICE_COUNT
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6333    
6334          / TOTAL_VOICE_COUNT_MAX
6335    
6336        / MIDI_INSTRUMENTS SP midi_map        / MIDI_INSTRUMENTS SP midi_map
6337    
# Line 6231  Internet-Draft        LinuxSampler Contr Line 6347  Internet-Draft        LinuxSampler Contr
6347    
6348        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6349    
6350        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6351    
6352        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP db_path
6353    
6354        / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname        / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6355    
6356        / DB_INSTRUMENTS SP RECURSIVE SP pathname        / DB_INSTRUMENTS SP RECURSIVE SP db_path
6357    
6358        / DB_INSTRUMENTS SP pathname        / DB_INSTRUMENTS SP db_path
6359    
6360        / DB_INSTRUMENT SP INFO SP pathname        / DB_INSTRUMENT SP INFO SP db_path
6361    
6362        / DB_INSTRUMENTS_JOB SP INFO SP number        / DB_INSTRUMENTS_JOB SP INFO SP number
6363    
# Line 6258  Internet-Draft        LinuxSampler Contr Line 6374  Internet-Draft        LinuxSampler Contr
6374        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6375        param_val_list        param_val_list
6376    
6377        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
       param_val_list  
6378    
       / CHANNEL SP set_chan_instruction  
   
       / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name  
6379    
6380    
6381    
6382    
6383  Schoenebeck             Expires November 25, 2007             [Page 112]  Schoenebeck               Expires March 4, 2008               [Page 114]
6384    
6385  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6386    
6387    
6388          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6389          param_val_list
6390    
6391          / CHANNEL SP set_chan_instruction
6392    
6393          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6394    
6395        / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name        / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6396    
6397        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
# Line 6284  Internet-Draft        LinuxSampler Contr Line 6403  Internet-Draft        LinuxSampler Contr
6403        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6404        volume_value        volume_value
6405    
6406        / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6407    
6408        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6409          stringval_escaped
6410    
6411        / DB_INSTRUMENT SP NAME SP pathname SP dirname        / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6412    
6413        / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6414    
6415        / ECHO SP boolean        / ECHO SP boolean
6416    
# Line 6312  Internet-Draft        LinuxSampler Contr Line 6432  Internet-Draft        LinuxSampler Contr
6432    
6433     reset_instruction =     reset_instruction =
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck               Expires March 4, 2008               [Page 115]
6440    
6441    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6442    
6443    
6444        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
6445    
6446     clear_instruction =     clear_instruction =
# Line 6322  Internet-Draft        LinuxSampler Contr Line 6451  Internet-Draft        LinuxSampler Contr
6451    
6452     find_instruction =     find_instruction =
6453    
6454          DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6455    
6456          / DB_INSTRUMENTS SP db_path SP query_val_list
6457    
6458  Schoenebeck             Expires November 25, 2007             [Page 113]        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
       DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list  
   
       / DB_INSTRUMENTS SP pathname SP query_val_list  
   
       / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP  
6459        query_val_list        query_val_list
6460    
6461        / DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6462    
6463     move_instruction =     move_instruction =
6464    
6465        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6466    
6467        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6468    
6469     copy_instruction =     copy_instruction =
6470    
6471        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6472    
6473        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6474    
6475     destroy_instruction =     destroy_instruction =
6476    
# Line 6366  Internet-Draft        LinuxSampler Contr Line 6488  Internet-Draft        LinuxSampler Contr
6488    
6489     set_chan_instruction =     set_chan_instruction =
6490    
       AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index  
6491    
       / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index  
       SP audio_channel_index  
6492    
       / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name  
6493    
       / MIDI_INPUT SP sampler_channel SP device_index SP  
       midi_input_port_index SP midi_input_channel_index  
6494    
6495    Schoenebeck               Expires March 4, 2008               [Page 116]
6496    
6497    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6498    
6499    
6500          AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6501    
6502          / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
6503          SP audio_channel_index
6504    
6505  Schoenebeck             Expires November 25, 2007             [Page 114]        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6506    
6507          / MIDI_INPUT SP sampler_channel SP device_index SP
6508          midi_input_port_index SP midi_input_channel_index
6509    
6510        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
6511    
# Line 6406  Internet-Draft        LinuxSampler Contr Line 6528  Internet-Draft        LinuxSampler Contr
6528    
6529        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6530    
6531       edit_instruction =
6532    
6533          INSTRUMENT SP sampler_channel
6534    
6535       format_instruction =
6536    
6537          INSTRUMENTS_DB
6538    
6539     modal_arg =     modal_arg =
6540    
6541        /* epsilon (empty argument) */        /* epsilon (empty argument) */
# Line 6414  Internet-Draft        LinuxSampler Contr Line 6544  Internet-Draft        LinuxSampler Contr
6544    
6545     key_val_list =     key_val_list =
6546    
6547    
6548    
6549    
6550    
6551    Schoenebeck               Expires March 4, 2008               [Page 117]
6552    
6553    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6554    
6555    
6556        string '=' param_val_list        string '=' param_val_list
6557    
6558        / key_val_list SP string '=' param_val_list        / key_val_list SP string '=' param_val_list
# Line 6432  Internet-Draft        LinuxSampler Contr Line 6571  Internet-Draft        LinuxSampler Contr
6571    
6572        / CHANNELS        / CHANNELS
6573    
   
   
   
   
 Schoenebeck             Expires November 25, 2007             [Page 115]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
6574        / AVAILABLE_ENGINES        / AVAILABLE_ENGINES
6575    
6576        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
# Line 6455  Internet-Draft        LinuxSampler Contr Line 6585  Internet-Draft        LinuxSampler Contr
6585    
6586        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6587    
6588        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6589    
6590        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP db_path
6591    
6592        / DB_INSTRUMENTS SP RECURSIVE SP pathname        / DB_INSTRUMENTS SP RECURSIVE SP db_path
6593    
6594        / DB_INSTRUMENTS SP pathname        / DB_INSTRUMENTS SP db_path
6595    
6596     load_instr_args =     load_instr_args =
6597    
# Line 6471  Internet-Draft        LinuxSampler Contr Line 6601  Internet-Draft        LinuxSampler Contr
6601    
6602     load_engine_args =     load_engine_args =
6603    
6604    
6605    
6606    
6607    Schoenebeck               Expires March 4, 2008               [Page 118]
6608    
6609    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6610    
6611    
6612        engine_name SP sampler_channel        engine_name SP sampler_channel
6613    
6614     instr_load_mode =     instr_load_mode =
# Line 6489  Internet-Draft        LinuxSampler Contr Line 6627  Internet-Draft        LinuxSampler Contr
6627    
6628        number        number
6629    
   
   
   
 Schoenebeck             Expires November 25, 2007             [Page 116]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
6630     audio_output_type_name =     audio_output_type_name =
6631    
6632        string        string
# Line 6527  Internet-Draft        LinuxSampler Contr Line 6657  Internet-Draft        LinuxSampler Contr
6657    
6658        number        number
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires March 4, 2008               [Page 119]
6664    
6665    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6666    
6667    
6668     midi_ctrl =     midi_ctrl =
6669    
6670        number        number
# Line 6545  Internet-Draft        LinuxSampler Contr Line 6683  Internet-Draft        LinuxSampler Contr
6683    
6684        number        number
6685    
   
   
   
 Schoenebeck             Expires November 25, 2007             [Page 117]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
6686     fx_send_id =     fx_send_id =
6687    
6688        number        number
# Line 6561  Internet-Draft        LinuxSampler Contr Line 6691  Internet-Draft        LinuxSampler Contr
6691    
6692        string        string
6693    
6694     pathname =     filename =
   
       stringval  
6695    
6696     dirname =        path
6697    
6698        stringval     db_path =
6699    
6700     filename =        path
   
       stringval  
6701    
6702     map_name =     map_name =
6703    
# Line 6587  Internet-Draft        LinuxSampler Contr Line 6713  Internet-Draft        LinuxSampler Contr
6713    
6714     param_val_list =     param_val_list =
6715    
6716    
6717    
6718    
6719    Schoenebeck               Expires March 4, 2008               [Page 120]
6720    
6721    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6722    
6723    
6724        param_val        param_val
6725    
6726        / param_val_list','param_val        / param_val_list','param_val
# Line 6601  Internet-Draft        LinuxSampler Contr Line 6735  Internet-Draft        LinuxSampler Contr
6735    
6736        / dotnum        / dotnum
6737    
   
   
   
 Schoenebeck             Expires November 25, 2007             [Page 118]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
6738     query_val_list =     query_val_list =
6739    
6740        string '=' query_val        string '=' query_val
# Line 6617  Internet-Draft        LinuxSampler Contr Line 6743  Internet-Draft        LinuxSampler Contr
6743    
6744     query_val =     query_val =
6745    
6746        string        textval_escaped
6747    
6748        / stringval        / stringval_escaped
6749    
6750     scan_mode =     scan_mode =
6751    
# Line 6629  Internet-Draft        LinuxSampler Contr Line 6755  Internet-Draft        LinuxSampler Contr
6755    
6756        / FLAT        / FLAT
6757    
6758    7.1.  Character Set and Escape Sequences
6759    
6760       Older versions of this protocol up to and including v1.1 only
6761       supported the standard ASCII character set (ASCII code 0 - 127)
6762       [RFC20], all younger versions of this protocol however support the
6763       Extended ASCII character set (ASCII code 0 - 255).  The same group of
6764       younger protocols also support escape sequences, but only for
6765       certain, explicitly declared parts of the protocol.  The supported
6766       escape sequences are defined as follows:
6767    
6768    
6769    
# Line 6638  Internet-Draft        LinuxSampler Contr Line 6772  Internet-Draft        LinuxSampler Contr
6772    
6773    
6774    
6775    Schoenebeck               Expires March 4, 2008               [Page 121]
6776    
6777    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6778    
6779    
6780       +------------------------+------------------------------------------+
6781       | ASCII Character        | Translated into (Name)                   |
6782       | Sequence               |                                          |
6783       +------------------------+------------------------------------------+
6784       | \n                     | new line                                 |
6785       |                        |                                          |
6786       | \r                     | carriage return                          |
6787       |                        |                                          |
6788       | \f                     | form feed                                |
6789       |                        |                                          |
6790       | \t                     | horizontal tab                           |
6791       |                        |                                          |
6792       | \v                     | vertical tab                             |
6793       |                        |                                          |
6794       | \'                     | apostrophe                               |
6795       |                        |                                          |
6796       | \"                     | quotation mark                           |
6797       |                        |                                          |
6798       | \\                     | backslash                                |
6799       |                        |                                          |
6800       | \OOO                   | three digit octal ASCII code of the      |
6801       |                        | character                                |
6802       |                        |                                          |
6803       | \xHH                   | two digit hex ASCII code of the          |
6804       |                        | character                                |
6805       +------------------------+------------------------------------------+
6806    
6807       Notice: due to the transition of certain parts of the protocol which
6808       now support escape sequences, a slight backward incompatibility to
6809       protocols version v1.1 and younger has been introduced.  The only
6810       difference is that in parts of the protocol where escape characters
6811       are now supported, a backslash characters MUST be escaped as well
6812       (that is as double backslash), whereas in the old versions a single
6813       backslash was sufficient.
6814    
6815    
6816    
# Line 6658  Internet-Draft        LinuxSampler Contr Line 6828  Internet-Draft        LinuxSampler Contr
6828    
6829    
6830    
6831    Schoenebeck               Expires March 4, 2008               [Page 122]
   
 Schoenebeck             Expires November 25, 2007             [Page 119]  
6832    
6833  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6834    
6835    
6836  8.  Events  8.  Events
# Line 6716  Internet-Draft        LinuxSampler Contr Line 6884  Internet-Draft        LinuxSampler Contr
6884    
6885    
6886    
6887  Schoenebeck             Expires November 25, 2007             [Page 120]  Schoenebeck               Expires March 4, 2008               [Page 123]
6888    
6889  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6890    
6891    
6892        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 6772  Internet-Draft        LinuxSampler Contr Line 6940  Internet-Draft        LinuxSampler Contr
6940    
6941    
6942    
6943  Schoenebeck             Expires November 25, 2007             [Page 121]  Schoenebeck               Expires March 4, 2008               [Page 124]
6944    
6945  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6946    
6947    
6948        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
# Line 6828  Internet-Draft        LinuxSampler Contr Line 6996  Internet-Draft        LinuxSampler Contr
6996    
6997    
6998    
6999  Schoenebeck             Expires November 25, 2007             [Page 122]  Schoenebeck               Expires March 4, 2008               [Page 125]
7000    
7001  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7002    
7003    
7004        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 6884  Internet-Draft        LinuxSampler Contr Line 7052  Internet-Draft        LinuxSampler Contr
7052    
7053    
7054    
7055  Schoenebeck             Expires November 25, 2007             [Page 123]  Schoenebeck               Expires March 4, 2008               [Page 126]
7056    
7057  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7058    
7059    
7060        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
# Line 6940  Internet-Draft        LinuxSampler Contr Line 7108  Internet-Draft        LinuxSampler Contr
7108    
7109    
7110    
7111  Schoenebeck             Expires November 25, 2007             [Page 124]  Schoenebeck               Expires March 4, 2008               [Page 127]
7112    
7113  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7114    
7115    
7116        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
# Line 6996  Internet-Draft        LinuxSampler Contr Line 7164  Internet-Draft        LinuxSampler Contr
7164    
7165    
7166    
7167  Schoenebeck             Expires November 25, 2007             [Page 125]  Schoenebeck               Expires March 4, 2008               [Page 128]
7168    
7169  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7170    
7171    
7172  8.18.  Number of database instrument directories changed  8.18.  Number of database instrument directories changed
# Line 7052  Internet-Draft        LinuxSampler Contr Line 7220  Internet-Draft        LinuxSampler Contr
7220    
7221    
7222    
7223  Schoenebeck             Expires November 25, 2007             [Page 126]  Schoenebeck               Expires March 4, 2008               [Page 129]
7224    
7225  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7226    
7227    
7228  8.20.  Number of database instruments changed  8.20.  Number of database instruments changed
# Line 7108  Internet-Draft        LinuxSampler Contr Line 7276  Internet-Draft        LinuxSampler Contr
7276    
7277    
7278    
7279  Schoenebeck             Expires November 25, 2007             [Page 127]  Schoenebeck               Expires March 4, 2008               [Page 130]
7280    
7281  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7282    
7283    
7284  8.22.  Database job status information changed  8.22.  Database job status information changed
# Line 7164  Internet-Draft        LinuxSampler Contr Line 7332  Internet-Draft        LinuxSampler Contr
7332    
7333    
7334    
7335  Schoenebeck             Expires November 25, 2007             [Page 128]  Schoenebeck               Expires March 4, 2008               [Page 131]
7336    
7337  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7338    
7339    
7340  9.  Security Considerations  9.  Security Considerations
# Line 7220  Internet-Draft        LinuxSampler Contr Line 7388  Internet-Draft        LinuxSampler Contr
7388    
7389    
7390    
7391  Schoenebeck             Expires November 25, 2007             [Page 129]  Schoenebeck               Expires March 4, 2008               [Page 132]
7392    
7393  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7394    
7395    
7396  10.  Acknowledgments  10.  Acknowledgments
# Line 7276  Internet-Draft        LinuxSampler Contr Line 7444  Internet-Draft        LinuxSampler Contr
7444    
7445    
7446    
7447  Schoenebeck             Expires November 25, 2007             [Page 130]  Schoenebeck               Expires March 4, 2008               [Page 133]
7448    
7449  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7450    
7451    
7452  11.  References  11.  References
7453    
7454       [RFC20]    UCLA, "ASCII format for Network Interchange", RFC 20,
7455                  1969.
7456    
7457     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
7458                Requirement Levels", RFC 2119, 1997.                Requirement Levels", RFC 2119, 1997.
7459    
# Line 7329  Internet-Draft        LinuxSampler Contr Line 7500  Internet-Draft        LinuxSampler Contr
7500    
7501    
7502    
7503    Schoenebeck               Expires March 4, 2008               [Page 134]
   
   
 Schoenebeck             Expires November 25, 2007             [Page 131]  
7504    
7505  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7506    
7507    
7508  Author's Address  Author's Address
# Line 7388  Author's Address Line 7556  Author's Address
7556    
7557    
7558    
7559  Schoenebeck             Expires November 25, 2007             [Page 132]  Schoenebeck               Expires March 4, 2008               [Page 135]
7560    
7561  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7562    
7563    
7564  Full Copyright Statement  Full Copyright Statement
# Line 7444  Acknowledgment Line 7612  Acknowledgment
7612    
7613    
7614    
7615  Schoenebeck             Expires November 25, 2007             [Page 133]  Schoenebeck               Expires March 4, 2008               [Page 136]
7616    
7617    
Legend:
Removed from v.1201  
changed lines
  Added in v.1363
  ViewVC Help
Powered by ViewVC