/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1251 by schoenebeck, Fri Jun 22 14:24:57 2007 UTC revision 1572 by schoenebeck, Fri Dec 7 01:07:11 2007 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: December 24, 2007                                 June 22, 2007  Expires: June 7, 2008                                   December 5, 2007
8    
9    
10                   LinuxSampler Control Protocol (draft)                       LinuxSampler Control Protocol
11                                LSCP 1.2cvs                                  LSCP 1.3
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 December 24, 2007.     This Internet-Draft will expire on June 7, 2008.
37    
38  Copyright Notice  Copyright Notice
39    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck             Expires December 24, 2007               [Page 1]  Schoenebeck               Expires June 7, 2008                  [Page 1]
56    
57  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck             Expires December 24, 2007               [Page 2]  Schoenebeck               Expires June 7, 2008                  [Page 2]
112    
113  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 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 124  Internet-Draft    LinuxSampler Control P Line 124  Internet-Draft    LinuxSampler Control P
124         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
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  . . . . . .  46
128         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  46         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47
130         6.4.7.  Getting amount of available engines . . . . . . . . .  47         6.4.7.  Getting amount of available engines . . . . . . . . .  48
131         6.4.8.  Getting all available engines . . . . . . . . . . . .  48         6.4.8.  Getting all available engines . . . . . . . . . . . .  48
132         6.4.9.  Getting information about an engine . . . . . . . . .  48         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information . . . . . . . . .  49         6.4.10. Getting sampler channel information . . . . . . . . .  49
134         6.4.11. Current number of active voices . . . . . . . . . . .  52         6.4.11. Current number of active voices . . . . . . . . . . .  52
135         6.4.12. Current number of active disk streams . . . . . . . .  52         6.4.12. Current number of active disk streams . . . . . . . .  53
136         6.4.13. Current fill state of disk stream buffers . . . . . .  53         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device . . . . . . . . . . . . .  54         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55
139         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55         6.4.16. Setting audio output channel  . . . . . . . . . . . .  56
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 . . . . . . . . . . . . . .  61
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
149         6.4.25. Adding an effect send to a sampler channel  . . . . .  62         6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150         6.4.26. Removing an effect send from a sampler channel  . . .  63         6.4.26. Removing an effect send from a sampler channel  . . .  64
151         6.4.27. Getting amount of effect sends on a sampler channel .  64         6.4.27. Getting amount of effect sends on a sampler channel .  64
152         6.4.28. Listing all effect sends on a sampler channel . . . .  64         6.4.28. Listing all effect sends on a sampler channel . . . .  65
153         6.4.29. Getting effect send information . . . . . . . . . . .  65         6.4.29. Getting effect send information . . . . . . . . . . .  65
154         6.4.30. Changing effect send's name . . . . . . . . . . . . .  66         6.4.30. Changing effect send's name . . . . . . . . . . . . .  67
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 . . . . . . . . . .  69         6.4.33. Altering effect send's send level . . . . . . . . . .  69
158         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70
159       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  71
160         6.5.1.  Register front-end for receiving event messages . . .  70         6.5.1.  Register front-end for receiving event messages . . .  71
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  . . . . . . . . .  72         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  72
164    
165    
166    
167  Schoenebeck             Expires December 24, 2007               [Page 3]  Schoenebeck               Expires June 7, 2008                  [Page 3]
168    
169  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
170    
171    
172         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72         6.5.4.  Close client connection . . . . . . . . . . . . . . .  73
173       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  73
174         6.6.1.  Current number of active voices . . . . . . . . . . .  73         6.6.1.  Current number of active voices . . . . . . . . . . .  73
175         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73
176         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73         6.6.3.  Current number of active disk streams . . . . . . . .  74
177         6.6.4.  General sampler informations  . . . . . . . . . . . .  73         6.6.4.  Reset sampler . . . . . . . . . . . . . . . . . . . .  74
178         6.6.5.  Getting global volume attenuation . . . . . . . . . .  74         6.6.5.  General sampler informations  . . . . . . . . . . . .  74
179         6.6.6.  Setting global volume attenuation . . . . . . . . . .  75         6.6.6.  Getting global volume attenuation . . . . . . . . . .  75
180       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75         6.6.7.  Setting global volume attenuation . . . . . . . . . .  75
181         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  76
182           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  77
183         6.7.2.  Delete one particular or all MIDI instrument maps . .  77         6.7.2.  Delete one particular or all MIDI instrument maps . .  77
184         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  78
185         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78
186         6.7.5.  Getting MIDI instrument map information . . . . . . .  78         6.7.5.  Getting MIDI instrument map information . . . . . . .  79
187         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  80
188         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80
189         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  83
190         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
191                 instrument map  . . . . . . . . . . . . . . . . . . .  83                 instrument map  . . . . . . . . . . . . . . . . . . .  84
192         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84
193         6.7.11. Get current settings of MIDI instrument map entry . .  84         6.7.11. Get current settings of MIDI instrument map entry . .  85
194         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  87
195       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  88
196         6.8.1.  Creating a new instrument directory . . . . . . . . .  87         6.8.1.  Creating a new instrument directory . . . . . . . . .  88
197         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88
198         6.8.3.  Getting amount of instrument directories  . . . . . .  88         6.8.3.  Getting amount of instrument directories  . . . . . .  89
199         6.8.4.  Listing all directories in specific directory . . . .  89         6.8.4.  Listing all directories in specific directory . . . .  90
200         6.8.5.  Getting instrument directory information  . . . . . .  89         6.8.5.  Getting instrument directory information  . . . . . .  90
201         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91
202         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  92
203         6.8.8.  Copying instrument directories  . . . . . . . . . . .  92         6.8.8.  Copying instrument directories  . . . . . . . . . . .  93
204         6.8.9.  Changing the description of directory . . . . . . . .  92         6.8.9.  Changing the description of directory . . . . . . . .  93
205         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  94
206         6.8.11. Adding instruments to the instruments database  . . .  94         6.8.11. Adding instruments to the instruments database  . . .  95
207         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  97
208         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96         6.8.13. Getting amount of instruments . . . . . . . . . . . .  97
209         6.8.14. Listing all instruments in specific directory . . . .  97         6.8.14. Listing all instruments in specific directory . . . .  98
210         6.8.15. Getting instrument information  . . . . . . . . . . .  97         6.8.15. Getting instrument information  . . . . . . . . . . .  99
211         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 101
212         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 100         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 102
213         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 101         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102
214         6.8.19. Changing the description of instrument  . . . . . . . 102         6.8.19. Changing the description of instrument  . . . . . . . 103
215         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103
216         6.8.21. Getting job status information  . . . . . . . . . . . 104         6.8.21. Getting job status information  . . . . . . . . . . . 106
217     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 106         6.8.22. Formatting the instruments database . . . . . . . . . 107
218       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 119       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107
219     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 121         6.9.1.  Opening an appropriate instrument editor
220       8.1.  Number of audio output devices changed  . . . . . . . . . 121  
221    
222    
223    Schoenebeck               Expires June 7, 2008                  [Page 4]
224  Schoenebeck             Expires December 24, 2007               [Page 4]  
225    Internet-Draft        LinuxSampler Control Protocol        December 2007
226  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
227    
228                   application . . . . . . . . . . . . . . . . . . . . . 107
229       8.2.  Audio output device's settings changed  . . . . . . . . . 121       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 108
230       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 121         6.10.1. Retrieving amount of instruments of a file  . . . . . 109
231       8.4.  MIDI input device's settings changed  . . . . . . . . . . 122         6.10.2. Retrieving all instruments of a file  . . . . . . . . 109
232       8.5.  Number of sampler channels changed  . . . . . . . . . . . 122         6.10.3. Retrieving informations about one instrument in a
233       8.6.  Number of active voices changed . . . . . . . . . . . . . 122                 file  . . . . . . . . . . . . . . . . . . . . . . . . 110
234       8.7.  Number of active disk streams changed . . . . . . . . . . 123     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 112
235       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 123       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 125
236       8.9.  Channel information changed . . . . . . . . . . . . . . . 123     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
237       8.10. Number of effect sends changed  . . . . . . . . . . . . . 124       8.1.  Number of audio output devices changed  . . . . . . . . . 130
238       8.11. Effect send information changed . . . . . . . . . . . . . 124       8.2.  Audio output device's settings changed  . . . . . . . . . 130
239       8.12. Total number of active voices changed . . . . . . . . . . 124       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 130
240       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 125       8.4.  MIDI input device's settings changed  . . . . . . . . . . 131
241       8.14. MIDI instrument map information changed . . . . . . . . . 125       8.5.  Number of sampler channels changed  . . . . . . . . . . . 131
242       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 125       8.6.  Number of active voices changed . . . . . . . . . . . . . 131
243       8.16. MIDI instrument information changed . . . . . . . . . . . 126       8.7.  Number of active disk streams changed . . . . . . . . . . 132
244       8.17. Global settings changed . . . . . . . . . . . . . . . . . 126       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 132
245       8.18. Number of database instrument directories changed . . . . 127       8.9.  Channel information changed . . . . . . . . . . . . . . . 132
246       8.19. Database instrument directory information changed . . . . 127       8.10. Number of effect sends changed  . . . . . . . . . . . . . 133
247       8.20. Number of database instruments changed  . . . . . . . . . 128       8.11. Effect send information changed . . . . . . . . . . . . . 133
248       8.21. Database instrument information changed . . . . . . . . . 128       8.12. Total number of active voices changed . . . . . . . . . . 133
249       8.22. Database job status information changed . . . . . . . . . 129       8.13. Total number of active disk streams changed . . . . . . . 134
250       8.23. Miscellaneous and debugging events  . . . . . . . . . . . 129       8.14. Number of MIDI instrument maps changed  . . . . . . . . . 134
251     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 130       8.15. MIDI instrument map information changed . . . . . . . . . 134
252     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 131       8.16. Number of MIDI instruments changed  . . . . . . . . . . . 135
253     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 132       8.17. MIDI instrument information changed . . . . . . . . . . . 135
254     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 133       8.18. Global settings changed . . . . . . . . . . . . . . . . . 136
255     Intellectual Property and Copyright Statements  . . . . . . . . . 134       8.19. Number of database instrument directories changed . . . . 136
256         8.20. Database instrument directory information changed . . . . 136
257         8.21. Number of database instruments changed  . . . . . . . . . 137
258         8.22. Database instrument information changed . . . . . . . . . 137
259         8.23. Database job status information changed . . . . . . . . . 138
260         8.24. Miscellaneous and debugging events  . . . . . . . . . . . 138
261       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 139
262       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 140
263       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 141
264       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 142
265       Intellectual Property and Copyright Statements  . . . . . . . . . 143
266    
267    
268    
# Line 267  Internet-Draft    LinuxSampler Control P Line 276  Internet-Draft    LinuxSampler Control P
276    
277    
278    
279    Schoenebeck               Expires June 7, 2008                  [Page 5]
280    
281    Internet-Draft        LinuxSampler Control Protocol        December 2007
   
   
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007               [Page 5]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft    LinuxSampler Control P Line 332  Internet-Draft    LinuxSampler Control P
332    
333    
334    
335  Schoenebeck             Expires December 24, 2007               [Page 6]  Schoenebeck               Expires June 7, 2008                  [Page 6]
336    
337  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 363  Internet-Draft    LinuxSampler Control P Line 363  Internet-Draft    LinuxSampler Control P
363         sampler's LSCP minor version.         sampler's LSCP minor version.
364    
365     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
366     frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get     frontend can use the "GET SERVER INFO" (Section 6.6.5) command to get
367     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
368    
369    
# Line 388  Internet-Draft    LinuxSampler Control P Line 388  Internet-Draft    LinuxSampler Control P
388    
389    
390    
391  Schoenebeck             Expires December 24, 2007               [Page 7]  Schoenebeck               Expires June 7, 2008                  [Page 7]
392    
393  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft    LinuxSampler Control P Line 444  Internet-Draft    LinuxSampler Control P
444    
445    
446    
447  Schoenebeck             Expires December 24, 2007               [Page 8]  Schoenebeck               Expires June 7, 2008                  [Page 8]
448    
449  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft    LinuxSampler Control P Line 500  Internet-Draft    LinuxSampler Control P
500    
501    
502    
503  Schoenebeck             Expires December 24, 2007               [Page 9]  Schoenebeck               Expires June 7, 2008                  [Page 9]
504    
505  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft    LinuxSampler Control P Line 556  Internet-Draft    LinuxSampler Control P
556    
557    
558    
559  Schoenebeck             Expires December 24, 2007              [Page 10]  Schoenebeck               Expires June 7, 2008                 [Page 10]
560    
561  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft    LinuxSampler Control P Line 612  Internet-Draft    LinuxSampler Control P
612    
613    
614    
615  Schoenebeck             Expires December 24, 2007              [Page 11]  Schoenebeck               Expires June 7, 2008                 [Page 11]
616    
617  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft    LinuxSampler Control P Line 668  Internet-Draft    LinuxSampler Control P
668    
669    
670    
671  Schoenebeck             Expires December 24, 2007              [Page 12]  Schoenebeck               Expires June 7, 2008                 [Page 12]
672    
673  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft    LinuxSampler Control P Line 724  Internet-Draft    LinuxSampler Control P
724    
725    
726    
727  Schoenebeck             Expires December 24, 2007              [Page 13]  Schoenebeck               Expires June 7, 2008                 [Page 13]
728    
729  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft    LinuxSampler Control P Line 780  Internet-Draft    LinuxSampler Control P
780    
781    
782    
783  Schoenebeck             Expires December 24, 2007              [Page 14]  Schoenebeck               Expires June 7, 2008                 [Page 14]
784    
785  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft    LinuxSampler Control P Line 836  Internet-Draft    LinuxSampler Control P
836    
837    
838    
839  Schoenebeck             Expires December 24, 2007              [Page 15]  Schoenebeck               Expires June 7, 2008                 [Page 15]
840    
841  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft    LinuxSampler Control P Line 892  Internet-Draft    LinuxSampler Control P
892    
893    
894    
895  Schoenebeck             Expires December 24, 2007              [Page 16]  Schoenebeck               Expires June 7, 2008                 [Page 16]
896    
897  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft    LinuxSampler Control P Line 948  Internet-Draft    LinuxSampler Control P
948    
949    
950    
951  Schoenebeck             Expires December 24, 2007              [Page 17]  Schoenebeck               Expires June 7, 2008                 [Page 17]
952    
953  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft    LinuxSampler Control P Line 1004  Internet-Draft    LinuxSampler Control P
1004    
1005    
1006    
1007  Schoenebeck             Expires December 24, 2007              [Page 18]  Schoenebeck               Expires June 7, 2008                 [Page 18]
1008    
1009  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft    LinuxSampler Control P Line 1060  Internet-Draft    LinuxSampler Control P
1060    
1061    
1062    
1063  Schoenebeck             Expires December 24, 2007              [Page 19]  Schoenebeck               Expires June 7, 2008                 [Page 19]
1064    
1065  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft    LinuxSampler Control P Line 1116  Internet-Draft    LinuxSampler Control P
1116    
1117    
1118    
1119  Schoenebeck             Expires December 24, 2007              [Page 20]  Schoenebeck               Expires June 7, 2008                 [Page 20]
1120    
1121  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft    LinuxSampler Control P Line 1172  Internet-Draft    LinuxSampler Control P
1172    
1173    
1174    
1175  Schoenebeck             Expires December 24, 2007              [Page 21]  Schoenebeck               Expires June 7, 2008                 [Page 21]
1176    
1177  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft    LinuxSampler Control P Line 1228  Internet-Draft    LinuxSampler Control P
1228    
1229    
1230    
1231  Schoenebeck             Expires December 24, 2007              [Page 22]  Schoenebeck               Expires June 7, 2008                 [Page 22]
1232    
1233  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft    LinuxSampler Control P Line 1284  Internet-Draft    LinuxSampler Control P
1284    
1285    
1286    
1287  Schoenebeck             Expires December 24, 2007              [Page 23]  Schoenebeck               Expires June 7, 2008                 [Page 23]
1288    
1289  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft    LinuxSampler Control P Line 1340  Internet-Draft    LinuxSampler Control P
1340    
1341    
1342    
1343  Schoenebeck             Expires December 24, 2007              [Page 24]  Schoenebeck               Expires June 7, 2008                 [Page 24]
1344    
1345  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft    LinuxSampler Control P Line 1396  Internet-Draft    LinuxSampler Control P
1396    
1397    
1398    
1399  Schoenebeck             Expires December 24, 2007              [Page 25]  Schoenebeck               Expires June 7, 2008                 [Page 25]
1400    
1401  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft    LinuxSampler Control P Line 1452  Internet-Draft    LinuxSampler Control P
1452    
1453    
1454    
1455  Schoenebeck             Expires December 24, 2007              [Page 26]  Schoenebeck               Expires June 7, 2008                 [Page 26]
1456    
1457  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft    LinuxSampler Control P Line 1508  Internet-Draft    LinuxSampler Control P
1508    
1509    
1510    
1511  Schoenebeck             Expires December 24, 2007              [Page 27]  Schoenebeck               Expires June 7, 2008                 [Page 27]
1512    
1513  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft    LinuxSampler Control P Line 1564  Internet-Draft    LinuxSampler Control P
1564    
1565    
1566    
1567  Schoenebeck             Expires December 24, 2007              [Page 28]  Schoenebeck               Expires June 7, 2008                 [Page 28]
1568    
1569  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft    LinuxSampler Control P Line 1620  Internet-Draft    LinuxSampler Control P
1620    
1621    
1622    
1623  Schoenebeck             Expires December 24, 2007              [Page 29]  Schoenebeck               Expires June 7, 2008                 [Page 29]
1624    
1625  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft    LinuxSampler Control P Line 1676  Internet-Draft    LinuxSampler Control P
1676    
1677    
1678    
1679  Schoenebeck             Expires December 24, 2007              [Page 30]  Schoenebeck               Expires June 7, 2008                 [Page 30]
1680    
1681  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft    LinuxSampler Control P Line 1732  Internet-Draft    LinuxSampler Control P
1732    
1733    
1734    
1735  Schoenebeck             Expires December 24, 2007              [Page 31]  Schoenebeck               Expires June 7, 2008                 [Page 31]
1736    
1737  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft    LinuxSampler Control P Line 1788  Internet-Draft    LinuxSampler Control P
1788    
1789    
1790    
1791  Schoenebeck             Expires December 24, 2007              [Page 32]  Schoenebeck               Expires June 7, 2008                 [Page 32]
1792    
1793  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft    LinuxSampler Control P Line 1844  Internet-Draft    LinuxSampler Control P
1844    
1845    
1846    
1847  Schoenebeck             Expires December 24, 2007              [Page 33]  Schoenebeck               Expires June 7, 2008                 [Page 33]
1848    
1849  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft    LinuxSampler Control P Line 1900  Internet-Draft    LinuxSampler Control P
1900    
1901    
1902    
1903  Schoenebeck             Expires December 24, 2007              [Page 34]  Schoenebeck               Expires June 7, 2008                 [Page 34]
1904    
1905  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft    LinuxSampler Control P Line 1956  Internet-Draft    LinuxSampler Control P
1956    
1957    
1958    
1959  Schoenebeck             Expires December 24, 2007              [Page 35]  Schoenebeck               Expires June 7, 2008                 [Page 35]
1960    
1961  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft    LinuxSampler Control P Line 2012  Internet-Draft    LinuxSampler Control P
2012    
2013    
2014    
2015  Schoenebeck             Expires December 24, 2007              [Page 36]  Schoenebeck               Expires June 7, 2008                 [Page 36]
2016    
2017  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft    LinuxSampler Control P Line 2068  Internet-Draft    LinuxSampler Control P
2068    
2069    
2070    
2071  Schoenebeck             Expires December 24, 2007              [Page 37]  Schoenebeck               Expires June 7, 2008                 [Page 37]
2072    
2073  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft    LinuxSampler Control P Line 2124  Internet-Draft    LinuxSampler Control P
2124    
2125    
2126    
2127  Schoenebeck             Expires December 24, 2007              [Page 38]  Schoenebeck               Expires June 7, 2008                 [Page 38]
2128    
2129  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft    LinuxSampler Control P Line 2180  Internet-Draft    LinuxSampler Control P
2180    
2181    
2182    
2183  Schoenebeck             Expires December 24, 2007              [Page 39]  Schoenebeck               Expires June 7, 2008                 [Page 39]
2184    
2185  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft    LinuxSampler Control P Line 2236  Internet-Draft    LinuxSampler Control P
2236    
2237    
2238    
2239  Schoenebeck             Expires December 24, 2007              [Page 40]  Schoenebeck               Expires June 7, 2008                 [Page 40]
2240    
2241  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft    LinuxSampler Control P Line 2292  Internet-Draft    LinuxSampler Control P
2292    
2293    
2294    
2295  Schoenebeck             Expires December 24, 2007              [Page 41]  Schoenebeck               Expires June 7, 2008                 [Page 41]
2296    
2297  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2328  Internet-Draft    LinuxSampler Control P Line 2328  Internet-Draft    LinuxSampler Control P
2328     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2329     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2330     MIDI port number, <key> by the name of the parameter to change and     MIDI port number, <key> by the name of the parameter to change and
2331     <value> by the new value for this parameter.     <value> by the new value for this parameter (encapsulated into
2332       apostrophes) or NONE (not encapsulated into apostrophes) for
2333       specifying no value for parameters allowing a list of values.
2334    
2335     Possible Answers:     Possible Answers:
2336    
# Line 2342  Internet-Draft    LinuxSampler Control P Line 2344  Internet-Draft    LinuxSampler Control P
2344           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2345           code and warning message           code and warning message
2346    
       "ERR:<error-code>:<error-message>" -  
2347    
2348    
2349    
2350    
2351    Schoenebeck               Expires June 7, 2008                 [Page 42]
2352    
2353    Internet-Draft        LinuxSampler Control Protocol        December 2007
2354    
 Schoenebeck             Expires December 24, 2007              [Page 42]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
2355    
2356          "ERR:<error-code>:<error-message>" -
2357    
2358           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2359           error message           error message
2360    
2361     Example:     Example:
2362    
2363          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2364    
2365          S: "OK"
2366    
2367          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2368    
2369          S: "OK"
2370    
2371  6.4.  Configuring sampler channels  6.4.  Configuring sampler channels
2372    
# Line 2393  Internet-Draft    LinuxSampler Control P Line 2401  Internet-Draft    LinuxSampler Control P
2401     (Section 6.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2402     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2403     such as making sure that the file could be read and it is of a proper     such as making sure that the file could be read and it is of a proper
    format and SHOULD return ERR and SHOULD not launch the background  
    process should any errors be detected at that point.  
2404    
    Possible Answers:  
2405    
       "OK" -  
2406    
2407    Schoenebeck               Expires June 7, 2008                 [Page 43]
2408    
2409    Internet-Draft        LinuxSampler Control Protocol        December 2007
2410    
2411    
2412       format and SHOULD return ERR and SHOULD not launch the background
2413       process should any errors be detected at that point.
2414    
2415  Schoenebeck             Expires December 24, 2007              [Page 43]     Possible Answers:
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
2416    
2417          "OK" -
2418    
2419           in case the instrument was successfully loaded           in case the instrument was successfully loaded
2420    
# Line 2424  Internet-Draft    LinuxSampler Control P Line 2431  Internet-Draft    LinuxSampler Control P
2431           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2432           error message           error message
2433    
2434     Example:     Example (Unix):
2435    
2436          C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
2437    
2438          S: OK
2439    
2440       Example (Windows):
2441    
2442          C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
2443    
2444          S: OK
2445    
2446  6.4.2.  Loading a sampler engine  6.4.2.  Loading a sampler engine
2447    
# Line 2442  Internet-Draft    LinuxSampler Control P Line 2457  Internet-Draft    LinuxSampler Control P
2457     be assigned to.  This command should be issued after adding a new     be assigned to.  This command should be issued after adding a new
2458     sampler channel and before any other control commands on the new     sampler channel and before any other control commands on the new
2459     sampler channel.  It can also be used to change the engine type of a     sampler channel.  It can also be used to change the engine type of a
2460    
2461    
2462    
2463    Schoenebeck               Expires June 7, 2008                 [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol        December 2007
2466    
2467    
2468     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
2469     force if a new engine instance should be created and assigned to the     force if a new engine instance should be created and assigned to the
2470     given sampler channel or if an already existing instance of that     given sampler channel or if an already existing instance of that
# Line 2457  Internet-Draft    LinuxSampler Control P Line 2480  Internet-Draft    LinuxSampler Control P
2480    
2481           in case the engine was deployed successfully, but there are           in case the engine was deployed successfully, but there are
2482           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 44]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2483           code and warning message           code and warning message
2484    
2485        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2495  Internet-Draft    LinuxSampler Control P Line 2510  Internet-Draft    LinuxSampler Control P
2510    
2511        S: "12"        S: "12"
2512    
2513    
2514    
2515    
2516    
2517    
2518    
2519    Schoenebeck               Expires June 7, 2008                 [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol        December 2007
2522    
2523    
2524  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2525    
2526     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
# Line 2512  Internet-Draft    LinuxSampler Control P Line 2538  Internet-Draft    LinuxSampler Control P
2538    
2539        C: "LIST CHANNELS"        C: "LIST CHANNELS"
2540    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 45]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2541        S: "0,1,2,3,4,5,6,9,10,11,15,20"        S: "0,1,2,3,4,5,6,9,10,11,15,20"
2542    
2543  6.4.5.  Adding a new sampler channel  6.4.5.  Adding a new sampler channel
# Line 2551  Internet-Draft    LinuxSampler Control P Line 2568  Internet-Draft    LinuxSampler Control P
2568    
2569        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck               Expires June 7, 2008                 [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol        December 2007
2578    
2579    
2580           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2581           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2582           code and warning message           code and warning message
# Line 2568  Internet-Draft    LinuxSampler Control P Line 2594  Internet-Draft    LinuxSampler Control P
2594    
2595     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
2596    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 46]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2597        REMOVE CHANNEL <sampler-channel>        REMOVE CHANNEL <sampler-channel>
2598    
2599     Where <sampler-channel> should be replaced by the number of the     Where <sampler-channel> should be replaced by the number of the
# Line 2605  Internet-Draft    LinuxSampler Control P Line 2622  Internet-Draft    LinuxSampler Control P
2622    
2623    
2624    
2625    
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck               Expires June 7, 2008                 [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol        December 2007
2634    
2635    
2636  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
2637    
2638     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
# Line 2623  Internet-Draft    LinuxSampler Control P Line 2651  Internet-Draft    LinuxSampler Control P
2651    
2652        S: "4"        S: "4"
2653    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 47]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2654  6.4.8.  Getting all available engines  6.4.8.  Getting all available engines
2655    
2656     The front-end can ask for a list of all available engines by sending     The front-end can ask for a list of all available engines by sending
# Line 2663  Internet-Draft    LinuxSampler Control P Line 2681  Internet-Draft    LinuxSampler Control P
2681     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2682     AVAILABLE_ENGINES" (Section 6.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2683    
2684    
2685    
2686    
2687    Schoenebeck               Expires June 7, 2008                 [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol        December 2007
2690    
2691    
2692     Possible Answers:     Possible Answers:
2693    
2694        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 2675  Internet-Draft    LinuxSampler Control P Line 2701  Internet-Draft    LinuxSampler Control P
2701    
2702           DESCRIPTION -           DESCRIPTION -
2703    
2704              arbitrary description text about the engine              arbitrary description text about the engine (note that the
2705                character string may contain escape sequences (Section 7.1))
2706    
2707           VERSION -           VERSION -
2708    
2709              arbitrary character string regarding the engine's version              arbitrary character string regarding the engine's version
2710    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 48]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2711     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2712    
2713     Example:     Example:
# Line 2718  Internet-Draft    LinuxSampler Control P Line 2737  Internet-Draft    LinuxSampler Control P
2737        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
2738        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
2739        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2740    
2741    
2742    
2743    Schoenebeck               Expires June 7, 2008                 [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol        December 2007
2746    
2747    
2748        following categories are defined:        following categories are defined:
2749    
2750    
# Line 2735  Internet-Draft    LinuxSampler Control P Line 2762  Internet-Draft    LinuxSampler Control P
2762              signal, "NONE" if there's no device connected to this              signal, "NONE" if there's no device connected to this
2763              sampler channel              sampler channel
2764    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 49]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2765           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2766    
2767              number of output channels the sampler channel offers              number of output channels the sampler channel offers
# Line 2762  Internet-Draft    LinuxSampler Control P Line 2779  Internet-Draft    LinuxSampler Control P
2779           INSTRUMENT_FILE -           INSTRUMENT_FILE -
2780    
2781              the file name of the loaded instrument, "NONE" if there's no              the file name of the loaded instrument, "NONE" if there's no
2782              instrument yet loaded for this sampler channel              instrument yet loaded for this sampler channel (note: since
2783                LSCP 1.2 this path may contain escape sequences
2784                (Section 7.1))
2785    
2786           INSTRUMENT_NR -           INSTRUMENT_NR -
2787    
# Line 2770  Internet-Draft    LinuxSampler Control P Line 2789  Internet-Draft    LinuxSampler Control P
2789    
2790           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2791    
2792              the instrument name of the loaded instrument              the instrument name of the loaded instrument (note: since
2793                LSCP 1.2 this character string may contain escape sequences
2794                (Section 7.1))
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires June 7, 2008                 [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol        December 2007
2802    
2803    
2804           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2805    
# Line 2792  Internet-Draft    LinuxSampler Control P Line 2821  Internet-Draft    LinuxSampler Control P
2821    
2822           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2823    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 50]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2824              the MIDI input channel number this sampler channel should              the MIDI input channel number this sampler channel should
2825              listen to or "ALL" to listen on all MIDI channels              listen to or "ALL" to listen on all MIDI channels
2826    
# Line 2830  Internet-Draft    LinuxSampler Control P Line 2850  Internet-Draft    LinuxSampler Control P
2850              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2851              values.              values.
2852    
2853    
2854    
2855    Schoenebeck               Expires June 7, 2008                 [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol        December 2007
2858    
2859    
2860     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2861    
2862     Example:     Example:
# Line 2848  Internet-Draft    LinuxSampler Control P Line 2875  Internet-Draft    LinuxSampler Control P
2875    
2876           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2877    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 51]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2878           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
2879    
2880           "INSTRUMENT_NAME: Fazioli Piano"           "INSTRUMENT_NAME: Fazioli Piano"
# Line 2887  Internet-Draft    LinuxSampler Control P Line 2905  Internet-Draft    LinuxSampler Control P
2905        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2906    
2907     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2908    
2909    
2910    
2911    Schoenebeck               Expires June 7, 2008                 [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol        December 2007
2914    
2915    
2916     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2917     "LIST CHANNELS" (Section 6.4.4) command.     "LIST CHANNELS" (Section 6.4.4) command.
2918    
# Line 2904  Internet-Draft    LinuxSampler Control P Line 2930  Internet-Draft    LinuxSampler Control P
2930     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
2931     on a sampler channel by sending the following command:     on a sampler channel by sending the following command:
2932    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 52]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2933        GET CHANNEL STREAM_COUNT <sampler-channel>        GET CHANNEL STREAM_COUNT <sampler-channel>
2934    
2935     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
# Line 2944  Internet-Draft    LinuxSampler Control P Line 2961  Internet-Draft    LinuxSampler Control P
2961     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
2962     sampler channel number the front-end is interested in as returned by     sampler channel number the front-end is interested in as returned by
2963     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2964    
2965    
2966    
2967    Schoenebeck               Expires June 7, 2008                 [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol        December 2007
2970    
2971    
2972     command.     command.
2973    
2974     Possible Answers:     Possible Answers:
# Line 2961  Internet-Draft    LinuxSampler Control P Line 2986  Internet-Draft    LinuxSampler Control P
2986    
2987     Examples:     Examples:
2988    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 53]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
2989        C: "GET CHANNEL BUFFER_FILL BYTES 4"        C: "GET CHANNEL BUFFER_FILL BYTES 4"
2990    
2991        S: "[115]420500,[116]510300,[75]110000,[120]230700"        S: "[115]420500,[116]510300,[75]110000,[120]230700"
# Line 2998  Internet-Draft    LinuxSampler Control P Line 3015  Internet-Draft    LinuxSampler Control P
3015    
3016     Possible Answers:     Possible Answers:
3017    
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck               Expires June 7, 2008                 [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol        December 2007
3026    
3027    
3028        "OK" -        "OK" -
3029    
3030           on success           on success
# Line 3017  Internet-Draft    LinuxSampler Control P Line 3044  Internet-Draft    LinuxSampler Control P
3044    
3045    
3046    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 54]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
   
   
3047  6.4.15.  Setting audio output type  6.4.15.  Setting audio output type
3048    
3049     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 3057  Internet-Draft    LinuxSampler Control P Line 3074  Internet-Draft    LinuxSampler Control P
3074           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3075           error message           error message
3076    
3077    
3078    
3079    Schoenebeck               Expires June 7, 2008                 [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol        December 2007
3082    
3083    
3084     Examples:     Examples:
3085    
3086    
# Line 3073  Internet-Draft    LinuxSampler Control P Line 3097  Internet-Draft    LinuxSampler Control P
3097     "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)
3098     command, <audio-out> is the numerical ID of the sampler channel's     command, <audio-out> is the numerical ID of the sampler channel's
3099     audio output channel which should be rerouted and <audio-in> is the     audio output channel which should be rerouted and <audio-in> is the
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 55]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3100     numerical ID of the audio channel of the selected audio output device     numerical ID of the audio channel of the selected audio output device
3101     where <audio-out> should be routed to.     where <audio-out> should be routed to.
3102    
# Line 3113  Internet-Draft    LinuxSampler Control P Line 3129  Internet-Draft    LinuxSampler Control P
3129        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3130    
3131     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
3132    
3133    
3134    
3135    Schoenebeck               Expires June 7, 2008                 [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol        December 2007
3138    
3139    
3140     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3141     command and <midi-device-id> is the numerical ID of the MIDI input     command and <midi-device-id> is the numerical ID of the MIDI input
3142     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)
# Line 3130  Internet-Draft    LinuxSampler Control P Line 3154  Internet-Draft    LinuxSampler Control P
3154           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3155           message           message
3156    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 56]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3157        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3158    
3159           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3168  Internet-Draft    LinuxSampler Control P Line 3185  Internet-Draft    LinuxSampler Control P
3185    
3186           if MIDI input type was set, but there are noteworthy issue(s)           if MIDI input type was set, but there are noteworthy issue(s)
3187           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3188    
3189    
3190    
3191    Schoenebeck               Expires June 7, 2008                 [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol        December 2007
3194    
3195    
3196           message           message
3197    
3198        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3184  Internet-Draft    LinuxSampler Control P Line 3209  Internet-Draft    LinuxSampler Control P
3209     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
3210     channel by sending the following command:     channel by sending the following command:
3211    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 57]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3212        SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>        SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>
3213    
3214     Where <midi-input-port> is a MIDI input port number of the MIDI input     Where <midi-input-port> is a MIDI input port number of the MIDI input
# Line 3224  Internet-Draft    LinuxSampler Control P Line 3240  Internet-Draft    LinuxSampler Control P
3240     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3241     listen to by sending the following command:     listen to by sending the following command:
3242    
3243    
3244    
3245    
3246    
3247    Schoenebeck               Expires June 7, 2008                 [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol        December 2007
3250    
3251    
3252        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3253    
3254     Where <midi-input-chan> is the number of the new MIDI input channel     Where <midi-input-chan> is the number of the new MIDI input channel
# Line 3242  Internet-Draft    LinuxSampler Control P Line 3267  Internet-Draft    LinuxSampler Control P
3267           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3268           warning message           warning message
3269    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 58]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3270        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3271    
3272           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3278  Internet-Draft    LinuxSampler Control P Line 3296  Internet-Draft    LinuxSampler Control P
3296    
3297        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3298    
3299    
3300    
3301    
3302    
3303    Schoenebeck               Expires June 7, 2008                 [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol        December 2007
3306    
3307    
3308           if channel volume was set, but there are noteworthy issue(s)           if channel volume was set, but there are noteworthy issue(s)
3309           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3310           message           message
# Line 3296  Internet-Draft    LinuxSampler Control P Line 3323  Internet-Draft    LinuxSampler Control P
3323     The front-end can mute/unmute a specific sampler channel by sending     The front-end can mute/unmute a specific sampler channel by sending
3324     the following command:     the following command:
3325    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 59]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3326        SET CHANNEL MUTE <sampler-channel> <mute>        SET CHANNEL MUTE <sampler-channel> <mute>
3327    
3328     Where <sampler-channel> is the respective sampler channel number as     Where <sampler-channel> is the respective sampler channel number as
# Line 3333  Internet-Draft    LinuxSampler Control P Line 3351  Internet-Draft    LinuxSampler Control P
3351    
3352    
3353    
3354    
3355    
3356    
3357    
3358    
3359    Schoenebeck               Expires June 7, 2008                 [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol        December 2007
3362    
3363    
3364  6.4.23.  Soloing a sampler channel  6.4.23.  Soloing a sampler channel
3365    
3366     The front-end can solo/unsolo a specific sampler channel by sending     The front-end can solo/unsolo a specific sampler channel by sending
# Line 3351  Internet-Draft    LinuxSampler Control P Line 3379  Internet-Draft    LinuxSampler Control P
3379    
3380           on success           on success
3381    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 60]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3382        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3383    
3384           if the channel was soloed/unsoloed, but there are noteworthy           if the channel was soloed/unsoloed, but there are noteworthy
# Line 3390  Internet-Draft    LinuxSampler Control P Line 3408  Internet-Draft    LinuxSampler Control P
3408    
3409        "NONE" -        "NONE" -
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires June 7, 2008                 [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol        December 2007
3418    
3419    
3420           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
3421           is not assigned any MIDI instrument map and thus will ignore           is not assigned any MIDI instrument map and thus will ignore
3422           all MIDI program change messages.           all MIDI program change messages.
# Line 3410  Internet-Draft    LinuxSampler Control P Line 3437  Internet-Draft    LinuxSampler Control P
3437     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3438     regarding MIDI instrument mapping.     regarding MIDI instrument mapping.
3439    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 61]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3440     Possible Answers:     Possible Answers:
3441    
3442        "OK" -        "OK" -
# Line 3445  Internet-Draft    LinuxSampler Control P Line 3465  Internet-Draft    LinuxSampler Control P
3465     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3466     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3467     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3468     effect send entity.  The name does not have to be unique.  
3469    
3470    
3471    Schoenebeck               Expires June 7, 2008                 [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol        December 2007
3474    
3475    
3476       effect send entity.  The name does not have to be unique, but MUST be
3477       encapsulated into apostrophes and supports escape sequences as
3478       described in chapter "Character Set and Escape Sequences
3479       (Section 7.1)".
3480    
3481     By default, that is as initial routing, the effect send's audio     By default, that is as initial routing, the effect send's audio
3482     channels are automatically routed to the last audio channels of the     channels are automatically routed to the last audio channels of the
# Line 3466  Internet-Draft    LinuxSampler Control P Line 3497  Internet-Draft    LinuxSampler Control P
3497     can mix its voices directly into the audio output devices's audio     can mix its voices directly into the audio output devices's audio
3498     buffers and is thus faster.     buffers and is thus faster.
3499    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 62]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3500     Possible Answers:     Possible Answers:
3501    
3502        "OK[<fx-send-id>]" -        "OK[<fx-send-id>]" -
# Line 3496  Internet-Draft    LinuxSampler Control P Line 3520  Internet-Draft    LinuxSampler Control P
3520    
3521        S: "OK[1]"        S: "OK[1]"
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck               Expires June 7, 2008                 [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol        December 2007
3530    
3531    
3532  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
3533    
3534     The front-end can remove an existing effect send on a specific     The front-end can remove an existing effect send on a specific
# Line 3521  Internet-Draft    LinuxSampler Control P Line 3554  Internet-Draft    LinuxSampler Control P
3554           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3555           error message           error message
3556    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 63]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3557     Example:     Example:
3558    
3559        C: "DESTROY FX_SEND 0 0"        C: "DESTROY FX_SEND 0 0"
# Line 3553  Internet-Draft    LinuxSampler Control P Line 3578  Internet-Draft    LinuxSampler Control P
3578    
3579     Example:     Example:
3580    
3581    
3582    
3583    Schoenebeck               Expires June 7, 2008                 [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol        December 2007
3586    
3587    
3588        C: "GET FX_SENDS 0"        C: "GET FX_SENDS 0"
3589    
3590        S: "2"        S: "2"
# Line 3575  Internet-Draft    LinuxSampler Control P Line 3607  Internet-Draft    LinuxSampler Control P
3607    
3608     Examples:     Examples:
3609    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 64]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3610        C: "LIST FX_SENDS 0"        C: "LIST FX_SENDS 0"
3611    
3612        S: "0,1"        S: "0,1"
# Line 3611  Internet-Draft    LinuxSampler Control P Line 3633  Internet-Draft    LinuxSampler Control P
3633        The sampler will answer by sending a <CRLF> separated list.  Each        The sampler will answer by sending a <CRLF> separated list.  Each
3634        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
3635        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
3636    
3637    
3638    
3639    Schoenebeck               Expires June 7, 2008                 [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol        December 2007
3642    
3643    
3644        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
3645        following categories are defined:        following categories are defined:
3646    
# Line 3618  Internet-Draft    LinuxSampler Control P Line 3648  Internet-Draft    LinuxSampler Control P
3648    
3649           NAME -           NAME -
3650    
3651              name of the effect send entity              name of the effect send entity (note that this character
3652                string may contain escape sequences (Section 7.1))
3653    
3654           MIDI_CONTROLLER -           MIDI_CONTROLLER -
3655    
# Line 3631  Internet-Draft    LinuxSampler Control P Line 3662  Internet-Draft    LinuxSampler Control P
3662              current send level (where a value < 1.0 means attenuation              current send level (where a value < 1.0 means attenuation
3663              and a value > 1.0 means amplification)              and a value > 1.0 means amplification)
3664    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 65]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3665           AUDIO_OUTPUT_ROUTING -           AUDIO_OUTPUT_ROUTING -
3666    
3667              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
# Line 3667  Internet-Draft    LinuxSampler Control P Line 3688  Internet-Draft    LinuxSampler Control P
3688    
3689           "."           "."
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires June 7, 2008                 [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol        December 2007
3698    
3699    
3700  6.4.30.  Changing effect send's name  6.4.30.  Changing effect send's name
3701    
3702     The front-end can alter the current name of an effect send entity by     The front-end can alter the current name of an effect send entity by
# Line 3679  Internet-Draft    LinuxSampler Control P Line 3709  Internet-Draft    LinuxSampler Control P
3709     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3710     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3711     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3712     effect send entity, which does not have to be unique.     effect send entity, which does not have to be unique (name MUST be
3713       encapsulated into apostrophes and supports escape sequences as
3714       described in chapter "Character Set and Escape Sequences
3715       (Section 7.1)").
3716    
3717     Possible Answers:     Possible Answers:
3718    
# Line 3687  Internet-Draft    LinuxSampler Control P Line 3720  Internet-Draft    LinuxSampler Control P
3720    
3721           on success           on success
3722    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 66]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3723        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3724    
3725           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3722  Internet-Draft    LinuxSampler Control P Line 3745  Internet-Draft    LinuxSampler Control P
3745     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3746     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3747     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3748    
3749    
3750    
3751    Schoenebeck               Expires June 7, 2008                 [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol        December 2007
3754    
3755    
3756     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
3757     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
3758     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.
# Line 3744  Internet-Draft    LinuxSampler Control P Line 3775  Internet-Draft    LinuxSampler Control P
3775    
3776           on success           on success
3777    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 67]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3778        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3779    
3780           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
# Line 3779  Internet-Draft    LinuxSampler Control P Line 3801  Internet-Draft    LinuxSampler Control P
3801        ctrl>        ctrl>
3802    
3803     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3804    
3805    
3806    
3807    Schoenebeck               Expires June 7, 2008                 [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol        December 2007
3810    
3811    
3812     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3813     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3814     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
# Line 3800  Internet-Draft    LinuxSampler Control P Line 3830  Internet-Draft    LinuxSampler Control P
3830    
3831        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3832    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 68]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3833           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3834           error message           error message
3835    
# Line 3836  Internet-Draft    LinuxSampler Control P Line 3857  Internet-Draft    LinuxSampler Control P
3857    
3858     Possible Answers:     Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires June 7, 2008                 [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol        December 2007
3866    
3867    
3868        "OK" -        "OK" -
3869    
3870           on success           on success
# Line 3857  Internet-Draft    LinuxSampler Control P Line 3886  Internet-Draft    LinuxSampler Control P
3886    
3887        S: "OK"        S: "OK"
3888    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 69]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3889  6.4.34.  Resetting a sampler channel  6.4.34.  Resetting a sampler channel
3890    
3891     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
# Line 3891  Internet-Draft    LinuxSampler Control P Line 3912  Internet-Draft    LinuxSampler Control P
3912    
3913        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3914    
3915    
3916    
3917    
3918    
3919    Schoenebeck               Expires June 7, 2008                 [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol        December 2007
3922    
3923    
3924           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3925           error message           error message
3926    
# Line 3913  Internet-Draft    LinuxSampler Control P Line 3943  Internet-Draft    LinuxSampler Control P
3943     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
3944     wants to subscribe to.     wants to subscribe to.
3945    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 70]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
3946     Possible Answers:     Possible Answers:
3947    
3948        "OK" -        "OK" -
# Line 3947  Internet-Draft    LinuxSampler Control P Line 3969  Internet-Draft    LinuxSampler Control P
3969     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
3970     event messages anymore by sending the following command:     event messages anymore by sending the following command:
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires June 7, 2008                 [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol        December 2007
3978    
3979    
3980        UNSUBSCRIBE <event-id>        UNSUBSCRIBE <event-id>
3981    
3982     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 3969  Internet-Draft    LinuxSampler Control P Line 3999  Internet-Draft    LinuxSampler Control P
3999           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4000           error message           error message
4001    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 71]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4002     Examples:     Examples:
4003    
4004    
# Line 4001  Internet-Draft    LinuxSampler Control P Line 4023  Internet-Draft    LinuxSampler Control P
4023    
4024           usually           usually
4025    
4026    
4027    
4028    
4029    
4030    
4031    Schoenebeck               Expires June 7, 2008                 [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol        December 2007
4034    
4035    
4036        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4037    
4038           on syntax error, e.g. non boolean value           on syntax error, e.g. non boolean value
# Line 4023  Internet-Draft    LinuxSampler Control P Line 4055  Internet-Draft    LinuxSampler Control P
4055    
4056     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
4057    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 72]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4058  6.6.1.  Current number of active voices  6.6.1.  Current number of active voices
4059    
4060     The front-end can ask for the current number of active voices on the     The front-end can ask for the current number of active voices on the
# Line 4057  Internet-Draft    LinuxSampler Control P Line 4079  Internet-Draft    LinuxSampler Control P
4079        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4080        voices.        voices.
4081    
4082  6.6.3.  Reset sampler  
4083    
4084    
4085    
4086    
4087    Schoenebeck               Expires June 7, 2008                 [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol        December 2007
4090    
4091    
4092    6.6.3.  Current number of active disk streams
4093    
4094       The front-end can ask for the current number of active disk streams
4095       on the sampler by sending the following command:
4096    
4097          GET TOTAL_STREAM_COUNT
4098    
4099       Possible Answers:
4100    
4101          LinuxSampler will answer by returning the number of all active
4102          disk streams on the sampler.
4103    
4104    6.6.4.  Reset sampler
4105    
4106     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
4107     command:     command:
# Line 4074  Internet-Draft    LinuxSampler Control P Line 4118  Internet-Draft    LinuxSampler Control P
4118    
4119    
4120    
4121  6.6.4.  General sampler informations  6.6.5.  General sampler informations
4122    
4123     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
4124     instance by sending the following command:     instance by sending the following command:
4125    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 73]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4126        GET SERVER INFO        GET SERVER INFO
4127    
4128     Possible Answers:     Possible Answers:
# Line 4103  Internet-Draft    LinuxSampler Control P Line 4137  Internet-Draft    LinuxSampler Control P
4137    
4138           DESCRIPTION -           DESCRIPTION -
4139    
4140              arbitrary textual description about the sampler  
4141    
4142    
4143    Schoenebeck               Expires June 7, 2008                 [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol        December 2007
4146    
4147    
4148                arbitrary textual description about the sampler (note that
4149                the character string may contain escape sequences
4150                (Section 7.1))
4151    
4152           VERSION -           VERSION -
4153    
# Line 4122  Internet-Draft    LinuxSampler Control P Line 4166  Internet-Draft    LinuxSampler Control P
4166     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4167     Other fields might be added in future.     Other fields might be added in future.
4168    
4169  6.6.5.  Getting global volume attenuation  6.6.6.  Getting global volume attenuation
4170    
4171     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
4172     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4137  Internet-Draft    LinuxSampler Control P Line 4181  Internet-Draft    LinuxSampler Control P
4181    
4182     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4183     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 74]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4184     this parameter.     this parameter.
4185    
4186  6.6.6.  Setting global volume attenuation  6.6.7.  Setting global volume attenuation
4187    
4188     The client can alter the current global sampler-wide volume     The client can alter the current global sampler-wide volume
4189     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4157  Internet-Draft    LinuxSampler Control P Line 4193  Internet-Draft    LinuxSampler Control P
4193     Where <volume> should be replaced by the optional dotted floating     Where <volume> should be replaced by the optional dotted floating
4194     point value, reflecting the new global volume parameter.  This value     point value, reflecting the new global volume parameter.  This value
4195     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
4196    
4197    
4198    
4199    Schoenebeck               Expires June 7, 2008                 [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol        December 2007
4202    
4203    
4204     attenuating the overall volume.     attenuating the overall volume.
4205    
4206     Possible Answers:     Possible Answers:
# Line 4193  Internet-Draft    LinuxSampler Control P Line 4237  Internet-Draft    LinuxSampler Control P
4237     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
4238     the map and tell the respective sampler channel(s) which MIDI     the map and tell the respective sampler channel(s) which MIDI
4239     instrument map to use, so the sampler knows how to react on a given     instrument map to use, so the sampler knows how to react on a given
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 75]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4240     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
4241     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
4242     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
# Line 4214  Internet-Draft    LinuxSampler Control P Line 4250  Internet-Draft    LinuxSampler Control P
4250     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4251     current MIDI instrument map.     current MIDI instrument map.
4252    
4253    
4254    
4255    Schoenebeck               Expires June 7, 2008                 [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol        December 2007
4258    
4259    
4260  6.7.1.  Create a new MIDI instrument map  6.7.1.  Create a new MIDI instrument map
4261    
4262     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 4222  Internet-Draft    LinuxSampler Control P Line 4265  Internet-Draft    LinuxSampler Control P
4265        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4266    
4267     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
4268     to the new map.  MIDI instrument Map names do not have to be unique.     to the new map.  MIDI instrument Map names do not have to be unique,
4269       but MUST be encapsulated into apostrophes and support escape
4270       sequences as described in chapter "Character Set and Escape Sequences
4271       (Section 7.1)".
4272    
4273     Possible Answers:     Possible Answers:
4274    
# Line 4248  Internet-Draft    LinuxSampler Control P Line 4294  Internet-Draft    LinuxSampler Control P
4294    
4295        C: "ADD MIDI_INSTRUMENT_MAP"        C: "ADD MIDI_INSTRUMENT_MAP"
4296    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 76]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4297        S: "OK[5]"        S: "OK[5]"
4298    
4299  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
# Line 4269  Internet-Draft    LinuxSampler Control P Line 4306  Internet-Draft    LinuxSampler Control P
4306     Where <map> reflects the unique ID of the map to delete as returned     Where <map> reflects the unique ID of the map to delete as returned
4307     by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.     by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4308    
4309    
4310    
4311    Schoenebeck               Expires June 7, 2008                 [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol        December 2007
4314    
4315    
4316     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4317     following command:     following command:
4318    
# Line 4303  Internet-Draft    LinuxSampler Control P Line 4347  Internet-Draft    LinuxSampler Control P
4347    
4348     Possible Answers:     Possible Answers:
4349    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 77]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4350        The sampler will answer by returning the current number of MIDI        The sampler will answer by returning the current number of MIDI
4351        instrument maps.        instrument maps.
4352    
# Line 4328  Internet-Draft    LinuxSampler Control P Line 4362  Internet-Draft    LinuxSampler Control P
4362     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4363     following command:     following command:
4364    
4365    
4366    
4367    Schoenebeck               Expires June 7, 2008                 [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol        December 2007
4370    
4371    
4372        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4373    
4374     Possible Answers:     Possible Answers:
# Line 4362  Internet-Draft    LinuxSampler Control P Line 4403  Internet-Draft    LinuxSampler Control P
4403    
4404    
4405    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 78]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
   
   
4406           NAME -           NAME -
4407    
4408              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
4409              unique              unique (note that this character string may contain escape
4410                sequences (Section 7.1))
4411    
4412           DEFAULT -           DEFAULT -
4413    
# Line 4385  Internet-Draft    LinuxSampler Control P Line 4418  Internet-Draft    LinuxSampler Control P
4418    
4419     Example:     Example:
4420    
4421    
4422    
4423    Schoenebeck               Expires June 7, 2008                 [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol        December 2007
4426    
4427    
4428        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4429    
4430        S: "NAME: Standard Map"        S: "NAME: Standard Map"
# Line 4401  Internet-Draft    LinuxSampler Control P Line 4441  Internet-Draft    LinuxSampler Control P
4441        SET MIDI_INSTRUMENT_MAP NAME <map> <name>        SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4442    
4443     Where <map> is the numerical ID of the map and <name> the new custom     Where <map> is the numerical ID of the map and <name> the new custom
4444     name of the map, which does not have to be unique.     name of the map, which does not have to be unique (name MUST be
4445       encapsulated into apostrophes and supports escape sequences as
4446       described in chapter "Character Set and Escape Sequences
4447       (Section 7.1)").
4448    
4449     Possible Answers:     Possible Answers:
4450    
# Line 4415  Internet-Draft    LinuxSampler Control P Line 4458  Internet-Draft    LinuxSampler Control P
4458    
4459     Example:     Example:
4460    
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 79]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4461        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4462    
4463        S: "OK"        S: "OK"
# Line 4440  Internet-Draft    LinuxSampler Control P Line 4473  Internet-Draft    LinuxSampler Control P
4473    
4474     Where <map> is the numeric ID of the map to alter, <midi_bank> is an     Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4475     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
4476    
4477    
4478    
4479    Schoenebeck               Expires June 7, 2008                 [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol        December 2007
4482    
4483    
4484     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4485     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4486     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
# Line 4474  Internet-Draft    LinuxSampler Control P Line 4515  Internet-Draft    LinuxSampler Control P
4515           instrument) are explicitly changed to "ON_DEMAND" and no           instrument) are explicitly changed to "ON_DEMAND" and no
4516           sampler channel is using the instrument anymore.           sampler channel is using the instrument anymore.
4517    
   
   
 Schoenebeck             Expires December 24, 2007              [Page 80]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4518        "PERSISTENT" -        "PERSISTENT" -
4519    
4520           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
# Line 4495  Internet-Draft    LinuxSampler Control P Line 4529  Internet-Draft    LinuxSampler Control P
4529           In case there is no <instr_load_mode> argument given, it will           In case there is no <instr_load_mode> argument given, it will
4530           be up to the InstrumentManager to decide which mode to use.           be up to the InstrumentManager to decide which mode to use.
4531           Usually it will use "ON_DEMAND" if an entry for the given           Usually it will use "ON_DEMAND" if an entry for the given
4532    
4533    
4534    
4535    Schoenebeck               Expires June 7, 2008                 [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol        December 2007
4538    
4539    
4540           instrument does not exist in the InstrumentManager's list yet,           instrument does not exist in the InstrumentManager's list yet,
4541           otherwise if an entry already exists, it will simply stick with           otherwise if an entry already exists, it will simply stick with
4542           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
# Line 4515  Internet-Draft    LinuxSampler Control P Line 4557  Internet-Draft    LinuxSampler Control P
4557     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4558     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4559     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4560     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes, supporting escape sequences as described in chapter
4561     displaying an appropriate name for mapped instruments (using "GET     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4562     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     entry, useful for frontends for displaying an appropriate name for
4563       mapped instruments (using "GET MIDI_INSTRUMENT INFO"
4564       (Section 6.7.11)).
4565    
4566     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4567     completely established in the sampler.  The OPTIONAL "NON_MODAL"     completely established in the sampler.  The OPTIONAL "NON_MODAL"
# Line 4529  Internet-Draft    LinuxSampler Control P Line 4573  Internet-Draft    LinuxSampler Control P
4573     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4574     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4575     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 81]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4576     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4577     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4578     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4548  Internet-Draft    LinuxSampler Control P Line 4584  Internet-Draft    LinuxSampler Control P
4584    
4585           usually           usually
4586    
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires June 7, 2008                 [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol        December 2007
4594    
4595    
4596        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4597    
4598           when the given map or engine does not exist or a value is out           when the given map or engine does not exist or a value is out
# Line 4585  Internet-Draft    LinuxSampler Control P Line 4630  Internet-Draft    LinuxSampler Control P
4630     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
4631     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4632    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 82]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4633        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
4634    
4635     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 4602  Internet-Draft    LinuxSampler Control P Line 4639  Internet-Draft    LinuxSampler Control P
4639    
4640     Possible Answers:     Possible Answers:
4641    
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires June 7, 2008                 [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol        December 2007
4650    
4651    
4652        The sampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
4653        in the MIDI instrument map(s).        in the MIDI instrument map(s).
4654    
# Line 4641  Internet-Draft    LinuxSampler Control P Line 4688  Internet-Draft    LinuxSampler Control P
4688    
4689     Example:     Example:
4690    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 83]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4691        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
4692    
4693        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 4658  Internet-Draft    LinuxSampler Control P Line 4697  Internet-Draft    LinuxSampler Control P
4697     The front-end can delete an entry from a MIDI instrument map by     The front-end can delete an entry from a MIDI instrument map by
4698     sending the following command:     sending the following command:
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires June 7, 2008                 [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol        December 2007
4706    
4707    
4708        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4709    
4710     Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>     Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
# Line 4696  Internet-Draft    LinuxSampler Control P Line 4743  Internet-Draft    LinuxSampler Control P
4743    
4744     Possible Answers:     Possible Answers:
4745    
   
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 84]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
4746        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4747        answer line begins with the information category name followed by        answer line begins with the information category name followed by
4748        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 4715  Internet-Draft    LinuxSampler Control P Line 4753  Internet-Draft    LinuxSampler Control P
4753    
4754           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
4755           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
4756    
4757    
4758    
4759    Schoenebeck               Expires June 7, 2008                 [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol        December 2007
4762    
4763    
4764           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
4765           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4766           be unique.           be unique. (note that this character string may contain escape
4767             sequences (Section 7.1))
4768    
4769        "ENGINE_NAME" -        "ENGINE_NAME" -
4770    
# Line 4725  Internet-Draft    LinuxSampler Control P Line 4772  Internet-Draft    LinuxSampler Control P
4772    
4773        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4774    
4775           File name of the instrument.           File name of the instrument (note that this path may contain
4776             escape sequences (Section 7.1)).
4777    
4778        "INSTRUMENT_NR" -        "INSTRUMENT_NR" -
4779    
# Line 4735  Internet-Draft    LinuxSampler Control P Line 4783  Internet-Draft    LinuxSampler Control P
4783    
4784           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
4785           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4786           cannot be changed.           cannot be changed (note that this character string may contain
4787             escape sequences (Section 7.1)).
4788    
4789        "LOAD_MODE" -        "LOAD_MODE" -
4790    
# Line 4752  Internet-Draft    LinuxSampler Control P Line 4801  Internet-Draft    LinuxSampler Control P
4801    
4802     Example:     Example:
4803    
4804          C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4805    
4806          S: "NAME: Drums for Foo Song"
4807    
4808             "ENGINE_NAME: GigEngine"
4809    
4810             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4811    
 Schoenebeck             Expires December 24, 2007              [Page 85]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4812    
4813    
       C: "GET MIDI_INSTRUMENT INFO 1 45 120"  
4814    
4815        S: "NAME: Drums for Foo Song"  Schoenebeck               Expires June 7, 2008                 [Page 86]
4816    
4817           "ENGINE_NAME: GigEngine"  Internet-Draft        LinuxSampler Control Protocol        December 2007
4818    
          "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"  
4819    
4820           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
4821    
# Line 4809  Internet-Draft    LinuxSampler Control P Line 4857  Internet-Draft    LinuxSampler Control P
4857    
4858        S: "OK"        S: "OK"
4859    
4860          C: "CLEAR MIDI_INSTRUMENTS ALL"
4861    
4862          S: "OK"
4863    
4864    
 Schoenebeck             Expires December 24, 2007              [Page 86]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4865    
4866    
       C: "CLEAR MIDI_INSTRUMENTS ALL"  
4867    
4868        S: "OK"  
4869    
4870    
4871    Schoenebeck               Expires June 7, 2008                 [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol        December 2007
4874    
4875    
4876  6.8.  Managing Instruments Database  6.8.  Managing Instruments Database
4877    
4878     The following commands describe how to use and manage the instruments     The following commands describe how to use and manage the instruments
4879     database.     database.
4880    
4881       Notice:
4882    
4883          All command arguments representing a path or instrument/directory
4884          name support escape sequences as described in chapter "Character
4885          Set and Escape Sequences (Section 7.1)".
4886    
4887          All occurrences of a forward slash in instrument and directory
4888          names are escaped with its hex (\x2f) or octal (\057) escape
4889          sequence.
4890    
4891  6.8.1.  Creating a new instrument directory  6.8.1.  Creating a new instrument directory
4892    
4893     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 4859  Internet-Draft    LinuxSampler Control P Line 4921  Internet-Draft    LinuxSampler Control P
4921     The front-end can delete a particular instrument directory from the     The front-end can delete a particular instrument directory from the
4922     instruments database by sending the following command:     instruments database by sending the following command:
4923    
       REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>  
4924    
    Where <dir> is the absolute path name of the directory to delete.  
    The optional FORCE argument can be used to force the deletion of a  
    non-empty directory and all its content.  
4925    
4926    
4927    Schoenebeck               Expires June 7, 2008                 [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol        December 2007
4930    
4931    
4932  Schoenebeck             Expires December 24, 2007              [Page 87]        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4933    
4934       Where <dir> is the absolute path name of the directory to delete.
4935       The optional FORCE argument can be used to force the deletion of a
4936       non-empty directory and all its content.
4937    
4938     Possible Answers:     Possible Answers:
4939    
# Line 4913  Internet-Draft    LinuxSampler Control P Line 4975  Internet-Draft    LinuxSampler Control P
4975    
4976     Example:     Example:
4977    
       C: "GET DB_INSTRUMENT_DIRECTORIES '/'"  
   
       S: "2"  
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires June 7, 2008                 [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol        December 2007
4986    
4987    
4988  Schoenebeck             Expires December 24, 2007              [Page 88]        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
4989    
4990          S: "2"
4991    
4992  6.8.4.  Listing all directories in specific directory  6.8.4.  Listing all directories in specific directory
4993    
# Line 4973  Internet-Draft    LinuxSampler Control P Line 5033  Internet-Draft    LinuxSampler Control P
5033    
5034     Possible Answers:     Possible Answers:
5035    
       LinuxSampler will answer by sending a <CRLF> separated list.  Each  
       answer line begins with the settings category name followed by a  
       colon and then a space character <SP> and finally the info  
       character string to that setting category.  At the moment the  
5036    
5037    
5038    
5039  Schoenebeck             Expires December 24, 2007              [Page 89]  Schoenebeck               Expires June 7, 2008                 [Page 90]
5040    
5041  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5042    
5043    
5044          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5045          answer line begins with the settings category name followed by a
5046          colon and then a space character <SP> and finally the info
5047          character string to that setting category.  At the moment the
5048        following categories are defined:        following categories are defined:
5049    
5050    
5051    
5052           DESCRIPTION -           DESCRIPTION -
5053    
5054              A brief description of the directory content              A brief description of the directory content.  Note that the
5055                character string may contain escape sequences (Section 7.1).
5056    
5057           CREATED -           CREATED -
5058    
# Line 5028  Internet-Draft    LinuxSampler Control P Line 5089  Internet-Draft    LinuxSampler Control P
5089     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
5090     the new name for that directory.     the new name for that directory.
5091    
    Possible Answers:  
5092    
       "OK" -  
5093    
5094    
5095    Schoenebeck               Expires June 7, 2008                 [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol        December 2007
5098    
5099    
5100  Schoenebeck             Expires December 24, 2007              [Page 90]     Possible Answers:
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5101    
5102          "OK" -
5103    
5104           on success           on success
5105    
# Line 5088  Internet-Draft    LinuxSampler Control P Line 5148  Internet-Draft    LinuxSampler Control P
5148    
5149    
5150    
5151    Schoenebeck               Expires June 7, 2008                 [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol        December 2007
   
   
 Schoenebeck             Expires December 24, 2007              [Page 91]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5154    
5155    
5156  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
# Line 5135  Internet-Draft    LinuxSampler Control P Line 5191  Internet-Draft    LinuxSampler Control P
5191        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5192    
5193     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
5194     the new description for the directory.     the new description for the directory (encapsulated into apostrophes,
5195       supporting escape sequences as described in chapter "Character Set
5196       and Escape Sequences (Section 7.1)").
5197    
5198     Possible Answers:     Possible Answers:
5199    
# Line 5146  Internet-Draft    LinuxSampler Control P Line 5204  Internet-Draft    LinuxSampler Control P
5204    
5205    
5206    
5207    Schoenebeck               Expires June 7, 2008                 [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol        December 2007
 Schoenebeck             Expires December 24, 2007              [Page 92]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5210    
5211    
5212        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5182  Internet-Draft    LinuxSampler Control P Line 5238  Internet-Draft    LinuxSampler Control P
5238     NAME='<search-string>'     NAME='<search-string>'
5239    
5240        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5241        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5242          escape sequences as described in chapter "Character Set and Escape
5243          Sequences (Section 7.1)").
5244    
5245     CREATED='[<date-after>]..[<date-before>]'     CREATED='[<date-after>]..[<date-before>]'
5246    
# Line 5199  Internet-Draft    LinuxSampler Control P Line 5257  Internet-Draft    LinuxSampler Control P
5257        modification satisfies the specified period, where <date-after>        modification satisfies the specified period, where <date-after>
5258        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-
5259        after> is omitted the search is restricted to directories, which        after> is omitted the search is restricted to directories, which
       are last modified before <date-before>.  If <date-before> is  
       omitted, the search is restricted to directories, which are last  
5260    
5261    
5262    
5263  Schoenebeck             Expires December 24, 2007              [Page 93]  Schoenebeck               Expires June 7, 2008                 [Page 94]
5264    
5265  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5266    
5267    
5268          are last modified before <date-before>.  If <date-before> is
5269          omitted, the search is restricted to directories, which are last
5270        modified after <date-after>.        modified after <date-after>.
5271    
5272     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5273    
5274        Restricts the search to directories with description that        Restricts the search to directories with description that
5275        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5276          apostrophes, supporting escape sequences as described in chapter
5277          "Character Set and Escape Sequences (Section 7.1)").
5278    
5279     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5280     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
# Line 5253  Internet-Draft    LinuxSampler Control P Line 5313  Internet-Draft    LinuxSampler Control P
5313     instruments (that are not already in the database) will be added,     instruments (that are not already in the database) will be added,
5314     <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
5315     file system (encapsulated into apostrophes).  In case an instrument     file system (encapsulated into apostrophes).  In case an instrument
    file is supplied, only the instruments in the specified file will be  
    added to the instruments database.  If the optional <instr_index>  
    (the index of the instrument within the given file) is supplied too,  
    then only the specified instrument will be added.  In case a  
5316    
5317    
5318    
5319  Schoenebeck             Expires December 24, 2007              [Page 94]  Schoenebeck               Expires June 7, 2008                 [Page 95]
5320    
5321  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5322    
5323    
5324       file is supplied, only the instruments in the specified file will be
5325       added to the instruments database.  If the optional <instr_index>
5326       (the index of the instrument within the given file) is supplied too,
5327       then only the specified instrument will be added.  In case a
5328     directory is supplied, the instruments in that directory will be     directory is supplied, the instruments in that directory will be
5329     added.  The OPTIONAL <mode> argument is only applied when a directory     added.  The OPTIONAL <mode> argument is only applied when a directory
5330     is provided as <file_path> and specifies how the scanning will be     is provided as <file_path> and specifies how the scanning will be
# Line 5308  Internet-Draft    LinuxSampler Control P Line 5368  Internet-Draft    LinuxSampler Control P
5368    
5369        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5370    
          if an invalid path is specified.  
5371    
    Examples:  
5372    
5373    
5374    
5375    Schoenebeck               Expires June 7, 2008                 [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol        December 2007
5378    
 Schoenebeck             Expires December 24, 2007              [Page 95]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5379    
5380             if an invalid path is specified.
5381    
5382       Examples:
5383    
5384        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5385        Bosendorfer 290.gig' 0"        Bosendorfer 290.gig' 0"
# Line 5366  Internet-Draft    LinuxSampler Control P Line 5426  Internet-Draft    LinuxSampler Control P
5426    
5427     Possible Answers:     Possible Answers:
5428    
       The current number of instruments in the specified directory.  
   
5429    
5430    
5431    Schoenebeck               Expires June 7, 2008                 [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol        December 2007
5434    
 Schoenebeck             Expires December 24, 2007              [Page 96]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5435    
5436          The current number of instruments in the specified directory.
5437    
5438        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5439    
# Line 5419  Internet-Draft    LinuxSampler Control P Line 5477  Internet-Draft    LinuxSampler Control P
5477        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5478        Steinway D','/Piano Collection/Lite/Free Piano'"        Steinway D','/Piano Collection/Lite/Free Piano'"
5479    
 6.8.15.  Getting instrument information  
5480    
    The front-end can ask for the current settings of an instrument by  
    sending the following command:  
5481    
5482    
5483    
5484    
5485    
 Schoenebeck             Expires December 24, 2007              [Page 97]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5486    
5487    Schoenebeck               Expires June 7, 2008                 [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol        December 2007
5490    
5491    
5492    6.8.15.  Getting instrument information
5493    
5494       The front-end can ask for the current settings of an instrument by
5495       sending the following command:
5496    
5497        GET DB_INSTRUMENT INFO <instr_path>        GET DB_INSTRUMENT INFO <instr_path>
5498    
# Line 5450  Internet-Draft    LinuxSampler Control P Line 5511  Internet-Draft    LinuxSampler Control P
5511    
5512           INSTRUMENT_FILE -           INSTRUMENT_FILE -
5513    
5514              File name of the instrument.              File name of the instrument.  Note that the character string
5515                may contain escape sequences (Section 7.1).
5516    
5517           INSTRUMENT_NR -           INSTRUMENT_NR -
5518    
# Line 5474  Internet-Draft    LinuxSampler Control P Line 5536  Internet-Draft    LinuxSampler Control P
5536              instruments database, represented in "YYYY-MM-DD HH:MM:SS"              instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5537              format              format
5538    
          MODIFIED -  
5539    
             The date and time of the last modification of the  
             instrument's database settings, represented in "YYYY-MM-DD  
             HH:MM:SS" format  
5540    
5541    
5542    
5543    Schoenebeck               Expires June 7, 2008                 [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol        December 2007
5546    
 Schoenebeck             Expires December 24, 2007              [Page 98]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5547    
5548             MODIFIED -
5549    
5550                The date and time of the last modification of the
5551                instrument's database settings, represented in "YYYY-MM-DD
5552                HH:MM:SS" format
5553    
5554           DESCRIPTION -           DESCRIPTION -
5555    
5556              A brief description of the instrument              A brief description of the instrument.  Note that the
5557                character string may contain escape sequences (Section 7.1).
5558    
5559           IS_DRUM -           IS_DRUM -
5560    
# Line 5500  Internet-Draft    LinuxSampler Control P Line 5563  Internet-Draft    LinuxSampler Control P
5563    
5564           PRODUCT -           PRODUCT -
5565    
5566              The product title of the instrument              The product title of the instrument.  Note that the
5567                character string may contain escape sequences (Section 7.1).
5568    
5569           ARTISTS -           ARTISTS -
5570    
5571              Lists the artist names              Lists the artist names.  Note that the character string may
5572                contain escape sequences (Section 7.1).
5573    
5574           KEYWORDS -           KEYWORDS -
5575    
5576              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
5577              Keywords are separated with semicolon and blank.              Keywords are separated with semicolon and blank.  Note that
5578                the character string may contain escape sequences
5579                (Section 7.1).
5580    
5581     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5582    
# Line 5525  Internet-Draft    LinuxSampler Control P Line 5592  Internet-Draft    LinuxSampler Control P
5592    
5593           "FORMAT_VERSION: 2"           "FORMAT_VERSION: 2"
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck               Expires June 7, 2008                [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol        December 2007
5602    
5603    
5604           "SIZE: 2050871870"           "SIZE: 2050871870"
5605    
5606           "CREATED: 2007-02-05 10:23:12"           "CREATED: 2007-02-05 10:23:12"
# Line 5537  Internet-Draft    LinuxSampler Control P Line 5613  Internet-Draft    LinuxSampler Control P
5613    
5614           "PRODUCT: GRANDIOSO Bosendorfer 290"           "PRODUCT: GRANDIOSO Bosendorfer 290"
5615    
   
   
   
 Schoenebeck             Expires December 24, 2007              [Page 99]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5616           "ARTISTS: Post Musical Instruments"           "ARTISTS: Post Musical Instruments"
5617    
5618           "KEYWORDS: Bosendorfer"           "KEYWORDS: Bosendorfer"
# Line 5579  Internet-Draft    LinuxSampler Control P Line 5647  Internet-Draft    LinuxSampler Control P
5647    
5648        S: "OK"        S: "OK"
5649    
 6.8.17.  Moving an instrument  
5650    
    The front-end can move a specific instrument to another directory by  
    sending the following command:  
5651    
       MOVE DB_INSTRUMENT <instr> <dst>  
5652    
    Where <instr> is the absolute path name of the instrument to move and  
    <dst> is the directory where the instrument will be moved to.  
5653    
    Possible Answers:  
5654    
5655    Schoenebeck               Expires June 7, 2008                [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol        December 2007
5658    
5659    
5660    6.8.17.  Moving an instrument
5661    
5662       The front-end can move a specific instrument to another directory by
5663       sending the following command:
5664    
5665  Schoenebeck             Expires December 24, 2007             [Page 100]        MOVE DB_INSTRUMENT <instr> <dst>
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5666    
5667       Where <instr> is the absolute path name of the instrument to move and
5668       <dst> is the directory where the instrument will be moved to.
5669    
5670       Possible Answers:
5671    
5672        "OK" -        "OK" -
5673    
# Line 5636  Internet-Draft    LinuxSampler Control P Line 5704  Internet-Draft    LinuxSampler Control P
5704    
5705        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5706    
          in case the given instrument does not exists, or if an  
          instrument with name equal to the name of the specified  
          instrument already exists in the destination directory.  
5707    
    Example:  
5708    
       C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'  
       '/Acoustic/Pianos/'"  
5709    
       S: "OK"  
5710    
5711    Schoenebeck               Expires June 7, 2008                [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol        December 2007
5714    
5715    
5716             in case the given instrument does not exists, or if an
5717             instrument with name equal to the name of the specified
5718             instrument already exists in the destination directory.
5719    
5720       Example:
5721    
5722  Schoenebeck             Expires December 24, 2007             [Page 101]        C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
5723          '/Acoustic/Pianos/'"
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
5724    
5725          S: "OK"
5726    
5727  6.8.19.  Changing the description of instrument  6.8.19.  Changing the description of instrument
5728    
# Line 5665  Internet-Draft    LinuxSampler Control P Line 5732  Internet-Draft    LinuxSampler Control P
5732        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5733    
5734     Where <instr> is the absolute path name of the instrument and <desc>     Where <instr> is the absolute path name of the instrument and <desc>
5735     is the new description for the instrument.     is the new description for the instrument (encapsulated into
5736       apostrophes, supporting escape sequences as described in chapter
5737       "Character Set and Escape Sequences (Section 7.1)").
5738    
5739     Possible Answers:     Possible Answers:
5740    
# Line 5692  Internet-Draft    LinuxSampler Control P Line 5761  Internet-Draft    LinuxSampler Control P
5761        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5762    
5763     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5764    
5765    
5766    
5767    Schoenebeck               Expires June 7, 2008                [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol        December 2007
5770    
5771    
5772     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5773     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5774     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
# Line 5701  Internet-Draft    LinuxSampler Control P Line 5778  Internet-Draft    LinuxSampler Control P
5778     NAME='<search-string>'     NAME='<search-string>'
5779    
5780        Restricts the search to instruments, which names satisfy the        Restricts the search to instruments, which names satisfy the
5781        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5782          escape sequences as described in chapter "Character Set and Escape
5783          Sequences (Section 7.1)").
5784    
5785     SIZE=[<min>]..[<max>]     SIZE=[<min>]..[<max>]
5786    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 102]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5787        Restricts the search to instruments, which size is in the        Restricts the search to instruments, which size is in the
5788        specified range.  If <min> is omitted, the search results are        specified range.  If <min> is omitted, the search results are
5789        restricted to instruments with size less then or equal to <max>.        restricted to instruments with size less then or equal to <max>.
# Line 5741  Internet-Draft    LinuxSampler Control P Line 5812  Internet-Draft    LinuxSampler Control P
5812     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5813    
5814        Restricts the search to instruments with description that        Restricts the search to instruments with description that
5815        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5816          apostrophes, supporting escape sequences as described in chapter
5817          "Character Set and Escape Sequences (Section 7.1)").
5818    
5819     PRODUCT='<search-string>'     PRODUCT='<search-string>'
5820    
5821    
5822    
5823    Schoenebeck               Expires June 7, 2008                [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol        December 2007
5826    
5827    
5828        Restricts the search to instruments with product info that        Restricts the search to instruments with product info that
5829        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5830          apostrophes, supporting escape sequences as described in chapter
5831          "Character Set and Escape Sequences (Section 7.1)").
5832    
5833     ARTISTS='<search-string>'     ARTISTS='<search-string>'
5834    
5835        Restricts the search to instruments with artists info that        Restricts the search to instruments with artists info that
5836        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5837          apostrophes, supporting escape sequences as described in chapter
5838          "Character Set and Escape Sequences (Section 7.1)").
5839    
5840     KEYWORDS='<search-string>'     KEYWORDS='<search-string>'
5841    
5842        Restricts the search to instruments with keyword list that        Restricts the search to instruments with keyword list that
5843        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5844          apostrophes, supporting escape sequences as described in chapter
5845          "Character Set and Escape Sequences (Section 7.1)").
5846    
5847     IS_DRUM=true | false     IS_DRUM=true | false
5848    
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 103]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5849        Either true or false.  Restricts the search to drum kits or        Either true or false.  Restricts the search to drum kits or
5850        chromatic instruments.        chromatic instruments.
5851    
# Line 5796  Internet-Draft    LinuxSampler Control P Line 5873  Internet-Draft    LinuxSampler Control P
5873        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5874        290'"        290'"
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires June 7, 2008                [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol        December 2007
5882    
5883    
5884        S: "'/Piano Collection/Bosendorfer 290'"        S: "'/Piano Collection/Bosendorfer 290'"
5885    
5886        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
# Line 5816  Internet-Draft    LinuxSampler Control P Line 5901  Internet-Draft    LinuxSampler Control P
5901    
5902     Possible Answers:     Possible Answers:
5903    
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 104]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
5904        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5905        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5906        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
# Line 5854  Internet-Draft    LinuxSampler Control P Line 5930  Internet-Draft    LinuxSampler Control P
5930    
5931     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5932    
5933    
5934    
5935    Schoenebeck               Expires June 7, 2008                [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol        December 2007
5938    
5939    
5940     Example:     Example:
5941    
5942        C: "GET DB_INSTRUMENTS_JOB INFO 2"        C: "GET DB_INSTRUMENTS_JOB INFO 2"
# Line 5868  Internet-Draft    LinuxSampler Control P Line 5951  Internet-Draft    LinuxSampler Control P
5951    
5952           "."           "."
5953    
5954    6.8.22.  Formatting the instruments database
5955    
5956       The front-end can remove all instruments and directories and re-
5957       create the instruments database structure (e.g., in case of a
5958       database corruption) by sending the following command:
5959    
5960          FORMAT INSTRUMENTS_DB
5961    
5962       Possible Answers:
5963    
5964          "OK" -
5965    
5966             on success
5967    
5968          "ERR:<error-code>:<error-message>" -
5969    
5970             If the formatting of the instruments database failed.
5971    
5972    6.9.  Editing Instruments
5973    
5974       The sampler allows to edit instruments while playing with the sampler
5975       by spawning an external (3rd party) instrument editor application for
5976       a given instrument.  The 3rd party instrument editor applications
5977       have to place a respective plugin DLL file into the sampler's plugins
5978       directory.  The sampler will automatically try to load all plugin
5979       DLLs in that directory on startup and only on startup!
5980    
5981       At the moment there is only one command for this feature set, but
5982       this will most probably change in future.
5983    
5984  Schoenebeck             Expires December 24, 2007             [Page 105]  6.9.1.  Opening an appropriate instrument editor application
5985    
5986  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007     The front-end can request to open an appropriate instrument editor
5987       application by sending the following command:
5988    
5989    
5990    
5991    Schoenebeck               Expires June 7, 2008                [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol        December 2007
5994    
5995    
5996          EDIT CHANNEL INSTRUMENT <sampler-channel>
5997    
5998       Where <sampler-channel> should be replaced by the number of the
5999       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
6000       "LIST CHANNELS" (Section 6.4.4) command.
6001    
6002       The sampler will try to ask all registered instrument editors (or to
6003       be more specific: their sampler plugins) whether they are capable to
6004       handle the instrument on the given sampler channel.  The sampler will
6005       simply use the first instrument editor application which replied with
6006       a positive answer and spawn that instrument editor application within
6007       the sampler's process and provide that application access to the
6008       instrument's data structures, so both applications can share and
6009       access the same instruments data at the same time, thus allowing to
6010       immediately hear changes with the sampler made by the instrument
6011       editor.
6012    
6013       Note: consequently instrument editors are always spawned locally on
6014       the same machine where the sampler is running on!
6015    
6016       Possible Answers:
6017    
6018          "OK" -
6019    
6020             when an appropriate instrument editor was launched
6021    
6022          "WRN:<warning-code>:<warning-message>" -
6023    
6024             when an appropriate instrument editor was launched, but there
6025             are noteworthy issues
6026    
6027          "ERR:<error-code>:<error-message>" -
6028    
6029             when an appropriate instrument editor could not be launched
6030    
6031       Examples:
6032    
6033          C: "EDIT CHANNEL INSTRUMENT 0"
6034    
6035          S: "OK"
6036    
6037    6.10.  Managing Files
6038    
6039       You can query detailed informations about files located at the same
6040       system where the sampler instance is running on.  Using this command
6041       set allows to retrieve file informations even remotely from another
6042       machine.
6043    
6044    
6045    
6046    
6047    Schoenebeck               Expires June 7, 2008                [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol        December 2007
6050    
6051    
6052    6.10.1.  Retrieving amount of instruments of a file
6053    
6054       The front-end can retrieve the amount of instruments within a given
6055       instrument file by sending the following command:
6056    
6057          GET FILE INSTRUMENTS <filename>
6058    
6059       Where <filename> is the name of the instrument file (encapsulated
6060       into apostrophes, supporting escape sequences as described in chapter
6061       "Character Set and Escape Sequences (Section 7.1)").
6062    
6063       The sampler will try to ask all sampler engines, whether they support
6064       the given file and ask the first engine with a positive answer for
6065       the amount of instruments.
6066    
6067       Possible Answers:
6068    
6069          On success, the sampler will answer by returning the amount of
6070          instruments.
6071    
6072          "ERR:<error-code>:<error-message>" -
6073    
6074             if the file could not be handled
6075    
6076       Examples:
6077    
6078          C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6079    
6080          S: "10"
6081    
6082    6.10.2.  Retrieving all instruments of a file
6083    
6084       The front-end can retrieve a list of all instruments within a given
6085       instrument file by sending the following command:
6086    
6087          LIST FILE INSTRUMENTS <filename>
6088    
6089       Where <filename> is the name of the instrument file (encapsulated
6090       into apostrophes, supporting escape sequences as described in chapter
6091       "Character Set and Escape Sequences (Section 7.1)").
6092    
6093       The sampler will try to ask all sampler engines, whether they support
6094       the given file and ask the first engine with a positive answer for a
6095       list of IDs for the instruments in the given file.
6096    
6097       Possible Answers:
6098    
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires June 7, 2008                [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol        December 2007
6106    
6107    
6108          On success, the sampler will answer by returning a comma separated
6109          list of instrument IDs.
6110    
6111          "ERR:<error-code>:<error-message>" -
6112    
6113             if the file could not be handled
6114    
6115       Examples:
6116    
6117          C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6118    
6119          S: "0,1,2,3,4,5,6,7,8,9"
6120    
6121    6.10.3.  Retrieving informations about one instrument in a file
6122    
6123       The front-end can retrieve detailed informations about a specific
6124       instrument within a given instrument file by sending the following
6125       command:
6126    
6127          GET FILE INSTRUMENT INFO <filename> <instr-id>
6128    
6129       Where <filename> is the name of the instrument file (encapsulated
6130       into apostrophes, supporting escape sequences as described in chapter
6131       "Character Set and Escape Sequences (Section 7.1)") and <instr-id> is
6132       the numeric instrument ID as returned by the "LIST FILE INSTRUMENTS"
6133       (Section 6.10.2) command.
6134    
6135       The sampler will try to ask all sampler engines, whether they support
6136       the given file and ask the first engine with a positive answer for
6137       informations about the specific instrument in the given file.
6138    
6139       Possible Answers:
6140    
6141          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6142          answer line begins with the settings category name followed by a
6143          colon and then a space character <SP> and finally the info
6144          character string to that setting category.  At the moment the
6145          following categories are defined:
6146    
6147    
6148    
6149             NAME -
6150    
6151                name of the instrument as stored in the instrument file
6152    
6153             FORMAT_FAMILY -
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck               Expires June 7, 2008                [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol        December 2007
6162    
6163    
6164                name of the sampler format of the given instrument
6165    
6166             FORMAT_VERSION -
6167    
6168                version of the sampler format the instrumen is stored as
6169    
6170             PRODUCT -
6171    
6172                official product name of the instrument as stored in the
6173                file
6174    
6175             ARTISTS -
6176    
6177                artists / sample library vendor of the instrument
6178    
6179       The mentioned fields above don't have to be in particular order.
6180    
6181       Example:
6182    
6183          C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
6184    
6185          S: "NAME: Lunatic Loops"
6186    
6187             "FORMAT_FAMILY: GIG"
6188    
6189             "FORMAT_VERSION: 3"
6190    
6191             "PRODUCT: The Backbone Bongo Beats"
6192    
6193             "ARTISTS: Jimmy the Fish"
6194    
6195             "."
6196    
6197    
6198    
6199    
6200    
6201    
6202    
6203    
6204    
6205    
6206    
6207    
6208    
6209    
6210    
6211    
6212    
6213    
6214    
6215    Schoenebeck               Expires June 7, 2008                [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol        December 2007
6218    
6219    
6220  7.  Command Syntax  7.  Command Syntax
# Line 5932  Internet-Draft    LinuxSampler Control P Line 6268  Internet-Draft    LinuxSampler Control P
6268    
6269    
6270    
6271  Schoenebeck             Expires December 24, 2007             [Page 106]  Schoenebeck               Expires June 7, 2008                [Page 112]
6272    
6273  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
6274    
6275    
6276        / LIST SP list_instruction        / LIST SP list_instruction
# Line 5961  Internet-Draft    LinuxSampler Control P Line 6297  Internet-Draft    LinuxSampler Control P
6297    
6298        / EDIT SP edit_instruction        / EDIT SP edit_instruction
6299    
6300          / FORMAT SP format_instruction
6301    
6302        / RESET        / RESET
6303    
6304        / QUIT        / QUIT
# Line 5969  Internet-Draft    LinuxSampler Control P Line 6307  Internet-Draft    LinuxSampler Control P
6307    
6308        CHANNEL        CHANNEL
6309    
6310        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6311    
6312        / 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
6313    
6314        / DB_INSTRUMENTS SP scan_mode SP pathname SP pathname        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6315    
6316        / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6317    
6318        / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6319        instrument_index        instrument_index
6320    
6321        / DB_INSTRUMENTS SP pathname SP pathname        / DB_INSTRUMENTS SP db_path SP filename
6322    
       / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  
6323    
6324    
6325    
6326    
6327    Schoenebeck               Expires June 7, 2008                [Page 113]
6328    
6329  Schoenebeck             Expires December 24, 2007             [Page 107]  Internet-Draft        LinuxSampler Control Protocol        December 2007
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
6330    
6331    
6332          / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6333    
6334        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
6335    
6336        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
# Line 6039  Internet-Draft    LinuxSampler Control P Line 6377  Internet-Draft    LinuxSampler Control P
6377    
6378        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6379    
       / MISCELLANEOUS  
6380    
6381    
6382    
6383    Schoenebeck               Expires June 7, 2008                [Page 114]
6384    
6385  Schoenebeck             Expires December 24, 2007             [Page 108]  Internet-Draft        LinuxSampler Control Protocol        December 2007
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
6386    
6387    
6388          / MISCELLANEOUS
6389    
6390          / TOTAL_STREAM_COUNT
6391    
6392        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6393    
6394        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6093  Internet-Draft    LinuxSampler Control P Line 6433  Internet-Draft    LinuxSampler Control P
6433    
6434        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
6435    
       / DB_INSTRUMENTS_JOB_INFO  
6436    
       / MISCELLANEOUS  
6437    
6438    
6439    Schoenebeck               Expires June 7, 2008                [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol        December 2007
6442    
6443    
6444  Schoenebeck             Expires December 24, 2007             [Page 109]        / DB_INSTRUMENTS_JOB_INFO
6445    
6446  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007        / MISCELLANEOUS
6447    
6448          / TOTAL_STREAM_COUNT
6449    
6450        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6451    
# Line 6138  Internet-Draft    LinuxSampler Control P Line 6480  Internet-Draft    LinuxSampler Control P
6480    
6481        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6482    
6483        / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6484    
6485        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6486    
6487        / DB_INSTRUMENT SP pathname        / DB_INSTRUMENT SP db_path
6488    
6489     get_instruction =     get_instruction =
6490    
       AVAILABLE_ENGINES  
6491    
       / AVAILABLE_MIDI_INPUT_DRIVERS  
6492    
       / MIDI_INPUT_DRIVER SP INFO SP string  
6493    
6494    
6495    Schoenebeck               Expires June 7, 2008                [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol        December 2007
6498    
6499    
6500  Schoenebeck             Expires December 24, 2007             [Page 110]        AVAILABLE_ENGINES
6501    
6502  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007        / AVAILABLE_MIDI_INPUT_DRIVERS
6503    
6504          / MIDI_INPUT_DRIVER SP INFO SP string
6505    
6506        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6507    
# Line 6202  Internet-Draft    LinuxSampler Control P Line 6544  Internet-Draft    LinuxSampler Control P
6544    
6545        / CHANNEL SP VOICE_COUNT SP sampler_channel        / CHANNEL SP VOICE_COUNT SP sampler_channel
6546    
       / ENGINE SP INFO SP engine_name  
6547    
       / SERVER SP INFO  
6548    
       / TOTAL_VOICE_COUNT  
6549    
6550    
6551    Schoenebeck               Expires June 7, 2008                [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol        December 2007
6554    
6555    
6556  Schoenebeck             Expires December 24, 2007             [Page 111]        / ENGINE SP INFO SP engine_name
6557    
6558  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007        / SERVER SP INFO
6559    
6560          / TOTAL_STREAM_COUNT
6561    
6562          / TOTAL_VOICE_COUNT
6563    
6564        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
6565    
# Line 6233  Internet-Draft    LinuxSampler Control P Line 6577  Internet-Draft    LinuxSampler Control P
6577    
6578        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6579    
6580        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6581    
6582        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP db_path
6583    
6584        / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname        / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6585    
6586        / DB_INSTRUMENTS SP RECURSIVE SP pathname        / DB_INSTRUMENTS SP RECURSIVE SP db_path
6587    
6588        / DB_INSTRUMENTS SP pathname        / DB_INSTRUMENTS SP db_path
6589    
6590        / DB_INSTRUMENT SP INFO SP pathname        / DB_INSTRUMENT SP INFO SP db_path
6591    
6592        / DB_INSTRUMENTS_JOB SP INFO SP number        / DB_INSTRUMENTS_JOB SP INFO SP number
6593    
6594        / VOLUME        / VOLUME
6595    
6596          / FILE SP INSTRUMENTS SP filename
6597    
6598          / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6599    
6600     set_instruction =     set_instruction =
6601    
6602        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
6603        param_val_list        param_val_list
6604    
6605    
6606    
6607    Schoenebeck               Expires June 7, 2008                [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol        December 2007
6610    
6611    
6612        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='
6613        param_val_list        param_val_list
6614    
6615        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6616        param_val_list        param_val_list
6617    
6618          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6619    
6620        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6621        param_val_list        param_val_list
6622    
6623        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
6624    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 112]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6625        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6626    
6627        / 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
# Line 6286  Internet-Draft    LinuxSampler Control P Line 6635  Internet-Draft    LinuxSampler Control P
6635        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6636        volume_value        volume_value
6637    
6638        / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6639    
6640        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6641          stringval_escaped
6642    
6643        / DB_INSTRUMENT SP NAME SP pathname SP dirname        / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6644    
6645        / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6646    
6647        / ECHO SP boolean        / ECHO SP boolean
6648    
# Line 6306  Internet-Draft    LinuxSampler Control P Line 6656  Internet-Draft    LinuxSampler Control P
6656    
6657        / MIDI_INPUT_DEVICE SP string SP key_val_list        / MIDI_INPUT_DEVICE SP string SP key_val_list
6658    
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires June 7, 2008                [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol        December 2007
6666    
6667    
6668        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
6669    
6670        / FX_SEND SP sampler_channel SP midi_ctrl        / FX_SEND SP sampler_channel SP midi_ctrl
# Line 6320  Internet-Draft    LinuxSampler Control P Line 6679  Internet-Draft    LinuxSampler Control P
6679    
6680        MIDI_INSTRUMENTS SP midi_map        MIDI_INSTRUMENTS SP midi_map
6681    
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 113]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6682        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
6683    
6684     find_instruction =     find_instruction =
6685    
6686        DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list        DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6687    
6688        / DB_INSTRUMENTS SP pathname SP query_val_list        / DB_INSTRUMENTS SP db_path SP query_val_list
6689    
6690        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
6691        query_val_list        query_val_list
6692    
6693        / DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6694    
6695     move_instruction =     move_instruction =
6696    
6697        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6698    
6699        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6700    
6701     copy_instruction =     copy_instruction =
6702    
6703        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6704    
6705        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6706    
6707     destroy_instruction =     destroy_instruction =
6708    
# Line 6364  Internet-Draft    LinuxSampler Control P Line 6714  Internet-Draft    LinuxSampler Control P
6714    
6715     load_instruction =     load_instruction =
6716    
6717    
6718    
6719    Schoenebeck               Expires June 7, 2008                [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol        December 2007
6722    
6723    
6724        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
6725    
6726        / ENGINE SP load_engine_args        / ENGINE SP load_engine_args
# Line 6377  Internet-Draft    LinuxSampler Control P Line 6734  Internet-Draft    LinuxSampler Control P
6734    
6735        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6736    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 114]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6737        / MIDI_INPUT SP sampler_channel SP device_index SP        / MIDI_INPUT SP sampler_channel SP device_index SP
6738        midi_input_port_index SP midi_input_channel_index        midi_input_port_index SP midi_input_channel_index
6739    
# Line 6411  Internet-Draft    LinuxSampler Control P Line 6760  Internet-Draft    LinuxSampler Control P
6760    
6761     edit_instruction =     edit_instruction =
6762    
6763        INSTRUMENT SP sampler_channel        CHANNEL SP INSTRUMENT SP sampler_channel
6764    
6765       format_instruction =
6766    
6767          INSTRUMENTS_DB
6768    
6769     modal_arg =     modal_arg =
6770    
6771    
6772    
6773    
6774    
6775    Schoenebeck               Expires June 7, 2008                [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol        December 2007
6778    
6779    
6780        /* epsilon (empty argument) */        /* epsilon (empty argument) */
6781    
6782        / NON_MODAL SP        / NON_MODAL SP
# Line 6433  Internet-Draft    LinuxSampler Control P Line 6795  Internet-Draft    LinuxSampler Control P
6795    
6796     list_instruction =     list_instruction =
6797    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 115]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6798        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
6799    
6800        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 6461  Internet-Draft    LinuxSampler Control P Line 6815  Internet-Draft    LinuxSampler Control P
6815    
6816        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6817    
6818        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6819    
6820          / DB_INSTRUMENT_DIRECTORIES SP db_path
6821    
6822          / DB_INSTRUMENTS SP RECURSIVE SP db_path
6823    
6824          / DB_INSTRUMENTS SP db_path
6825    
6826          / FILE SP INSTRUMENTS SP filename
6827    
6828    
6829    
       / DB_INSTRUMENT_DIRECTORIES SP pathname  
6830    
6831        / DB_INSTRUMENTS SP RECURSIVE SP pathname  Schoenebeck               Expires June 7, 2008                [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol        December 2007
6834    
       / DB_INSTRUMENTS SP pathname  
6835    
6836     load_instr_args =     load_instr_args =
6837    
# Line 6489  Internet-Draft    LinuxSampler Control P Line 6853  Internet-Draft    LinuxSampler Control P
6853    
6854     device_index =     device_index =
6855    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 116]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6856        number        number
6857    
6858     audio_channel_index =     audio_channel_index =
# Line 6525  Internet-Draft    LinuxSampler Control P Line 6881  Internet-Draft    LinuxSampler Control P
6881    
6882        number        number
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires June 7, 2008                [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol        December 2007
6890    
6891    
6892     midi_bank =     midi_bank =
6893    
6894        number        number
# Line 6545  Internet-Draft    LinuxSampler Control P Line 6909  Internet-Draft    LinuxSampler Control P
6909    
6910     sampler_channel =     sampler_channel =
6911    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 117]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6912        number        number
6913    
6914     instrument_index =     instrument_index =
# Line 6567  Internet-Draft    LinuxSampler Control P Line 6923  Internet-Draft    LinuxSampler Control P
6923    
6924        string        string
6925    
6926     pathname =     filename =
6927    
6928        stringval        path
6929    
6930     dirname =     db_path =
6931    
6932        stringval        path
6933    
6934     filename =     map_name =
6935    
6936        stringval_escaped        stringval_escaped
6937    
6938     map_name =     entry_name =
6939    
6940    
       stringval  
6941    
    entry_name =  
6942    
6943        stringval  Schoenebeck               Expires June 7, 2008                [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol        December 2007
6946    
6947    
6948          stringval_escaped
6949    
6950     fx_send_name =     fx_send_name =
6951    
6952        stringval        stringval_escaped
6953    
6954     param_val_list =     param_val_list =
6955    
# Line 6601  Internet-Draft    LinuxSampler Control P Line 6961  Internet-Draft    LinuxSampler Control P
6961    
6962        string        string
6963    
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 118]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
6964        / stringval        / stringval
6965    
6966        / number        / number
# Line 6623  Internet-Draft    LinuxSampler Control P Line 6975  Internet-Draft    LinuxSampler Control P
6975    
6976     query_val =     query_val =
6977    
6978        string        text_escaped
6979    
6980        / stringval        / stringval_escaped
6981    
6982     scan_mode =     scan_mode =
6983    
# Line 6641  Internet-Draft    LinuxSampler Control P Line 6993  Internet-Draft    LinuxSampler Control P
6993     supported the standard ASCII character set (ASCII code 0 - 127)     supported the standard ASCII character set (ASCII code 0 - 127)
6994     [RFC20], all younger versions of this protocol however support the     [RFC20], all younger versions of this protocol however support the
6995     Extended ASCII character set (ASCII code 0 - 255).  The same group of     Extended ASCII character set (ASCII code 0 - 255).  The same group of
    younger protocols also support escape sequences, but only for  
    certain, explicitly declared parts of the protocol.  The supported  
    escape sequences are defined as follows:  
   
   
   
   
   
   
   
   
   
6996    
6997    
6998    
6999    Schoenebeck               Expires June 7, 2008                [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol        December 2007
7002    
7003    
7004       younger protocols also support escape sequences, but only for
7005  Schoenebeck             Expires December 24, 2007             [Page 119]     certain, explicitly declared parts of the protocol.  The supported
7006       escape sequences are defined as follows:
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
7007    
7008     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
7009     | ASCII Character        | Translated into (Name)                   |     | ASCII Character        | Translated into (Name)                   |
# Line 6700  Internet-Draft    LinuxSampler Control P Line 7040  Internet-Draft    LinuxSampler Control P
7040     (that is as double backslash), whereas in the old versions a single     (that is as double backslash), whereas in the old versions a single
7041     backslash was sufficient.     backslash was sufficient.
7042    
7043       The following LSCP commands support escape sequences as part of their
7044       filename / path based arguments and / or may contain a filename /
7045       path with escape sequences in their response:
7046    
7047          "LOAD INSTRUMENT" (Section 6.4.1)
7048    
7049          "GET CHANNEL INFO" (Section 6.4.10)
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck               Expires June 7, 2008                [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol        December 2007
7058    
7059    
7060          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7061    
7062          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7063    
7064          "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
7065    
7066          "ADD DB_INSTRUMENTS" (Section 6.8.11)
7067    
7068          "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
7069    
7070          "REMOVE DB_INSTRUMENT" (Section 6.8.12)
7071    
7072          "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
7073    
7074          "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
7075    
7076          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
7077    
7078          "GET DB_INSTRUMENTS" (Section 6.8.13)
7079    
7080          "LIST DB_INSTRUMENTS" (Section 6.8.14)
7081    
7082          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
7083    
7084          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7085    
7086          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7087    
7088          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7089    
7090          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7091    
7092          "FIND DB_INSTRUMENTS" (Section 6.8.20)
7093    
7094          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
7095    
7096          "MOVE DB_INSTRUMENT" (Section 6.8.17)
7097    
7098          "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
7099    
7100          "COPY DB_INSTRUMENT" (Section 6.8.18)
7101    
7102          "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
7103    
7104          "GET FILE INSTRUMENTS" (Section 6.10.1)
7105    
7106          "LIST FILE INSTRUMENTS" (Section 6.10.2)
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires June 7, 2008                [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol        December 2007
7114    
7115  Schoenebeck             Expires December 24, 2007             [Page 120]  
7116          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
7117  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
7118       Note that the forward slash character ('/') has a special meaning in
7119       filename / path based arguments: it acts as separator of the nodes in
7120       the path, thus if a directory- or filename includes a forward slash
7121       (not intended as path node separator), you MUST escape that slash
7122       either with the respective hex escape sequence ("\x2f") or with the
7123       respective octal escape sequence ("\057").
7124    
7125       Note for Windows: file path arguments in LSCP are expected to use
7126       forward slashes as directory node separator similar to Unix based
7127       operating systems.  In contrast to Unix however a Windows typical
7128       drive character is expected to be prefixed to the path.  That is an
7129       original Windows file path like "D:\Sounds\My.gig" would become in
7130       LSCP: "D:/Sounds/My.gig".
7131    
7132       The following LSCP commands even support escape sequences as part of
7133       at least one of their text-based arguments (i.e. entity name,
7134       description) and / or may contain escape sequences in at least one of
7135       their text-based fields in their response:
7136    
7137          "GET SERVER INFO" (Section 6.6.5)
7138    
7139          "GET ENGINE INFO" (Section 6.4.9)
7140    
7141          "GET CHANNEL INFO" (Section 6.4.10)
7142    
7143          "CREATE FX_SEND" (Section 6.4.25)
7144    
7145          "GET FX_SEND INFO" (Section 6.4.29)
7146    
7147          "SET FX_SEND NAME" (Section 6.4.30)
7148    
7149          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7150    
7151          "GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5)
7152    
7153          "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
7154    
7155          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7156    
7157          "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
7158    
7159          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
7160    
7161          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7162    
7163    
7164    
7165    
7166    
7167    Schoenebeck               Expires June 7, 2008                [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol        December 2007
7170    
7171    
7172          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7173    
7174          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
7175    
7176          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
7177    
7178          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7179    
7180          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7181    
7182          "FIND DB_INSTRUMENTS" (Section 6.8.20)
7183    
7184       Please note that these lists are manually maintained.  If you find a
7185       command that also supports escape sequences we forgot to mention
7186       here, please report it!
7187    
7188    
7189    
7190    
7191    
7192    
7193    
7194    
7195    
7196    
7197    
7198    
7199    
7200    
7201    
7202    
7203    
7204    
7205    
7206    
7207    
7208    
7209    
7210    
7211    
7212    
7213    
7214    
7215    
7216    
7217    
7218    
7219    
7220    
7221    
7222    
7223    Schoenebeck               Expires June 7, 2008                [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol        December 2007
7226    
7227    
7228  8.  Events  8.  Events
# Line 6772  Internet-Draft    LinuxSampler Control P Line 7276  Internet-Draft    LinuxSampler Control P
7276    
7277    
7278    
7279  Schoenebeck             Expires December 24, 2007             [Page 121]  Schoenebeck               Expires June 7, 2008                [Page 130]
7280    
7281  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7282    
7283    
7284        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 6828  Internet-Draft    LinuxSampler Control P Line 7332  Internet-Draft    LinuxSampler Control P
7332    
7333    
7334    
7335  Schoenebeck             Expires December 24, 2007             [Page 122]  Schoenebeck               Expires June 7, 2008                [Page 131]
7336    
7337  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7338    
7339    
7340        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
# Line 6884  Internet-Draft    LinuxSampler Control P Line 7388  Internet-Draft    LinuxSampler Control P
7388    
7389    
7390    
7391  Schoenebeck             Expires December 24, 2007             [Page 123]  Schoenebeck               Expires June 7, 2008                [Page 132]
7392    
7393  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7394    
7395    
7396        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 6940  Internet-Draft    LinuxSampler Control P Line 7444  Internet-Draft    LinuxSampler Control P
7444    
7445    
7446    
7447  Schoenebeck             Expires December 24, 2007             [Page 124]  Schoenebeck               Expires June 7, 2008                [Page 133]
7448    
7449  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7450    
7451    
7452        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
# Line 6954  Internet-Draft    LinuxSampler Control P Line 7458  Internet-Draft    LinuxSampler Control P
7458     where <voices> will be replaced by the new number of all currently     where <voices> will be replaced by the new number of all currently
7459     active voices.     active voices.
7460    
7461  8.13.  Number of MIDI instrument maps changed  8.13.  Total number of active disk streams changed
7462    
7463       Client may want to be notified when the total number of disk streams
7464       on the back-end changes by issuing the following command:
7465    
7466          SUBSCRIBE TOTAL_STREAM_COUNT
7467    
7468       Server will start sending the following notification messages:
7469    
7470          "NOTIFY:TOTAL_STREAM_COUNT:<streams>"
7471    
7472       where <streams> will be replaced by the new number of all currently
7473       active disk streams.
7474    
7475    8.14.  Number of MIDI instrument maps changed
7476    
7477     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
7478     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 6968  Internet-Draft    LinuxSampler Control P Line 7486  Internet-Draft    LinuxSampler Control P
7486     where <maps> will be replaced by the new number of MIDI instrument     where <maps> will be replaced by the new number of MIDI instrument
7487     maps.     maps.
7488    
7489  8.14.  MIDI instrument map information changed  8.15.  MIDI instrument map information changed
7490    
7491     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
7492     instrument maps on the back-end by issuing the following command:     instrument maps on the back-end by issuing the following command:
# Line 6977  Internet-Draft    LinuxSampler Control P Line 7495  Internet-Draft    LinuxSampler Control P
7495    
7496     Server will start sending the following notification messages:     Server will start sending the following notification messages:
7497    
7498    
7499    
7500    
7501    
7502    
7503    Schoenebeck               Expires June 7, 2008                [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol        December 2007
7506    
7507    
7508        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
7509    
7510     where <map-id> will be replaced by the numerical ID of the MIDI     where <map-id> will be replaced by the numerical ID of the MIDI
# Line 6987  Internet-Draft    LinuxSampler Control P Line 7515  Internet-Draft    LinuxSampler Control P
7515     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
7516     message is sufficient here.     message is sufficient here.
7517    
7518  8.15.  Number of MIDI instruments changed  8.16.  Number of MIDI instruments changed
7519    
7520     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
7521     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
7522    
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 125]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
7523        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
7524    
7525     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7011  Internet-Draft    LinuxSampler Control P Line 7530  Internet-Draft    LinuxSampler Control P
7530     which the nuber of instruments has changed and <instruments> will be     which the nuber of instruments has changed and <instruments> will be
7531     replaced by the new number of MIDI instruments in the specified map.     replaced by the new number of MIDI instruments in the specified map.
7532    
7533  8.16.  MIDI instrument information changed  8.17.  MIDI instrument information changed
7534    
7535     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
7536     instruments on the back-end by issuing the following command:     instruments on the back-end by issuing the following command:
# Line 7031  Internet-Draft    LinuxSampler Control P Line 7550  Internet-Draft    LinuxSampler Control P
7550     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
7551     empty notification message is sufficient here.     empty notification message is sufficient here.
7552    
7553  8.17.  Global settings changed  
7554    
7555    
7556    
7557    
7558    
7559    Schoenebeck               Expires June 7, 2008                [Page 135]
7560    
7561    Internet-Draft        LinuxSampler Control Protocol        December 2007
7562    
7563    
7564    8.18.  Global settings changed
7565    
7566     Client may want to be notified when changes to the global settings of     Client may want to be notified when changes to the global settings of
7567     the sampler were made by issuing the following command:     the sampler were made by issuing the following command:
# Line 7046  Internet-Draft    LinuxSampler Control P Line 7576  Internet-Draft    LinuxSampler Control P
7576        by the optional dotted floating point value, reflecting the new        by the optional dotted floating point value, reflecting the new
7577        global volume parameter.        global volume parameter.
7578    
7579    8.19.  Number of database instrument directories changed
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 126]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
 8.18.  Number of database instrument directories changed  
7580    
7581     Client may want to be notified when the number of instrument     Client may want to be notified when the number of instrument
7582     directories in a particular directory in the instruments database is     directories in a particular directory in the instruments database is
# Line 7076  Internet-Draft    LinuxSampler Control P Line 7595  Internet-Draft    LinuxSampler Control P
7595     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
7596     sent for the subdirectories in that directory.     sent for the subdirectories in that directory.
7597    
7598  8.19.  Database instrument directory information changed  8.20.  Database instrument directory information changed
7599    
7600     Client may want to be notified when changes were made to directories     Client may want to be notified when changes were made to directories
7601     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 7090  Internet-Draft    LinuxSampler Control P Line 7609  Internet-Draft    LinuxSampler Control P
7609     where <dir-path> will be replaced by the absolute path name of the     where <dir-path> will be replaced by the absolute path name of the
7610     directory, for which information changes occurred.  The front-end     directory, for which information changes occurred.  The front-end
7611     will have to send the respective command to actually get the updated     will have to send the respective command to actually get the updated
7612    
7613    
7614    
7615    Schoenebeck               Expires June 7, 2008                [Page 136]
7616    
7617    Internet-Draft        LinuxSampler Control Protocol        December 2007
7618    
7619    
7620     directory info.  Because these messages will be triggered by LSCP     directory info.  Because these messages will be triggered by LSCP
7621     commands issued by other clients rather than real time events     commands issued by other clients rather than real time events
7622     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
# Line 7102  Internet-Draft    LinuxSampler Control P Line 7629  Internet-Draft    LinuxSampler Control P
7629     (encapsulated into apostrophes), which name is changes and <new-name>     (encapsulated into apostrophes), which name is changes and <new-name>
7630     is the new name of the directory, encapsulated into apostrophes.     is the new name of the directory, encapsulated into apostrophes.
7631    
7632    8.21.  Number of database instruments changed
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 127]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
   
   
 8.20.  Number of database instruments changed  
7633    
7634     Client may want to be notified when the number of instruments in a     Client may want to be notified when the number of instruments in a
7635     particular directory in the instruments database is changed by     particular directory in the instruments database is changed by
# Line 7132  Internet-Draft    LinuxSampler Control P Line 7648  Internet-Draft    LinuxSampler Control P
7648     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
7649     sent for the instruments in that directory.     sent for the instruments in that directory.
7650    
7651  8.21.  Database instrument information changed  8.22.  Database instrument information changed
7652    
7653     Client may want to be notified when changes were made to instruments     Client may want to be notified when changes were made to instruments
7654     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 7149  Internet-Draft    LinuxSampler Control P Line 7665  Internet-Draft    LinuxSampler Control P
7665     info.  Because these messages will be triggered by LSCP commands     info.  Because these messages will be triggered by LSCP commands
7666     issued by other clients rather than real time events happening on the     issued by other clients rather than real time events happening on the
7667     server, it is believed that an empty notification message is     server, it is believed that an empty notification message is
    sufficient here.  
   
       "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"  
   
    where <old-instr-path> is the old absolute path name of the  
    instrument (encapsulated into apostrophes), which name is changes and  
    <new-name> is the new name of the instrument, encapsulated into  
    apostrophes.  
7668    
7669    
7670    
7671    Schoenebeck               Expires June 7, 2008                [Page 137]
7672    
7673    Internet-Draft        LinuxSampler Control Protocol        December 2007
7674    
7675    
7676       sufficient here.
7677    
7678  Schoenebeck             Expires December 24, 2007             [Page 128]        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
7679    
7680       where <old-instr-path> is the old absolute path name of the
7681       instrument (encapsulated into apostrophes), which name is changes and
7682       <new-name> is the new name of the instrument, encapsulated into
7683       apostrophes.
7684    
7685  8.22.  Database job status information changed  8.23.  Database job status information changed
7686    
7687     Client may want to be notified when the status of particular database     Client may want to be notified when the status of particular database
7688     instruments job is changed by issuing the following command:     instruments job is changed by issuing the following command:
# Line 7187  Internet-Draft    LinuxSampler Control P Line 7700  Internet-Draft    LinuxSampler Control P
7700     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
7701     empty notification message is sufficient here.     empty notification message is sufficient here.
7702    
7703  8.23.  Miscellaneous and debugging events  8.24.  Miscellaneous and debugging events
7704    
7705     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
7706     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 7211  Internet-Draft    LinuxSampler Control P Line 7724  Internet-Draft    LinuxSampler Control P
7724    
7725    
7726    
7727    Schoenebeck               Expires June 7, 2008                [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol        December 2007
   
   
   
   
   
   
   
 Schoenebeck             Expires December 24, 2007             [Page 129]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  
7730    
7731    
7732  9.  Security Considerations  9.  Security Considerations
# Line 7276  Internet-Draft    LinuxSampler Control P Line 7780  Internet-Draft    LinuxSampler Control P
7780    
7781    
7782    
7783  Schoenebeck             Expires December 24, 2007             [Page 130]  Schoenebeck               Expires June 7, 2008                [Page 139]
7784    
7785  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7786    
7787    
7788  10.  Acknowledgments  10.  Acknowledgments
# Line 7332  Internet-Draft    LinuxSampler Control P Line 7836  Internet-Draft    LinuxSampler Control P
7836    
7837    
7838    
7839  Schoenebeck             Expires December 24, 2007             [Page 131]  Schoenebeck               Expires June 7, 2008                [Page 140]
7840    
7841  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7842    
7843    
7844  11.  References  11.  References
# Line 7388  Internet-Draft    LinuxSampler Control P Line 7892  Internet-Draft    LinuxSampler Control P
7892    
7893    
7894    
7895  Schoenebeck             Expires December 24, 2007             [Page 132]  Schoenebeck               Expires June 7, 2008                [Page 141]
7896    
7897  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7898    
7899    
7900  Author's Address  Author's Address
# Line 7444  Author's Address Line 7948  Author's Address
7948    
7949    
7950    
7951  Schoenebeck             Expires December 24, 2007             [Page 133]  Schoenebeck               Expires June 7, 2008                [Page 142]
7952    
7953  Internet-Draft    LinuxSampler Control Protocol (draft)        June 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7954    
7955    
7956  Full Copyright Statement  Full Copyright Statement
# Line 7500  Acknowledgment Line 8004  Acknowledgment
8004    
8005    
8006    
8007  Schoenebeck             Expires December 24, 2007             [Page 134]  Schoenebeck               Expires June 7, 2008                [Page 143]
8008    
8009    
Legend:
Removed from v.1251  
changed lines
  Added in v.1572
  ViewVC Help
Powered by ViewVC