/[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 1430 by schoenebeck, Sun Oct 14 23:39:14 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: April 17, 2008                                 October 15, 2007  Expires: June 7, 2008                                   December 5, 2007
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.2                                  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 April 17, 2008.     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 April 17, 2008                 [Page 1]  Schoenebeck               Expires June 7, 2008                  [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                 [Page 2]  Schoenebeck               Expires June 7, 2008                  [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 124  Internet-Draft        LinuxSampler Contr
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  . . . . . . . . . . . . .  47         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
# Line 136  Internet-Draft        LinuxSampler Contr Line 136  Internet-Draft        LinuxSampler Contr
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 . . . . . . . . . . . . . . .  58         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  . . . . . . . . . . . . . .  60         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 April 17, 2008                 [Page 3]  Schoenebeck               Expires June 7, 2008                  [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol         October 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 . . . . . . . . . . . . . . . . . . . . .  73       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  . . . . . . . . . . . .  74         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 . . . . .  78         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  . . .  83         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 . .  85         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  . . . . . . . . . .  88         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88
198         6.8.3.  Getting amount of instrument directories  . . . . . .  89         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  . . . . . .  90         6.8.5.  Getting instrument directory information  . . . . . .  90
201         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91         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 . . . . . . . .  93         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  . . .  95         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 . . . . . . . . . . . .  97         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  . . . . . . . . . . .  98         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  . . . . . . . . . . . . . . . . 101         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 102
213         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102         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 . . . . . . . . . . . . . . . . . 103         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103
216         6.8.21. Getting job status information  . . . . . . . . . . . 105         6.8.21. Getting job status information  . . . . . . . . . . . 106
217         6.8.22. Formatting the instruments database . . . . . . . . . 106         6.8.22. Formatting the instruments database . . . . . . . . . 107
218       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107
219         6.9.1.  Opening an appropriate instrument editor         6.9.1.  Opening an appropriate instrument editor
                application . . . . . . . . . . . . . . . . . . . . . 107  
   
   
   
 Schoenebeck              Expires April 17, 2008                 [Page 4]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
    7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 109  
      7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 122  
    8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 126  
      8.1.  Number of audio output devices changed  . . . . . . . . . 126  
      8.2.  Audio output device's settings changed  . . . . . . . . . 126  
      8.3.  Number of MIDI input devices changed  . . . . . . . . . . 126  
      8.4.  MIDI input device's settings changed  . . . . . . . . . . 127  
      8.5.  Number of sampler channels changed  . . . . . . . . . . . 127  
      8.6.  Number of active voices changed . . . . . . . . . . . . . 127  
      8.7.  Number of active disk streams changed . . . . . . . . . . 128  
      8.8.  Disk stream buffer fill state changed . . . . . . . . . . 128  
      8.9.  Channel information changed . . . . . . . . . . . . . . . 128  
      8.10. Number of effect sends changed  . . . . . . . . . . . . . 129  
      8.11. Effect send information changed . . . . . . . . . . . . . 129  
      8.12. Total number of active voices changed . . . . . . . . . . 129  
      8.13. Number of MIDI instrument maps changed  . . . . . . . . . 130  
      8.14. MIDI instrument map information changed . . . . . . . . . 130  
      8.15. Number of MIDI instruments changed  . . . . . . . . . . . 130  
      8.16. MIDI instrument information changed . . . . . . . . . . . 131  
      8.17. Global settings changed . . . . . . . . . . . . . . . . . 131  
      8.18. Number of database instrument directories changed . . . . 132  
      8.19. Database instrument directory information changed . . . . 132  
      8.20. Number of database instruments changed  . . . . . . . . . 133  
      8.21. Database instrument information changed . . . . . . . . . 133  
      8.22. Database job status information changed . . . . . . . . . 134  
      8.23. Miscellaneous and debugging events  . . . . . . . . . . . 134  
    9.  Security Considerations . . . . . . . . . . . . . . . . . . . 135  
    10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 136  
    11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 137  
    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 138  
    Intellectual Property and Copyright Statements  . . . . . . . . . 139  
220    
221    
222    
223    Schoenebeck               Expires June 7, 2008                  [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol        December 2007
226    
227    
228                   application . . . . . . . . . . . . . . . . . . . . . 107
229         6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 108
230           6.10.1. Retrieving amount of instruments of a file  . . . . . 109
231           6.10.2. Retrieving all instruments of a file  . . . . . . . . 109
232           6.10.3. Retrieving informations about one instrument in a
233                   file  . . . . . . . . . . . . . . . . . . . . . . . . 110
234       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 112
235         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 125
236       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
237         8.1.  Number of audio output devices changed  . . . . . . . . . 130
238         8.2.  Audio output device's settings changed  . . . . . . . . . 130
239         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 130
240         8.4.  MIDI input device's settings changed  . . . . . . . . . . 131
241         8.5.  Number of sampler channels changed  . . . . . . . . . . . 131
242         8.6.  Number of active voices changed . . . . . . . . . . . . . 131
243         8.7.  Number of active disk streams changed . . . . . . . . . . 132
244         8.8.  Disk stream buffer fill state changed . . . . . . . . . . 132
245         8.9.  Channel information changed . . . . . . . . . . . . . . . 132
246         8.10. Number of effect sends changed  . . . . . . . . . . . . . 133
247         8.11. Effect send information changed . . . . . . . . . . . . . 133
248         8.12. Total number of active voices changed . . . . . . . . . . 133
249         8.13. Total number of active disk streams changed . . . . . . . 134
250         8.14. Number of MIDI instrument maps changed  . . . . . . . . . 134
251         8.15. MIDI instrument map information changed . . . . . . . . . 134
252         8.16. Number of MIDI instruments changed  . . . . . . . . . . . 135
253         8.17. MIDI instrument information changed . . . . . . . . . . . 135
254         8.18. Global settings changed . . . . . . . . . . . . . . . . . 136
255         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 275  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279    Schoenebeck               Expires June 7, 2008                  [Page 5]
280    
281  Schoenebeck              Expires April 17, 2008                 [Page 5]  Internet-Draft        LinuxSampler Control Protocol        December 2007
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck              Expires April 17, 2008                 [Page 6]  Schoenebeck               Expires June 7, 2008                  [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 363  Internet-Draft        LinuxSampler Contr
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 Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck              Expires April 17, 2008                 [Page 7]  Schoenebeck               Expires June 7, 2008                  [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck              Expires April 17, 2008                 [Page 8]  Schoenebeck               Expires June 7, 2008                  [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck              Expires April 17, 2008                 [Page 9]  Schoenebeck               Expires June 7, 2008                  [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck              Expires April 17, 2008                [Page 10]  Schoenebeck               Expires June 7, 2008                 [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck              Expires April 17, 2008                [Page 11]  Schoenebeck               Expires June 7, 2008                 [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck              Expires April 17, 2008                [Page 12]  Schoenebeck               Expires June 7, 2008                 [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck              Expires April 17, 2008                [Page 13]  Schoenebeck               Expires June 7, 2008                 [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck              Expires April 17, 2008                [Page 14]  Schoenebeck               Expires June 7, 2008                 [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck              Expires April 17, 2008                [Page 15]  Schoenebeck               Expires June 7, 2008                 [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck              Expires April 17, 2008                [Page 16]  Schoenebeck               Expires June 7, 2008                 [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck              Expires April 17, 2008                [Page 17]  Schoenebeck               Expires June 7, 2008                 [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck              Expires April 17, 2008                [Page 18]  Schoenebeck               Expires June 7, 2008                 [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck              Expires April 17, 2008                [Page 19]  Schoenebeck               Expires June 7, 2008                 [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck              Expires April 17, 2008                [Page 20]  Schoenebeck               Expires June 7, 2008                 [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck              Expires April 17, 2008                [Page 21]  Schoenebeck               Expires June 7, 2008                 [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck              Expires April 17, 2008                [Page 22]  Schoenebeck               Expires June 7, 2008                 [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck              Expires April 17, 2008                [Page 23]  Schoenebeck               Expires June 7, 2008                 [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck              Expires April 17, 2008                [Page 24]  Schoenebeck               Expires June 7, 2008                 [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck              Expires April 17, 2008                [Page 25]  Schoenebeck               Expires June 7, 2008                 [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck              Expires April 17, 2008                [Page 26]  Schoenebeck               Expires June 7, 2008                 [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck              Expires April 17, 2008                [Page 27]  Schoenebeck               Expires June 7, 2008                 [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck              Expires April 17, 2008                [Page 28]  Schoenebeck               Expires June 7, 2008                 [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck              Expires April 17, 2008                [Page 29]  Schoenebeck               Expires June 7, 2008                 [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck              Expires April 17, 2008                [Page 30]  Schoenebeck               Expires June 7, 2008                 [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck              Expires April 17, 2008                [Page 31]  Schoenebeck               Expires June 7, 2008                 [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck              Expires April 17, 2008                [Page 32]  Schoenebeck               Expires June 7, 2008                 [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck              Expires April 17, 2008                [Page 33]  Schoenebeck               Expires June 7, 2008                 [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck              Expires April 17, 2008                [Page 34]  Schoenebeck               Expires June 7, 2008                 [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck              Expires April 17, 2008                [Page 35]  Schoenebeck               Expires June 7, 2008                 [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck              Expires April 17, 2008                [Page 36]  Schoenebeck               Expires June 7, 2008                 [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck              Expires April 17, 2008                [Page 37]  Schoenebeck               Expires June 7, 2008                 [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck              Expires April 17, 2008                [Page 38]  Schoenebeck               Expires June 7, 2008                 [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck              Expires April 17, 2008                [Page 39]  Schoenebeck               Expires June 7, 2008                 [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck              Expires April 17, 2008                [Page 40]  Schoenebeck               Expires June 7, 2008                 [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol         October 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 Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck              Expires April 17, 2008                [Page 41]  Schoenebeck               Expires June 7, 2008                 [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol         October 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 2348  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck              Expires April 17, 2008                [Page 42]  Schoenebeck               Expires June 7, 2008                 [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2354    
2355    
2356        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck              Expires April 17, 2008                [Page 43]  Schoenebeck               Expires June 7, 2008                 [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2410    
2411    
2412     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 2431  Internet-Draft        LinuxSampler Contr Line 2431  Internet-Draft        LinuxSampler Contr
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 2449  Internet-Draft        LinuxSampler Contr Line 2457  Internet-Draft        LinuxSampler Contr
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
    sampler channel.  This command has (currently) no way to define or  
    force if a new engine instance should be created and assigned to the  
    given sampler channel or if an already existing instance of that  
    engine type, shared with other sampler channels, should be used.  
2460    
    Possible Answers:  
2461    
2462    
2463    Schoenebeck               Expires June 7, 2008                 [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol        December 2007
2466    
2467    
2468  Schoenebeck              Expires April 17, 2008                [Page 44]     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
2470  Internet-Draft        LinuxSampler Control Protocol         October 2007     given sampler channel or if an already existing instance of that
2471       engine type, shared with other sampler channels, should be used.
2472    
2473       Possible Answers:
2474    
2475        "OK" -        "OK" -
2476    
# Line 2503  Internet-Draft        LinuxSampler Contr Line 2510  Internet-Draft        LinuxSampler Contr
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 2513  Internet-Draft        LinuxSampler Contr Line 2531  Internet-Draft        LinuxSampler Contr
2531    
2532     Possible Answers:     Possible Answers:
2533    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2534        LinuxSampler will answer by returning a comma separated list with        LinuxSampler will answer by returning a comma separated list with
2535        all sampler channels numerical IDs.        all sampler channels numerical IDs.
2536    
# Line 2558  Internet-Draft        LinuxSampler Contr Line 2568  Internet-Draft        LinuxSampler Contr
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 2571  Internet-Draft        LinuxSampler Contr Line 2590  Internet-Draft        LinuxSampler Contr
2590    
2591    
2592    
   
 Schoenebeck              Expires April 17, 2008                [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
   
   
2593  6.4.6.  Removing a sampler channel  6.4.6.  Removing a sampler channel
2594    
2595     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
# Line 2611  Internet-Draft        LinuxSampler Contr Line 2622  Internet-Draft        LinuxSampler Contr
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 2625  Internet-Draft        LinuxSampler Contr Line 2647  Internet-Draft        LinuxSampler Contr
2647    
2648     Example:     Example:
2649    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2650        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2651    
2652        S: "4"        S: "4"
# Line 2667  Internet-Draft        LinuxSampler Contr Line 2681  Internet-Draft        LinuxSampler Contr
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 2682  Internet-Draft        LinuxSampler Contr Line 2704  Internet-Draft        LinuxSampler Contr
2704              arbitrary description text about the engine (note that the              arbitrary description text about the engine (note that the
2705              character string may contain escape sequences (Section 7.1))              character string may contain escape sequences (Section 7.1))
2706    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2707           VERSION -           VERSION -
2708    
2709              arbitrary character string regarding the engine's version              arbitrary character string regarding the engine's version
# Line 2722  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
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 2737  Internet-Draft        LinuxSampler Contr Line 2760  Internet-Draft        LinuxSampler Contr
2760              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2761              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2762              signal, "NONE" if there's no device connected to this              signal, "NONE" if there's no device connected to this
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 49]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2763              sampler channel              sampler channel
2764    
2765           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
# Line 2778  Internet-Draft        LinuxSampler Contr Line 2793  Internet-Draft        LinuxSampler Contr
2793              LSCP 1.2 this character string may contain escape sequences              LSCP 1.2 this character string may contain escape sequences
2794              (Section 7.1))              (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    
2806              integer values 0 to 100 indicating loading progress              integer values 0 to 100 indicating loading progress
# Line 2792  Internet-Draft        LinuxSampler Contr Line 2815  Internet-Draft        LinuxSampler Contr
2815              commands, "NONE" if there's no device connected to this              commands, "NONE" if there's no device connected to this
2816              sampler channel              sampler channel
2817    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2818           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2819    
2820              port number of the MIDI input device              port number of the MIDI input device
# Line 2836  Internet-Draft        LinuxSampler Contr Line 2850  Internet-Draft        LinuxSampler Contr
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 Contr Line 2869  Internet-Draft        LinuxSampler Contr
2869    
2870           "AUDIO_OUTPUT_DEVICE: 0"           "AUDIO_OUTPUT_DEVICE: 0"
2871    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2872           "AUDIO_OUTPUT_CHANNELS: 2"           "AUDIO_OUTPUT_CHANNELS: 2"
2873    
2874           "AUDIO_OUTPUT_ROUTING: 0,1"           "AUDIO_OUTPUT_ROUTING: 0,1"
# Line 2893  Internet-Draft        LinuxSampler Contr Line 2905  Internet-Draft        LinuxSampler Contr
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
    is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or  
    "LIST CHANNELS" (Section 6.4.4) command.  
   
    Possible Answers:  
2908    
       LinuxSampler will answer by returning the number of active voices  
       on that channel.  
2909    
    Example:  
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
2917       "LIST CHANNELS" (Section 6.4.4) command.
2918    
2919       Possible Answers:
2920    
2921  Schoenebeck              Expires April 17, 2008                [Page 52]        LinuxSampler will answer by returning the number of active voices
2922          on that channel.
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
2923    
2924       Example:
2925    
2926    
2927    
# Line 2951  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
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 Contr Line 2979  Internet-Draft        LinuxSampler Contr
2979        "NA" for *not available* in case the engine which is deployed        "NA" for *not available* in case the engine which is deployed
2980        doesn't support disk streaming.  Each entry in the answer list        doesn't support disk streaming.  Each entry in the answer list
2981        will begin with the stream's ID in brackets followed by the        will begin with the stream's ID in brackets followed by the
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2982        numerical representation of the fill size (either in bytes or        numerical representation of the fill size (either in bytes or
2983        percentage).  Note: due to efficiency reasons the fill states in        percentage).  Note: due to efficiency reasons the fill states in
2984        the response are not in particular order, thus the front-end has        the response are not in particular order, thus the front-end has
# Line 3005  Internet-Draft        LinuxSampler Contr Line 3015  Internet-Draft        LinuxSampler Contr
3015    
3016     Possible Answers:     Possible Answers:
3017    
       "OK" -  
3018    
          on success  
3019    
       "WRN:<warning-code>:<warning-message>" -  
3020    
          if audio output device was set, but there are noteworthy  
          issue(s) related, providing an appropriate warning code and  
          warning message  
3021    
3022    
3023    Schoenebeck               Expires June 7, 2008                 [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol        December 2007
3026    
3027    
3028          "OK" -
3029    
3030  Schoenebeck              Expires April 17, 2008                [Page 54]           on success
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
3031    
3032          "WRN:<warning-code>:<warning-message>" -
3033    
3034             if audio output device was set, but there are noteworthy
3035             issue(s) related, providing an appropriate warning code and
3036             warning message
3037    
3038        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3039    
# Line 3064  Internet-Draft        LinuxSampler Contr Line 3074  Internet-Draft        LinuxSampler Contr
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    
    Examples:  
3077    
3078    
3079    Schoenebeck               Expires June 7, 2008                 [Page 55]
3080    
3081  6.4.16.  Setting audio output channel  Internet-Draft        LinuxSampler Control Protocol        December 2007
3082    
    The front-end can alter the audio output channel on a specific  
    sampler channel by sending the following command:  
3083    
3084       Examples:
3085    
3086    
3087    
3088  Schoenebeck              Expires April 17, 2008                [Page 55]  6.4.16.  Setting audio output channel
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
3089    
3090       The front-end can alter the audio output channel on a specific
3091       sampler channel by sending the following command:
3092    
3093        SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>        SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>
3094        <audio-in>        <audio-in>
# Line 3120  Internet-Draft        LinuxSampler Contr Line 3129  Internet-Draft        LinuxSampler Contr
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
    the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)  
    command and <midi-device-id> is the numerical ID of the MIDI input  
    device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)  
    or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.  
3132    
    Possible Answers:  
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)
3141       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)
3143       or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3144    
3145  Schoenebeck              Expires April 17, 2008                [Page 56]     Possible Answers:
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
3146    
3147        "OK" -        "OK" -
3148    
# Line 3178  Internet-Draft        LinuxSampler Contr Line 3185  Internet-Draft        LinuxSampler Contr
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
          message  
3188    
       "ERR:<error-code>:<error-message>" -  
3189    
          in case it failed, providing an appropriate error code and  
          error message  
3190    
3191    Schoenebeck               Expires June 7, 2008                 [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol        December 2007
3194    
3195    
3196  Schoenebeck              Expires April 17, 2008                [Page 57]           message
3197    
3198  Internet-Draft        LinuxSampler Control Protocol         October 2007        "ERR:<error-code>:<error-message>" -
3199    
3200             in case it failed, providing an appropriate error code and
3201             error message
3202    
3203     Examples:     Examples:
3204    
# Line 3233  Internet-Draft        LinuxSampler Contr Line 3240  Internet-Draft        LinuxSampler Contr
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    
       SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>  
3243    
    Where <midi-input-chan> is the number of the new MIDI input channel  
    where <sampler-channel> should listen to or "ALL" to listen on all 16  
    MIDI channels.  
3244    
    Possible Answers:  
3245    
3246    
3247    Schoenebeck               Expires June 7, 2008                 [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol        December 2007
3250    
3251    
3252  Schoenebeck              Expires April 17, 2008                [Page 58]        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3253    
3254  Internet-Draft        LinuxSampler Control Protocol         October 2007     Where <midi-input-chan> is the number of the new MIDI input channel
3255       where <sampler-channel> should listen to or "ALL" to listen on all 16
3256       MIDI channels.
3257    
3258       Possible Answers:
3259    
3260        "OK" -        "OK" -
3261    
# Line 3288  Internet-Draft        LinuxSampler Contr Line 3296  Internet-Draft        LinuxSampler Contr
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 3297  Internet-Draft        LinuxSampler Contr Line 3314  Internet-Draft        LinuxSampler Contr
3314           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3315           error message           error message
3316    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3317     Examples:     Examples:
3318    
3319    
# Line 3342  Internet-Draft        LinuxSampler Contr Line 3351  Internet-Draft        LinuxSampler Contr
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 3354  Internet-Draft        LinuxSampler Contr Line 3373  Internet-Draft        LinuxSampler Contr
3373     (Section 6.4.4) command and <solo> should be replaced either by "1"     (Section 6.4.4) command and <solo> should be replaced either by "1"
3374     to solo the channel or "0" to unsolo the channel.     to solo the channel or "0" to unsolo the channel.
3375    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3376     Possible Answers:     Possible Answers:
3377    
3378        "OK" -        "OK" -
# Line 3396  Internet-Draft        LinuxSampler Contr Line 3408  Internet-Draft        LinuxSampler Contr
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 3409  Internet-Draft        LinuxSampler Contr Line 3430  Internet-Draft        LinuxSampler Contr
3430    
3431           You can assign a specific MIDI instrument map by replacing           You can assign a specific MIDI instrument map by replacing
3432           <map> with the respective numeric ID of the MIDI instrument map           <map> with the respective numeric ID of the MIDI instrument map
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3433           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3434           command.  Once that map will be deleted, the sampler channel           command.  Once that map will be deleted, the sampler channel
3435           would fall back to "NONE".           would fall back to "NONE".
# Line 3452  Internet-Draft        LinuxSampler Contr Line 3465  Internet-Draft        LinuxSampler Contr
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    
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     effect send entity.  The name does not have to be unique, but MUST be
3477     encapsulated into apostrophes and supports escape sequences as     encapsulated into apostrophes and supports escape sequences as
3478     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
# Line 3466  Internet-Draft        LinuxSampler Contr Line 3487  Internet-Draft        LinuxSampler Contr
3487     can alter the destination channels however with "SET FX_SEND     can alter the destination channels however with "SET FX_SEND
3488     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3489    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3490     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3491     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
3492     runtime performance, because for implementing channel effect sends,     runtime performance, because for implementing channel effect sends,
# Line 3506  Internet-Draft        LinuxSampler Contr Line 3520  Internet-Draft        LinuxSampler Contr
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 3522  Internet-Draft        LinuxSampler Contr Line 3545  Internet-Draft        LinuxSampler Contr
3545    
3546     Possible Answers:     Possible Answers:
3547    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3548        "OK" -        "OK" -
3549    
3550           on success           on success
# Line 3562  Internet-Draft        LinuxSampler Contr Line 3578  Internet-Draft        LinuxSampler Contr
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 3577  Internet-Draft        LinuxSampler Contr Line 3600  Internet-Draft        LinuxSampler Contr
3600     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3601     (Section 6.4.4) command.     (Section 6.4.4) command.
3602    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 64]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3603     Possible Answers:     Possible Answers:
3604    
3605        The sampler will answer by returning a comma separated list with        The sampler will answer by returning a comma separated list with
# Line 3618  Internet-Draft        LinuxSampler Contr Line 3633  Internet-Draft        LinuxSampler Contr
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 3633  Internet-Draft        LinuxSampler Contr Line 3656  Internet-Draft        LinuxSampler Contr
3656              a value between 0 and 127 reflecting the MIDI controller              a value between 0 and 127 reflecting the MIDI controller
3657              which is able to modify the effect send's send level              which is able to modify the effect send's send level
3658    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3659           LEVEL -           LEVEL -
3660    
3661              optionally dotted number reflecting the effect send's              optionally dotted number reflecting the effect send's
# Line 3673  Internet-Draft        LinuxSampler Contr Line 3688  Internet-Draft        LinuxSampler Contr
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 3690  Internet-Draft        LinuxSampler Contr Line 3714  Internet-Draft        LinuxSampler Contr
3714     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
3715     (Section 7.1)").     (Section 7.1)").
3716    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3717     Possible Answers:     Possible Answers:
3718    
3719        "OK" -        "OK" -
# Line 3728  Internet-Draft        LinuxSampler Contr Line 3745  Internet-Draft        LinuxSampler Contr
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 3746  Internet-Draft        LinuxSampler Contr Line 3771  Internet-Draft        LinuxSampler Contr
3771    
3772     Possible Answers:     Possible Answers:
3773    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3774        "OK" -        "OK" -
3775    
3776           on success           on success
# Line 3783  Internet-Draft        LinuxSampler Contr Line 3801  Internet-Draft        LinuxSampler Contr
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 3802  Internet-Draft        LinuxSampler Contr Line 3828  Internet-Draft        LinuxSampler Contr
3828           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3829           message           message
3830    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3831        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3832    
3833           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3838  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
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 3855  Internet-Draft        LinuxSampler Contr Line 3882  Internet-Draft        LinuxSampler Contr
3882    
3883     Example:     Example:
3884    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3885        C: "SET FX_SEND LEVEL 0 0 0.15"        C: "SET FX_SEND LEVEL 0 0 0.15"
3886    
3887        S: "OK"        S: "OK"
# Line 3895  Internet-Draft        LinuxSampler Contr Line 3912  Internet-Draft        LinuxSampler Contr
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 3912  Internet-Draft        LinuxSampler Contr Line 3938  Internet-Draft        LinuxSampler Contr
3938     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3939     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3940    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3941        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3942    
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
# Line 3952  Internet-Draft        LinuxSampler Contr Line 3969  Internet-Draft        LinuxSampler Contr
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 Contr Line 3994  Internet-Draft        LinuxSampler Contr
3994           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3995           message           message
3996    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3997        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3998    
3999           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 4006  Internet-Draft        LinuxSampler Contr Line 4023  Internet-Draft        LinuxSampler Contr
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 4024  Internet-Draft        LinuxSampler Contr Line 4051  Internet-Draft        LinuxSampler Contr
4051     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4052     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4053    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4054  6.6.  Global commands  6.6.  Global commands
4055    
4056     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
# Line 4061  Internet-Draft        LinuxSampler Contr Line 4079  Internet-Draft        LinuxSampler Contr
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    
 6.6.3.  Reset sampler  
4082    
    The front-end can reset the whole sampler by sending the following  
    command:  
4083    
       RESET  
4084    
    Possible Answers:  
4085    
       "OK" -  
4086    
4087           always  Schoenebeck               Expires June 7, 2008                 [Page 73]
4088    
4089     Examples:  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
4107       command:
4108    
4109          RESET
4110    
4111       Possible Answers:
4112    
4113          "OK" -
4114    
4115  Schoenebeck              Expires April 17, 2008                [Page 73]           always
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
4116    
4117       Examples:
4118    
4119  6.6.4.  General sampler informations  
4120    
4121    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:
# Line 4108  Internet-Draft        LinuxSampler Contr Line 4137  Internet-Draft        LinuxSampler Contr
4137    
4138           DESCRIPTION -           DESCRIPTION -
4139    
4140    
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              arbitrary textual description about the sampler (note that
4149              the character string may contain escape sequences              the character string may contain escape sequences
4150              (Section 7.1))              (Section 7.1))
# Line 4129  Internet-Draft        LinuxSampler Contr Line 4166  Internet-Draft        LinuxSampler Contr
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 4138  Internet-Draft        LinuxSampler Contr Line 4175  Internet-Draft        LinuxSampler Contr
4175    
4176     Possible Answers:     Possible Answers:
4177    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4178        The sampler will always answer by returning the optional dotted        The sampler will always answer by returning the optional dotted
4179        floating point coefficient, reflecting the current global volume        floating point coefficient, reflecting the current global volume
4180        attenuation.        attenuation.
# Line 4153  Internet-Draft        LinuxSampler Contr Line 4183  Internet-Draft        LinuxSampler Contr
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
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 4163  Internet-Draft        LinuxSampler Contr Line 4193  Internet-Draft        LinuxSampler Contr
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 4194  Internet-Draft        LinuxSampler Contr Line 4232  Internet-Draft        LinuxSampler Contr
4232     maps which define which instrument to load on which MIDI program     maps which define which instrument to load on which MIDI program
4233     change message.     change message.
4234    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4235     By default, that is when the sampler is launched, there is no map,     By default, that is when the sampler is launched, there is no map,
4236     thus the sampler will simply ignore all program change messages.  The     thus the sampler will simply ignore all program change messages.  The
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
# Line 4219  Internet-Draft        LinuxSampler Contr Line 4250  Internet-Draft        LinuxSampler Contr
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 4248  Internet-Draft        LinuxSampler Contr Line 4286  Internet-Draft        LinuxSampler Contr
4286    
4287        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4288    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4289        S: "OK[0]"        S: "OK[0]"
4290    
4291        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
# Line 4277  Internet-Draft        LinuxSampler Contr Line 4306  Internet-Draft        LinuxSampler Contr
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 4302  Internet-Draft        LinuxSampler Contr Line 4338  Internet-Draft        LinuxSampler Contr
4338    
4339        S: "OK"        S: "OK"
4340    
   
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4341  6.7.3.  Get amount of existing MIDI instrument maps  6.7.3.  Get amount of existing MIDI instrument maps
4342    
4343     The front-end can retrieve the current amount of MIDI instrument maps     The front-end can retrieve the current amount of MIDI instrument maps
# Line 4337  Internet-Draft        LinuxSampler Contr Line 4362  Internet-Draft        LinuxSampler Contr
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 4361  Internet-Draft        LinuxSampler Contr Line 4393  Internet-Draft        LinuxSampler Contr
4393     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4394     (Section 6.7.4) command.     (Section 6.7.4) command.
4395    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4396     Possible Answers:     Possible Answers:
4397    
4398        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 4394  Internet-Draft        LinuxSampler Contr Line 4418  Internet-Draft        LinuxSampler Contr
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 4417  Internet-Draft        LinuxSampler Contr Line 4448  Internet-Draft        LinuxSampler Contr
4448    
4449     Possible Answers:     Possible Answers:
4450    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4451        "OK" -        "OK" -
4452    
4453           on success           on success
# Line 4450  Internet-Draft        LinuxSampler Contr Line 4473  Internet-Draft        LinuxSampler Contr
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 Contr Line 4505  Internet-Draft        LinuxSampler Contr
4505           be freed from memory when not needed by any sampler channel           be freed from memory when not needed by any sampler channel
4506           anymore.           anymore.
4507    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4508        "ON_DEMAND_HOLD" -        "ON_DEMAND_HOLD" -
4509    
4510           The instrument will be loaded when needed, that is when           The instrument will be loaded when needed, that is when
# Line 4505  Internet-Draft        LinuxSampler Contr Line 4529  Internet-Draft        LinuxSampler Contr
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 4529  Internet-Draft        LinuxSampler Contr Line 4561  Internet-Draft        LinuxSampler Contr
4561     "Character Set and Escape Sequences (Section 7.1)") for the mapping     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4562     entry, useful for frontends for displaying an appropriate name for     entry, useful for frontends for displaying an appropriate name for
4563     mapped instruments (using "GET MIDI_INSTRUMENT INFO"     mapped instruments (using "GET MIDI_INSTRUMENT INFO"
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4564     (Section 6.7.11)).     (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
# Line 4560  Internet-Draft        LinuxSampler Contr Line 4584  Internet-Draft        LinuxSampler Contr
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 Contr Line 4618  Internet-Draft        LinuxSampler Contr
4618        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4619        'Silent Piano'"        'Silent Piano'"
4620    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4621        S: "OK"        S: "OK"
4622    
4623        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
# Line 4614  Internet-Draft        LinuxSampler Contr Line 4639  Internet-Draft        LinuxSampler Contr
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 4639  Internet-Draft        LinuxSampler Contr Line 4674  Internet-Draft        LinuxSampler Contr
4674     The front-end can query a list of all currently existing entries of     The front-end can query a list of all currently existing entries of
4675     all MIDI instrument maps by sending the following command:     all MIDI instrument maps by sending the following command:
4676    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4677        LIST MIDI_INSTRUMENTS ALL        LIST MIDI_INSTRUMENTS ALL
4678    
4679     Possible Answers:     Possible Answers:
# Line 4672  Internet-Draft        LinuxSampler Contr Line 4697  Internet-Draft        LinuxSampler Contr
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 4695  Internet-Draft        LinuxSampler Contr Line 4728  Internet-Draft        LinuxSampler Contr
4728    
4729        S: "OK"        S: "OK"
4730    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4731  6.7.11.  Get current settings of MIDI instrument map entry  6.7.11.  Get current settings of MIDI instrument map entry
4732    
4733     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
# Line 4730  Internet-Draft        LinuxSampler Contr Line 4753  Internet-Draft        LinuxSampler Contr
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. (note that this character string may contain escape           be unique. (note that this character string may contain escape
# Line 4753  Internet-Draft        LinuxSampler Contr Line 4784  Internet-Draft        LinuxSampler Contr
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 (note that this character string may contain           cannot be changed (note that this character string may contain
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 85]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4787           escape sequences (Section 7.1)).           escape sequences (Section 7.1)).
4788    
4789        "LOAD_MODE" -        "LOAD_MODE" -
# Line 4786  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809    
4810           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires June 7, 2008                 [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol        December 2007
4818    
4819    
4820           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
4821    
4822           "INSTRUMENT_NAME: Joe's Drumkit"           "INSTRUMENT_NAME: Joe's Drumkit"
# Line 4808  Internet-Draft        LinuxSampler Contr Line 4839  Internet-Draft        LinuxSampler Contr
4839     The front-end can clear all MIDI instrument maps, that is delete all     The front-end can clear all MIDI instrument maps, that is delete all
4840     entries of all maps by sending the following command:     entries of all maps by sending the following command:
4841    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4842        CLEAR MIDI_INSTRUMENTS ALL        CLEAR MIDI_INSTRUMENTS ALL
4843    
4844     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
# Line 4839  Internet-Draft        LinuxSampler Contr Line 4861  Internet-Draft        LinuxSampler Contr
4861    
4862        S: "OK"        S: "OK"
4863    
4864    
4865    
4866    
4867    
4868    
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
# Line 4866  Internet-Draft        LinuxSampler Contr Line 4900  Internet-Draft        LinuxSampler Contr
4900    
4901     Possible Answers:     Possible Answers:
4902    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4903        "OK" -        "OK" -
4904    
4905           on success           on success
# Line 4894  Internet-Draft        LinuxSampler Contr Line 4921  Internet-Draft        LinuxSampler Contr
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    
4924    
4925    
4926    
4927    Schoenebeck               Expires June 7, 2008                 [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol        December 2007
4930    
4931    
4932        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4933    
4934     Where <dir> is the absolute path name of the directory to delete.     Where <dir> is the absolute path name of the directory to delete.
# Line 4917  Internet-Draft        LinuxSampler Contr Line 4952  Internet-Draft        LinuxSampler Contr
4952    
4953        S: "OK"        S: "OK"
4954    
   
   
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4955  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
4956    
4957     The front-end can retrieve the current amount of directories in a     The front-end can retrieve the current amount of directories in a
# Line 4952  Internet-Draft        LinuxSampler Contr Line 4975  Internet-Draft        LinuxSampler Contr
4975    
4976     Example:     Example:
4977    
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        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4989    
4990        S: "2"        S: "2"
# Line 4977  Internet-Draft        LinuxSampler Contr Line 5010  Internet-Draft        LinuxSampler Contr
5010    
5011           if the given directory does not exist.           if the given directory does not exist.
5012    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5013     Example:     Example:
5014    
5015        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
# Line 5008  Internet-Draft        LinuxSampler Contr Line 5033  Internet-Draft        LinuxSampler Contr
5033    
5034     Possible Answers:     Possible Answers:
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires June 7, 2008                 [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol        December 2007
5042    
5043    
5044        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5045        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5046        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
# Line 5033  Internet-Draft        LinuxSampler Contr Line 5066  Internet-Draft        LinuxSampler Contr
5066    
5067     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5068    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5069     Example:     Example:
5070    
5071        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
# Line 5064  Internet-Draft        LinuxSampler Contr Line 5089  Internet-Draft        LinuxSampler Contr
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    
5092    
5093    
5094    
5095    Schoenebeck               Expires June 7, 2008                 [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol        December 2007
5098    
5099    
5100     Possible Answers:     Possible Answers:
5101    
5102        "OK" -        "OK" -
# Line 5087  Internet-Draft        LinuxSampler Contr Line 5120  Internet-Draft        LinuxSampler Contr
5120     The front-end can move a specific instrument directory by sending the     The front-end can move a specific instrument directory by sending the
5121     following command:     following command:
5122    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5123        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5124    
5125     Where <dir> is the absolute path name of the directory to move and     Where <dir> is the absolute path name of the directory to move and
# Line 5122  Internet-Draft        LinuxSampler Contr Line 5145  Internet-Draft        LinuxSampler Contr
5145    
5146        S: "OK"        S: "OK"
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires June 7, 2008                 [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol        December 2007
5154    
5155    
5156  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
5157    
5158     The front-end can copy a specific instrument directory by sending the     The front-end can copy a specific instrument directory by sending the
# Line 5145  Internet-Draft        LinuxSampler Contr Line 5176  Internet-Draft        LinuxSampler Contr
5176           exists in the destination directory.  Error is also thrown when           exists in the destination directory.  Error is also thrown when
5177           trying to copy a directory to a subdirectory of itself.           trying to copy a directory to a subdirectory of itself.
5178    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5179     Example:     Example:
5180    
5181        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
# Line 5178  Internet-Draft        LinuxSampler Contr Line 5201  Internet-Draft        LinuxSampler Contr
5201    
5202           on success           on success
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires June 7, 2008                 [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol        December 2007
5210    
5211    
5212        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5213    
5214           in case the given directory does not exists.           in case the given directory does not exists.
# Line 5201  Internet-Draft        LinuxSampler Contr Line 5232  Internet-Draft        LinuxSampler Contr
5232     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5233     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5234     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5235     form of "key1=val1 key2=val2 ...".  The following criterias are     form of "key1=val1 key2=val2 ...".  The following criterias are
5236     allowed:     allowed:
5237    
# Line 5234  Internet-Draft        LinuxSampler Contr Line 5257  Internet-Draft        LinuxSampler Contr
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
5260    
5261    
5262    
5263    Schoenebeck               Expires June 7, 2008                 [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol        December 2007
5266    
5267    
5268        are last modified before <date-before>.  If <date-before> is        are last modified before <date-before>.  If <date-before> is
5269        omitted, the search is restricted to directories, which are last        omitted, the search is restricted to directories, which are last
5270        modified after <date-after>.        modified after <date-after>.
# Line 5256  Internet-Draft        LinuxSampler Contr Line 5287  Internet-Draft        LinuxSampler Contr
5287    
5288        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5289    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5290           if the given directory does not exist.           if the given directory does not exist.
5291    
5292     Example:     Example:
# Line 5291  Internet-Draft        LinuxSampler Contr Line 5313  Internet-Draft        LinuxSampler Contr
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
5316    
5317    
5318    
5319    Schoenebeck               Expires June 7, 2008                 [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol        December 2007
5322    
5323    
5324     file is supplied, only the instruments in the specified file will be     file is supplied, only the instruments in the specified file will be
5325     added to the instruments database.  If the optional <instr_index>     added to the instruments database.  If the optional <instr_index>
5326     (the index of the instrument within the given file) is supplied too,     (the index of the instrument within the given file) is supplied too,
# Line 5311  Internet-Draft        LinuxSampler Contr Line 5341  Internet-Draft        LinuxSampler Contr
5341           Only the instruments in the specified directory will be added,           Only the instruments in the specified directory will be added,
5342           the instruments in the subdirectories will not be processed.           the instruments in the subdirectories will not be processed.
5343    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 95]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5344        "FLAT" -        "FLAT" -
5345    
5346           All instruments will be processed, including those in the           All instruments will be processed, including those in the
# Line 5348  Internet-Draft        LinuxSampler Contr Line 5368  Internet-Draft        LinuxSampler Contr
5368    
5369        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires June 7, 2008                 [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol        December 2007
5378    
5379    
5380           if an invalid path is specified.           if an invalid path is specified.
5381    
5382     Examples:     Examples:
# Line 5369  Internet-Draft        LinuxSampler Contr Line 5398  Internet-Draft        LinuxSampler Contr
5398    
5399     Possible Answers:     Possible Answers:
5400    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 96]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5401        "OK" -        "OK" -
5402    
5403           if the instrument is removed successfully           if the instrument is removed successfully
# Line 5405  Internet-Draft        LinuxSampler Contr Line 5426  Internet-Draft        LinuxSampler Contr
5426    
5427     Possible Answers:     Possible Answers:
5428    
5429    
5430    
5431    Schoenebeck               Expires June 7, 2008                 [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol        December 2007
5434    
5435    
5436        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5437    
5438        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5425  Internet-Draft        LinuxSampler Contr Line 5453  Internet-Draft        LinuxSampler Contr
5453        LIST DB_INSTRUMENTS [RECURSIVE] <dir>        LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5454    
5455     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5456     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
5457     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5458     specified directory, will be returned.     specified directory, will be returned.
# Line 5457  Internet-Draft        LinuxSampler Contr Line 5477  Internet-Draft        LinuxSampler Contr
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    
5480    
5481    
5482    
5483    
5484    
5485    
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  6.8.15.  Getting instrument information
5493    
5494     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
# Line 5482  Internet-Draft        LinuxSampler Contr Line 5514  Internet-Draft        LinuxSampler Contr
5514              File name of the instrument.  Note that the character string              File name of the instrument.  Note that the character string
5515              may contain escape sequences (Section 7.1).              may contain escape sequences (Section 7.1).
5516    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 98]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5517           INSTRUMENT_NR -           INSTRUMENT_NR -
5518    
5519              Index of the instrument within the file.              Index of the instrument within the file.
# Line 5511  Internet-Draft        LinuxSampler Contr Line 5536  Internet-Draft        LinuxSampler Contr
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    
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires June 7, 2008                 [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol        December 2007
5546    
5547    
5548           MODIFIED -           MODIFIED -
5549    
5550              The date and time of the last modification of the              The date and time of the last modification of the
# Line 5537  Internet-Draft        LinuxSampler Contr Line 5571  Internet-Draft        LinuxSampler Contr
5571              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5572              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5573    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 99]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
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.
# Line 5566  Internet-Draft        LinuxSampler Contr Line 5592  Internet-Draft        LinuxSampler Contr
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 5594  Internet-Draft        LinuxSampler Contr Line 5629  Internet-Draft        LinuxSampler Contr
5629     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
5630     is the new name for that instrument.     is the new name for that instrument.
5631    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5632     Possible Answers:     Possible Answers:
5633    
5634        "OK" -        "OK" -
# Line 5619  Internet-Draft        LinuxSampler Contr Line 5647  Internet-Draft        LinuxSampler Contr
5647    
5648        S: "OK"        S: "OK"
5649    
5650    
5651    
5652    
5653    
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  6.8.17.  Moving an instrument
5661    
5662     The front-end can move a specific instrument to another directory by     The front-end can move a specific instrument to another directory by
# Line 5648  Internet-Draft        LinuxSampler Contr Line 5686  Internet-Draft        LinuxSampler Contr
5686    
5687        S: "OK"        S: "OK"
5688    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 101]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5689  6.8.18.  Copying instruments  6.8.18.  Copying instruments
5690    
5691     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 5675  Internet-Draft        LinuxSampler Contr Line 5704  Internet-Draft        LinuxSampler Contr
5704    
5705        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5706    
5707    
5708    
5709    
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           in case the given instrument does not exists, or if an
5717           instrument with name equal to the name of the specified           instrument with name equal to the name of the specified
5718           instrument already exists in the destination directory.           instrument already exists in the destination directory.
# Line 5704  Internet-Draft        LinuxSampler Contr Line 5742  Internet-Draft        LinuxSampler Contr
5742    
5743           on success           on success
5744    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5745        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5746    
5747           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5732  Internet-Draft        LinuxSampler Contr Line 5761  Internet-Draft        LinuxSampler Contr
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 5762  Internet-Draft        LinuxSampler Contr Line 5799  Internet-Draft        LinuxSampler Contr
5799        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
5800        instruments created after <date-after>.        instruments created after <date-after>.
5801    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 103]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5802     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5803    
5804        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 5788  Internet-Draft        LinuxSampler Contr Line 5818  Internet-Draft        LinuxSampler Contr
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 (encapsulated into        satisfies the supplied search string (encapsulated into
5830        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 5818  Internet-Draft        LinuxSampler Contr Line 5855  Internet-Draft        LinuxSampler Contr
5855        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
5856        families.        families.
5857    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 104]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5858     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5859     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
5860    
# Line 5843  Internet-Draft        LinuxSampler Contr Line 5873  Internet-Draft        LinuxSampler Contr
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 5873  Internet-Draft        LinuxSampler Contr Line 5911  Internet-Draft        LinuxSampler Contr
5911    
5912           FILES_TOTAL -           FILES_TOTAL -
5913    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 105]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5914              The total number of files scheduled for scanning              The total number of files scheduled for scanning
5915    
5916           FILES_SCANNED -           FILES_SCANNED -
# Line 5900  Internet-Draft        LinuxSampler Contr Line 5930  Internet-Draft        LinuxSampler Contr
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 5928  Internet-Draft        LinuxSampler Contr Line 5965  Internet-Draft        LinuxSampler Contr
5965    
5966           on success           on success
5967    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 106]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5968        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5969    
5970           If the formatting of the instruments database failed.           If the formatting of the instruments database failed.
# Line 5958  Internet-Draft        LinuxSampler Contr Line 5986  Internet-Draft        LinuxSampler Contr
5986     The front-end can request to open an appropriate instrument editor     The front-end can request to open an appropriate instrument editor
5987     application by sending the following command:     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>        EDIT CHANNEL INSTRUMENT <sampler-channel>
5997    
5998     Where <sampler-channel> should be replaced by the number of the     Where <sampler-channel> should be replaced by the number of the
# Line 5984  Internet-Draft        LinuxSampler Contr Line 6019  Internet-Draft        LinuxSampler Contr
6019    
6020           when an appropriate instrument editor was launched           when an appropriate instrument editor was launched
6021    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 107]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6022        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
6023    
6024           when an appropriate instrument editor was launched, but there           when an appropriate instrument editor was launched, but there
# Line 6008  Internet-Draft        LinuxSampler Contr Line 6034  Internet-Draft        LinuxSampler Contr
6034    
6035        S: "OK"        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    
# Line 6043  Internet-Draft        LinuxSampler Contr Line 6212  Internet-Draft        LinuxSampler Contr
6212    
6213    
6214    
6215    Schoenebeck               Expires June 7, 2008                [Page 111]
6216    
6217  Schoenebeck              Expires April 17, 2008               [Page 108]  Internet-Draft        LinuxSampler Control Protocol        December 2007
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6218    
6219    
6220  7.  Command Syntax  7.  Command Syntax
# Line 6100  Internet-Draft        LinuxSampler Contr Line 6268  Internet-Draft        LinuxSampler Contr
6268    
6269    
6270    
6271  Schoenebeck              Expires April 17, 2008               [Page 109]  Schoenebeck               Expires June 7, 2008                [Page 112]
6272    
6273  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
6274    
6275    
6276        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6156  Internet-Draft        LinuxSampler Contr Line 6324  Internet-Draft        LinuxSampler Contr
6324    
6325    
6326    
6327  Schoenebeck              Expires April 17, 2008               [Page 110]  Schoenebeck               Expires June 7, 2008                [Page 113]
6328    
6329  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
6330    
6331    
6332        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
# Line 6212  Internet-Draft        LinuxSampler Contr Line 6380  Internet-Draft        LinuxSampler Contr
6380    
6381    
6382    
6383  Schoenebeck              Expires April 17, 2008               [Page 111]  Schoenebeck               Expires June 7, 2008                [Page 114]
6384    
6385  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
6386    
6387    
6388        / MISCELLANEOUS        / MISCELLANEOUS
6389    
6390          / TOTAL_STREAM_COUNT
6391    
6392        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6393    
6394        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6263  Internet-Draft        LinuxSampler Contr Line 6433  Internet-Draft        LinuxSampler Contr
6433    
6434        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
6435    
       / DB_INSTRUMENTS_JOB_INFO  
6436    
6437    
6438    
6439    Schoenebeck               Expires June 7, 2008                [Page 115]
6440    
6441  Schoenebeck              Expires April 17, 2008               [Page 112]  Internet-Draft        LinuxSampler Control Protocol        December 2007
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6442    
6443    
6444          / DB_INSTRUMENTS_JOB_INFO
6445    
6446        / MISCELLANEOUS        / MISCELLANEOUS
6447    
6448          / TOTAL_STREAM_COUNT
6449    
6450        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6451    
6452        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6316  Internet-Draft        LinuxSampler Contr Line 6488  Internet-Draft        LinuxSampler Contr
6488    
6489     get_instruction =     get_instruction =
6490    
       AVAILABLE_ENGINES  
6491    
       / AVAILABLE_MIDI_INPUT_DRIVERS  
6492    
6493    
6494    
6495    Schoenebeck               Expires June 7, 2008                [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol        December 2007
6498    
 Schoenebeck              Expires April 17, 2008               [Page 113]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6499    
6500          AVAILABLE_ENGINES
6501    
6502          / AVAILABLE_MIDI_INPUT_DRIVERS
6503    
6504        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
6505    
# Line 6372  Internet-Draft        LinuxSampler Contr Line 6544  Internet-Draft        LinuxSampler Contr
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    
6549    
6550    
6551    Schoenebeck               Expires June 7, 2008                [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol        December 2007
6554    
 Schoenebeck              Expires April 17, 2008               [Page 114]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6555    
6556          / ENGINE SP INFO SP engine_name
6557    
6558          / SERVER SP INFO
6559    
6560          / TOTAL_STREAM_COUNT
6561    
6562        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6563    
# Line 6419  Internet-Draft        LinuxSampler Contr Line 6593  Internet-Draft        LinuxSampler Contr
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    
       / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='  
       param_val_list  
   
       / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='  
       param_val_list  
6605    
       / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE  
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 '='
6613          param_val_list
6614    
6615  Schoenebeck              Expires April 17, 2008               [Page 115]        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6616          param_val_list
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
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
# Line 6480  Internet-Draft        LinuxSampler Contr Line 6656  Internet-Draft        LinuxSampler Contr
6656    
6657        / MIDI_INPUT_DEVICE SP string SP key_val_list        / MIDI_INPUT_DEVICE SP string SP key_val_list
6658    
       / MIDI_INPUT_DEVICE SP string  
6659    
       / FX_SEND SP sampler_channel SP midi_ctrl  
6660    
       / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name  
6661    
    reset_instruction =  
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
6669    
6670  Schoenebeck              Expires April 17, 2008               [Page 116]        / FX_SEND SP sampler_channel SP midi_ctrl
6671    
6672  Internet-Draft        LinuxSampler Control Protocol         October 2007        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6673    
6674       reset_instruction =
6675    
6676        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
6677    
# Line 6538  Internet-Draft        LinuxSampler Contr Line 6714  Internet-Draft        LinuxSampler Contr
6714    
6715     load_instruction =     load_instruction =
6716    
       INSTRUMENT SP load_instr_args  
6717    
       / ENGINE SP load_engine_args  
   
    set_chan_instruction =  
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
6725    
6726  Schoenebeck              Expires April 17, 2008               [Page 117]        / ENGINE SP load_engine_args
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6727    
6728       set_chan_instruction =
6729    
6730        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6731    
# Line 6594  Internet-Draft        LinuxSampler Contr Line 6768  Internet-Draft        LinuxSampler Contr
6768    
6769     modal_arg =     modal_arg =
6770    
       /* epsilon (empty argument) */  
6771    
       / NON_MODAL SP  
6772    
    key_val_list =  
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) */
6781    
6782  Schoenebeck              Expires April 17, 2008               [Page 118]        / NON_MODAL SP
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6783    
6784       key_val_list =
6785    
6786        string '=' param_val_list        string '=' param_val_list
6787    
# Line 6649  Internet-Draft        LinuxSampler Contr Line 6823  Internet-Draft        LinuxSampler Contr
6823    
6824        / DB_INSTRUMENTS SP db_path        / DB_INSTRUMENTS SP db_path
6825    
6826     load_instr_args =        / FILE SP INSTRUMENTS SP filename
6827    
       filename SP instrument_index SP sampler_channel  
6828    
       / NON_MODAL SP filename SP instrument_index SP sampler_channel  
6829    
    load_engine_args =  
6830    
6831    Schoenebeck               Expires June 7, 2008                [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol        December 2007
6834    
6835    
6836  Schoenebeck              Expires April 17, 2008               [Page 119]     load_instr_args =
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6837    
6838          filename SP instrument_index SP sampler_channel
6839    
6840          / NON_MODAL SP filename SP instrument_index SP sampler_channel
6841    
6842       load_engine_args =
6843    
6844        engine_name SP sampler_channel        engine_name SP sampler_channel
6845    
# Line 6705  Internet-Draft        LinuxSampler Contr Line 6881  Internet-Draft        LinuxSampler Contr
6881    
6882        number        number
6883    
    midi_bank =  
6884    
       number  
6885    
    midi_prog =  
6886    
6887        number  Schoenebeck               Expires June 7, 2008                [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol        December 2007
6890    
6891    
6892       midi_bank =
6893    
6894  Schoenebeck              Expires April 17, 2008               [Page 120]        number
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6895    
6896       midi_prog =
6897    
6898          number
6899    
6900     midi_ctrl =     midi_ctrl =
6901    
# Line 6761  Internet-Draft        LinuxSampler Contr Line 6937  Internet-Draft        LinuxSampler Contr
6937    
6938     entry_name =     entry_name =
6939    
       stringval_escaped  
6940    
    fx_send_name =  
6941    
       stringval_escaped  
6942    
6943     param_val_list =  Schoenebeck               Expires June 7, 2008                [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol        December 2007
6946    
6947    
6948          stringval_escaped
6949    
6950  Schoenebeck              Expires April 17, 2008               [Page 121]     fx_send_name =
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
6951    
6952          stringval_escaped
6953    
6954       param_val_list =
6955    
6956        param_val        param_val
6957    
# Line 6817  Internet-Draft        LinuxSampler Contr Line 6993  Internet-Draft        LinuxSampler Contr
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    
 Schoenebeck              Expires April 17, 2008               [Page 122]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
7003    
7004       younger protocols also support escape sequences, but only for
7005       certain, explicitly declared parts of the protocol.  The supported
7006       escape sequences are defined as follows:
7007    
7008     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
7009     | ASCII Character        | Translated into (Name)                   |     | ASCII Character        | Translated into (Name)                   |
# Line 6876  Internet-Draft        LinuxSampler Contr Line 7048  Internet-Draft        LinuxSampler Contr
7048    
7049        "GET CHANNEL INFO" (Section 6.4.10)        "GET CHANNEL INFO" (Section 6.4.10)
7050    
       "MAP MIDI_INSTRUMENT" (Section 6.7.7)  
7051    
       "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)  
7052    
7053    
7054    
7055    Schoenebeck               Expires June 7, 2008                [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol        December 2007
7058    
 Schoenebeck              Expires April 17, 2008               [Page 123]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
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)        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
7065    
# Line 6929  Internet-Draft        LinuxSampler Contr Line 7101  Internet-Draft        LinuxSampler Contr
7101    
7102        "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)        "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    
7116          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
7117    
7118     Note that the forward slash character ('/') has a special meaning in     Note that the forward slash character ('/') has a special meaning in
7119     filename / path based arguments: it acts as separator of the nodes in     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     the path, thus if a directory- or filename includes a forward slash
# Line 6936  Internet-Draft        LinuxSampler Contr Line 7122  Internet-Draft        LinuxSampler Contr
7122     either with the respective hex escape sequence ("\x2f") or with the     either with the respective hex escape sequence ("\x2f") or with the
7123     respective octal escape sequence ("\057").     respective octal escape sequence ("\057").
7124    
7125     The following LSCP commands even support escape sequences as part of     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  Schoenebeck              Expires April 17, 2008               [Page 124]     original Windows file path like "D:\Sounds\My.gig" would become in
7130       LSCP: "D:/Sounds/My.gig".
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
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,     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     description) and / or may contain escape sequences in at least one of
7135     their text-based fields in their response:     their text-based fields in their response:
7136    
7137        "GET SERVER INFO" (Section 6.6.4)        "GET SERVER INFO" (Section 6.6.5)
7138    
7139        "GET ENGINE INFO" (Section 6.4.9)        "GET ENGINE INFO" (Section 6.4.9)
7140    
# Line 6975  Internet-Draft        LinuxSampler Contr Line 7160  Internet-Draft        LinuxSampler Contr
7160    
7161        "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)        "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)        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7173    
7174        "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)        "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
# Line 6996  Internet-Draft        LinuxSampler Contr Line 7190  Internet-Draft        LinuxSampler Contr
7190    
7191    
7192    
7193  Schoenebeck              Expires April 17, 2008               [Page 125]  
7194    
7195  Internet-Draft        LinuxSampler Control Protocol         October 2007  
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 7052  Internet-Draft        LinuxSampler Contr Line 7276  Internet-Draft        LinuxSampler Contr
7276    
7277    
7278    
7279  Schoenebeck              Expires April 17, 2008               [Page 126]  Schoenebeck               Expires June 7, 2008                [Page 130]
7280    
7281  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7282    
7283    
7284        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 7108  Internet-Draft        LinuxSampler Contr Line 7332  Internet-Draft        LinuxSampler Contr
7332    
7333    
7334    
7335  Schoenebeck              Expires April 17, 2008               [Page 127]  Schoenebeck               Expires June 7, 2008                [Page 131]
7336    
7337  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7338    
7339    
7340        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
# Line 7164  Internet-Draft        LinuxSampler Contr Line 7388  Internet-Draft        LinuxSampler Contr
7388    
7389    
7390    
7391  Schoenebeck              Expires April 17, 2008               [Page 128]  Schoenebeck               Expires June 7, 2008                [Page 132]
7392    
7393  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7394    
7395    
7396        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 7220  Internet-Draft        LinuxSampler Contr Line 7444  Internet-Draft        LinuxSampler Contr
7444    
7445    
7446    
7447  Schoenebeck              Expires April 17, 2008               [Page 129]  Schoenebeck               Expires June 7, 2008                [Page 133]
7448    
7449  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7450    
7451    
7452        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
# Line 7234  Internet-Draft        LinuxSampler Contr Line 7458  Internet-Draft        LinuxSampler Contr
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 7248  Internet-Draft        LinuxSampler Contr Line 7486  Internet-Draft        LinuxSampler Contr
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 7257  Internet-Draft        LinuxSampler Contr Line 7495  Internet-Draft        LinuxSampler Contr
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 7267  Internet-Draft        LinuxSampler Contr Line 7515  Internet-Draft        LinuxSampler Contr
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 April 17, 2008               [Page 130]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 7291  Internet-Draft        LinuxSampler Contr Line 7530  Internet-Draft        LinuxSampler Contr
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 7311  Internet-Draft        LinuxSampler Contr Line 7550  Internet-Draft        LinuxSampler Contr
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 7326  Internet-Draft        LinuxSampler Contr Line 7576  Internet-Draft        LinuxSampler Contr
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 April 17, 2008               [Page 131]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 7356  Internet-Draft        LinuxSampler Contr Line 7595  Internet-Draft        LinuxSampler Contr
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 7370  Internet-Draft        LinuxSampler Contr Line 7609  Internet-Draft        LinuxSampler Contr
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 7382  Internet-Draft        LinuxSampler Contr Line 7629  Internet-Draft        LinuxSampler Contr
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 April 17, 2008               [Page 132]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 7412  Internet-Draft        LinuxSampler Contr Line 7648  Internet-Draft        LinuxSampler Contr
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 7429  Internet-Draft        LinuxSampler Contr Line 7665  Internet-Draft        LinuxSampler Contr
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 April 17, 2008               [Page 133]        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 7467  Internet-Draft        LinuxSampler Contr Line 7700  Internet-Draft        LinuxSampler Contr
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 7491  Internet-Draft        LinuxSampler Contr Line 7724  Internet-Draft        LinuxSampler Contr
7724    
7725    
7726    
7727    Schoenebeck               Expires June 7, 2008                [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol        December 2007
   
   
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 134]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
7730    
7731    
7732  9.  Security Considerations  9.  Security Considerations
# Line 7556  Internet-Draft        LinuxSampler Contr Line 7780  Internet-Draft        LinuxSampler Contr
7780    
7781    
7782    
7783  Schoenebeck              Expires April 17, 2008               [Page 135]  Schoenebeck               Expires June 7, 2008                [Page 139]
7784    
7785  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7786    
7787    
7788  10.  Acknowledgments  10.  Acknowledgments
# Line 7612  Internet-Draft        LinuxSampler Contr Line 7836  Internet-Draft        LinuxSampler Contr
7836    
7837    
7838    
7839  Schoenebeck              Expires April 17, 2008               [Page 136]  Schoenebeck               Expires June 7, 2008                [Page 140]
7840    
7841  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7842    
7843    
7844  11.  References  11.  References
# Line 7668  Internet-Draft        LinuxSampler Contr Line 7892  Internet-Draft        LinuxSampler Contr
7892    
7893    
7894    
7895  Schoenebeck              Expires April 17, 2008               [Page 137]  Schoenebeck               Expires June 7, 2008                [Page 141]
7896    
7897  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7898    
7899    
7900  Author's Address  Author's Address
# Line 7724  Author's Address Line 7948  Author's Address
7948    
7949    
7950    
7951  Schoenebeck              Expires April 17, 2008               [Page 138]  Schoenebeck               Expires June 7, 2008                [Page 142]
7952    
7953  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7954    
7955    
7956  Full Copyright Statement  Full Copyright Statement
# Line 7780  Acknowledgment Line 8004  Acknowledgment
8004    
8005    
8006    
8007  Schoenebeck              Expires April 17, 2008               [Page 139]  Schoenebeck               Expires June 7, 2008                [Page 143]
8008    
8009    
Legend:
Removed from v.1430  
changed lines
  Added in v.1572
  ViewVC Help
Powered by ViewVC