/[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 1363 by schoenebeck, Sun Sep 30 21:51: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: March 4, 2008                                    September 2007  Expires: June 7, 2008                                   December 5, 2007
8    
9    
10                   LinuxSampler Control Protocol (draft)                       LinuxSampler Control Protocol
11                                LSCP 1.2cvs                                  LSCP 1.3
12    
13  Status of this Memo  Status of this Memo
14    
# Line 33  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on March 4, 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 March 4, 2008                 [Page 1]  Schoenebeck               Expires June 7, 2008                  [Page 1]
56    
57  Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 March 4, 2008                 [Page 2]  Schoenebeck               Expires June 7, 2008                  [Page 2]
112    
113  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.  Getting all created MIDI input device list  . . . . .  37
# Line 124  Internet-Draft    LinuxSampler Control P Line 124  Internet-Draft    LinuxSampler Control P
124         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126         6.4.3.  Getting all created sampler channel count . . . . . .  45         6.4.3.  Getting all created sampler channel count . . . . . .  45
127         6.4.4.  Getting all created sampler channel list  . . . . . .  45         6.4.4.  Getting all created sampler channel list  . . . . . .  46
128         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  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 Control P Line 136  Internet-Draft    LinuxSampler Control P
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 March 4, 2008                 [Page 3]  Schoenebeck               Expires June 7, 2008                  [Page 3]
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
168    
169    Internet-Draft        LinuxSampler Control Protocol        December 2007
170    
171         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72  
172           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 . . . . .  77         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  78
185         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78
186         6.7.5.  Getting MIDI instrument map information . . . . . . .  78         6.7.5.  Getting MIDI instrument map information . . . . . . .  79
187         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  80
188         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80         6.7.7.  Create or replace a MIDI instrument map entry . . . .  80
189         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  83
190         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
191                 instrument map  . . . . . . . . . . . . . . . . . . .  83                 instrument map  . . . . . . . . . . . . . . . . . . .  84
192         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84         6.7.10. Remove an entry from the MIDI instrument map  . . . .  84
193         6.7.11. Get current settings of MIDI instrument map entry . .  84         6.7.11. Get current settings of MIDI instrument map entry . .  85
194         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  87
195       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  88
196         6.8.1.  Creating a new instrument directory . . . . . . . . .  87         6.8.1.  Creating a new instrument directory . . . . . . . . .  88
197         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88
198         6.8.3.  Getting amount of instrument directories  . . . . . .  88         6.8.3.  Getting amount of instrument directories  . . . . . .  89
199         6.8.4.  Listing all directories in specific directory . . . .  89         6.8.4.  Listing all directories in specific directory . . . .  90
200         6.8.5.  Getting instrument directory information  . . . . . .  89         6.8.5.  Getting instrument directory information  . . . . . .  90
201         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91
202         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  92
203         6.8.8.  Copying instrument directories  . . . . . . . . . . .  92         6.8.8.  Copying instrument directories  . . . . . . . . . . .  93
204         6.8.9.  Changing the description of directory . . . . . . . .  92         6.8.9.  Changing the description of directory . . . . . . . .  93
205         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  94
206         6.8.11. Adding instruments to the instruments database  . . .  94         6.8.11. Adding instruments to the instruments database  . . .  95
207         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  97
208         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96         6.8.13. Getting amount of instruments . . . . . . . . . . . .  97
209         6.8.14. Listing all instruments in specific directory . . . .  97         6.8.14. Listing all instruments in specific directory . . . .  98
210         6.8.15. Getting instrument information  . . . . . . . . . . .  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 . . . . . . . . . . . . . . . . . 101         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102
214         6.8.19. Changing the description of instrument  . . . . . . . 102         6.8.19. Changing the description of instrument  . . . . . . . 103
215         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103
216         6.8.21. Getting job status information  . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . . . 106       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107
219         6.9.1.  Opening an appropriate instrument editor         6.9.1.  Opening an appropriate instrument editor
                application . . . . . . . . . . . . . . . . . . . . . 106  
   
   
   
 Schoenebeck               Expires March 4, 2008                 [Page 4]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
    7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 108  
      7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 121  
    8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 123  
      8.1.  Number of audio output devices changed  . . . . . . . . . 123  
      8.2.  Audio output device's settings changed  . . . . . . . . . 123  
      8.3.  Number of MIDI input devices changed  . . . . . . . . . . 123  
      8.4.  MIDI input device's settings changed  . . . . . . . . . . 124  
      8.5.  Number of sampler channels changed  . . . . . . . . . . . 124  
      8.6.  Number of active voices changed . . . . . . . . . . . . . 124  
      8.7.  Number of active disk streams changed . . . . . . . . . . 125  
      8.8.  Disk stream buffer fill state changed . . . . . . . . . . 125  
      8.9.  Channel information changed . . . . . . . . . . . . . . . 125  
      8.10. Number of effect sends changed  . . . . . . . . . . . . . 126  
      8.11. Effect send information changed . . . . . . . . . . . . . 126  
      8.12. Total number of active voices changed . . . . . . . . . . 126  
      8.13. Number of MIDI instrument maps changed  . . . . . . . . . 127  
      8.14. MIDI instrument map information changed . . . . . . . . . 127  
      8.15. Number of MIDI instruments changed  . . . . . . . . . . . 127  
      8.16. MIDI instrument information changed . . . . . . . . . . . 128  
      8.17. Global settings changed . . . . . . . . . . . . . . . . . 128  
      8.18. Number of database instrument directories changed . . . . 129  
      8.19. Database instrument directory information changed . . . . 129  
      8.20. Number of database instruments changed  . . . . . . . . . 130  
      8.21. Database instrument information changed . . . . . . . . . 130  
      8.22. Database job status information changed . . . . . . . . . 131  
      8.23. Miscellaneous and debugging events  . . . . . . . . . . . 131  
    9.  Security Considerations . . . . . . . . . . . . . . . . . . . 132  
    10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 133  
    11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 134  
    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 135  
    Intellectual Property and Copyright Statements  . . . . . . . . . 136  
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 Control P Line 276  Internet-Draft    LinuxSampler Control P
276    
277    
278    
279    Schoenebeck               Expires June 7, 2008                  [Page 5]
280    
281  Schoenebeck               Expires March 4, 2008                 [Page 5]  Internet-Draft        LinuxSampler Control Protocol        December 2007
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft    LinuxSampler Control P Line 332  Internet-Draft    LinuxSampler Control P
332    
333    
334    
335  Schoenebeck               Expires March 4, 2008                 [Page 6]  Schoenebeck               Expires June 7, 2008                  [Page 6]
336    
337  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 363  Internet-Draft    LinuxSampler Control P Line 363  Internet-Draft    LinuxSampler Control P
363         sampler's LSCP minor version.         sampler's LSCP minor version.
364    
365     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
366     frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get     frontend can use the "GET SERVER INFO" (Section 6.6.5) command to get
367     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
368    
369    
# Line 388  Internet-Draft    LinuxSampler Control P Line 388  Internet-Draft    LinuxSampler Control P
388    
389    
390    
391  Schoenebeck               Expires March 4, 2008                 [Page 7]  Schoenebeck               Expires June 7, 2008                  [Page 7]
392    
393  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft    LinuxSampler Control P Line 444  Internet-Draft    LinuxSampler Control P
444    
445    
446    
447  Schoenebeck               Expires March 4, 2008                 [Page 8]  Schoenebeck               Expires June 7, 2008                  [Page 8]
448    
449  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft    LinuxSampler Control P Line 500  Internet-Draft    LinuxSampler Control P
500    
501    
502    
503  Schoenebeck               Expires March 4, 2008                 [Page 9]  Schoenebeck               Expires June 7, 2008                  [Page 9]
504    
505  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft    LinuxSampler Control P Line 556  Internet-Draft    LinuxSampler Control P
556    
557    
558    
559  Schoenebeck               Expires March 4, 2008                [Page 10]  Schoenebeck               Expires June 7, 2008                 [Page 10]
560    
561  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft    LinuxSampler Control P Line 612  Internet-Draft    LinuxSampler Control P
612    
613    
614    
615  Schoenebeck               Expires March 4, 2008                [Page 11]  Schoenebeck               Expires June 7, 2008                 [Page 11]
616    
617  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft    LinuxSampler Control P Line 668  Internet-Draft    LinuxSampler Control P
668    
669    
670    
671  Schoenebeck               Expires March 4, 2008                [Page 12]  Schoenebeck               Expires June 7, 2008                 [Page 12]
672    
673  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft    LinuxSampler Control P Line 724  Internet-Draft    LinuxSampler Control P
724    
725    
726    
727  Schoenebeck               Expires March 4, 2008                [Page 13]  Schoenebeck               Expires June 7, 2008                 [Page 13]
728    
729  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft    LinuxSampler Control P Line 780  Internet-Draft    LinuxSampler Control P
780    
781    
782    
783  Schoenebeck               Expires March 4, 2008                [Page 14]  Schoenebeck               Expires June 7, 2008                 [Page 14]
784    
785  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft    LinuxSampler Control P Line 836  Internet-Draft    LinuxSampler Control P
836    
837    
838    
839  Schoenebeck               Expires March 4, 2008                [Page 15]  Schoenebeck               Expires June 7, 2008                 [Page 15]
840    
841  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft    LinuxSampler Control P Line 892  Internet-Draft    LinuxSampler Control P
892    
893    
894    
895  Schoenebeck               Expires March 4, 2008                [Page 16]  Schoenebeck               Expires June 7, 2008                 [Page 16]
896    
897  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft    LinuxSampler Control P Line 948  Internet-Draft    LinuxSampler Control P
948    
949    
950    
951  Schoenebeck               Expires March 4, 2008                [Page 17]  Schoenebeck               Expires June 7, 2008                 [Page 17]
952    
953  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft    LinuxSampler Control P Line 1004  Internet-Draft    LinuxSampler Control P
1004    
1005    
1006    
1007  Schoenebeck               Expires March 4, 2008                [Page 18]  Schoenebeck               Expires June 7, 2008                 [Page 18]
1008    
1009  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft    LinuxSampler Control P Line 1060  Internet-Draft    LinuxSampler Control P
1060    
1061    
1062    
1063  Schoenebeck               Expires March 4, 2008                [Page 19]  Schoenebeck               Expires June 7, 2008                 [Page 19]
1064    
1065  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft    LinuxSampler Control P Line 1116  Internet-Draft    LinuxSampler Control P
1116    
1117    
1118    
1119  Schoenebeck               Expires March 4, 2008                [Page 20]  Schoenebeck               Expires June 7, 2008                 [Page 20]
1120    
1121  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft    LinuxSampler Control P Line 1172  Internet-Draft    LinuxSampler Control P
1172    
1173    
1174    
1175  Schoenebeck               Expires March 4, 2008                [Page 21]  Schoenebeck               Expires June 7, 2008                 [Page 21]
1176    
1177  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft    LinuxSampler Control P Line 1228  Internet-Draft    LinuxSampler Control P
1228    
1229    
1230    
1231  Schoenebeck               Expires March 4, 2008                [Page 22]  Schoenebeck               Expires June 7, 2008                 [Page 22]
1232    
1233  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft    LinuxSampler Control P Line 1284  Internet-Draft    LinuxSampler Control P
1284    
1285    
1286    
1287  Schoenebeck               Expires March 4, 2008                [Page 23]  Schoenebeck               Expires June 7, 2008                 [Page 23]
1288    
1289  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft    LinuxSampler Control P Line 1340  Internet-Draft    LinuxSampler Control P
1340    
1341    
1342    
1343  Schoenebeck               Expires March 4, 2008                [Page 24]  Schoenebeck               Expires June 7, 2008                 [Page 24]
1344    
1345  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft    LinuxSampler Control P Line 1396  Internet-Draft    LinuxSampler Control P
1396    
1397    
1398    
1399  Schoenebeck               Expires March 4, 2008                [Page 25]  Schoenebeck               Expires June 7, 2008                 [Page 25]
1400    
1401  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft    LinuxSampler Control P Line 1452  Internet-Draft    LinuxSampler Control P
1452    
1453    
1454    
1455  Schoenebeck               Expires March 4, 2008                [Page 26]  Schoenebeck               Expires June 7, 2008                 [Page 26]
1456    
1457  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft    LinuxSampler Control P Line 1508  Internet-Draft    LinuxSampler Control P
1508    
1509    
1510    
1511  Schoenebeck               Expires March 4, 2008                [Page 27]  Schoenebeck               Expires June 7, 2008                 [Page 27]
1512    
1513  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft    LinuxSampler Control P Line 1564  Internet-Draft    LinuxSampler Control P
1564    
1565    
1566    
1567  Schoenebeck               Expires March 4, 2008                [Page 28]  Schoenebeck               Expires June 7, 2008                 [Page 28]
1568    
1569  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft    LinuxSampler Control P Line 1620  Internet-Draft    LinuxSampler Control P
1620    
1621    
1622    
1623  Schoenebeck               Expires March 4, 2008                [Page 29]  Schoenebeck               Expires June 7, 2008                 [Page 29]
1624    
1625  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft    LinuxSampler Control P Line 1676  Internet-Draft    LinuxSampler Control P
1676    
1677    
1678    
1679  Schoenebeck               Expires March 4, 2008                [Page 30]  Schoenebeck               Expires June 7, 2008                 [Page 30]
1680    
1681  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft    LinuxSampler Control P Line 1732  Internet-Draft    LinuxSampler Control P
1732    
1733    
1734    
1735  Schoenebeck               Expires March 4, 2008                [Page 31]  Schoenebeck               Expires June 7, 2008                 [Page 31]
1736    
1737  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft    LinuxSampler Control P Line 1788  Internet-Draft    LinuxSampler Control P
1788    
1789    
1790    
1791  Schoenebeck               Expires March 4, 2008                [Page 32]  Schoenebeck               Expires June 7, 2008                 [Page 32]
1792    
1793  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft    LinuxSampler Control P Line 1844  Internet-Draft    LinuxSampler Control P
1844    
1845    
1846    
1847  Schoenebeck               Expires March 4, 2008                [Page 33]  Schoenebeck               Expires June 7, 2008                 [Page 33]
1848    
1849  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft    LinuxSampler Control P Line 1900  Internet-Draft    LinuxSampler Control P
1900    
1901    
1902    
1903  Schoenebeck               Expires March 4, 2008                [Page 34]  Schoenebeck               Expires June 7, 2008                 [Page 34]
1904    
1905  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft    LinuxSampler Control P Line 1956  Internet-Draft    LinuxSampler Control P
1956    
1957    
1958    
1959  Schoenebeck               Expires March 4, 2008                [Page 35]  Schoenebeck               Expires June 7, 2008                 [Page 35]
1960    
1961  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft    LinuxSampler Control P Line 2012  Internet-Draft    LinuxSampler Control P
2012    
2013    
2014    
2015  Schoenebeck               Expires March 4, 2008                [Page 36]  Schoenebeck               Expires June 7, 2008                 [Page 36]
2016    
2017  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft    LinuxSampler Control P Line 2068  Internet-Draft    LinuxSampler Control P
2068    
2069    
2070    
2071  Schoenebeck               Expires March 4, 2008                [Page 37]  Schoenebeck               Expires June 7, 2008                 [Page 37]
2072    
2073  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft    LinuxSampler Control P Line 2124  Internet-Draft    LinuxSampler Control P
2124    
2125    
2126    
2127  Schoenebeck               Expires March 4, 2008                [Page 38]  Schoenebeck               Expires June 7, 2008                 [Page 38]
2128    
2129  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft    LinuxSampler Control P Line 2180  Internet-Draft    LinuxSampler Control P
2180    
2181    
2182    
2183  Schoenebeck               Expires March 4, 2008                [Page 39]  Schoenebeck               Expires June 7, 2008                 [Page 39]
2184    
2185  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft    LinuxSampler Control P Line 2236  Internet-Draft    LinuxSampler Control P
2236    
2237    
2238    
2239  Schoenebeck               Expires March 4, 2008                [Page 40]  Schoenebeck               Expires June 7, 2008                 [Page 40]
2240    
2241  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft    LinuxSampler Control P Line 2292  Internet-Draft    LinuxSampler Control P
2292    
2293    
2294    
2295  Schoenebeck               Expires March 4, 2008                [Page 41]  Schoenebeck               Expires June 7, 2008                 [Page 41]
2296    
2297  Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 2348  Internet-Draft    LinuxSampler Control P
2348    
2349    
2350    
2351  Schoenebeck               Expires March 4, 2008                [Page 42]  Schoenebeck               Expires June 7, 2008                 [Page 42]
2352    
2353  Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 2404  Internet-Draft    LinuxSampler Control P
2404    
2405    
2406    
2407  Schoenebeck               Expires March 4, 2008                [Page 43]  Schoenebeck               Expires June 7, 2008                 [Page 43]
2408    
2409  Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 2431  Internet-Draft    LinuxSampler Control P
2431           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2432           error message           error message
2433    
2434     Example:     Example (Unix):
2435    
2436          C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
2437    
2438          S: OK
2439    
2440       Example (Windows):
2441    
2442          C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
2443    
2444          S: OK
2445    
2446  6.4.2.  Loading a sampler engine  6.4.2.  Loading a sampler engine
2447    
# Line 2449  Internet-Draft    LinuxSampler Control P Line 2457  Internet-Draft    LinuxSampler Control P
2457     be assigned to.  This command should be issued after adding a new     be assigned to.  This command should be issued after adding a new
2458     sampler channel and before any other control commands on the new     sampler channel and before any other control commands on the new
2459     sampler channel.  It can also be used to change the engine type of a     sampler channel.  It can also be used to change the engine type of a
    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 March 4, 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 (draft)   September 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 Control P Line 2510  Internet-Draft    LinuxSampler Control P
2510    
2511        S: "12"        S: "12"
2512    
2513    
2514    
2515    
2516    
2517    
2518    
2519    Schoenebeck               Expires June 7, 2008                 [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol        December 2007
2522    
2523    
2524  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2525    
2526     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
# Line 2513  Internet-Draft    LinuxSampler Control P Line 2531  Internet-Draft    LinuxSampler Control P
2531    
2532     Possible Answers:     Possible Answers:
2533    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 45]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 2568  Internet-Draft    LinuxSampler Control P
2568    
2569        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck               Expires June 7, 2008                 [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol        December 2007
2578    
2579    
2580           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2581           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2582           code and warning message           code and warning message
# Line 2571  Internet-Draft    LinuxSampler Control P Line 2590  Internet-Draft    LinuxSampler Control P
2590    
2591    
2592    
   
 Schoenebeck               Expires March 4, 2008                [Page 46]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 2622  Internet-Draft    LinuxSampler Control P
2622    
2623    
2624    
2625    
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck               Expires June 7, 2008                 [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol        December 2007
2634    
2635    
2636  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
2637    
2638     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
# Line 2625  Internet-Draft    LinuxSampler Control P Line 2647  Internet-Draft    LinuxSampler Control P
2647    
2648     Example:     Example:
2649    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 47]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
2650        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2651    
2652        S: "4"        S: "4"
# Line 2667  Internet-Draft    LinuxSampler Control P Line 2681  Internet-Draft    LinuxSampler Control P
2681     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2682     AVAILABLE_ENGINES" (Section 6.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2683    
2684    
2685    
2686    
2687    Schoenebeck               Expires June 7, 2008                 [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol        December 2007
2690    
2691    
2692     Possible Answers:     Possible Answers:
2693    
2694        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 2679  Internet-Draft    LinuxSampler Control P Line 2701  Internet-Draft    LinuxSampler Control P
2701    
2702           DESCRIPTION -           DESCRIPTION -
2703    
2704              arbitrary description text about the engine              arbitrary description text about the engine (note that the
2705                character string may contain escape sequences (Section 7.1))
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 48]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
2706    
2707           VERSION -           VERSION -
2708    
# Line 2722  Internet-Draft    LinuxSampler Control P Line 2737  Internet-Draft    LinuxSampler Control P
2737        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
2738        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
2739        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2740    
2741    
2742    
2743    Schoenebeck               Expires June 7, 2008                 [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol        December 2007
2746    
2747    
2748        following categories are defined:        following categories are defined:
2749    
2750    
# Line 2737  Internet-Draft    LinuxSampler Control P Line 2760  Internet-Draft    LinuxSampler Control P
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 March 4, 2008                [Page 49]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
2763              sampler channel              sampler channel
2764    
2765           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
# Line 2764  Internet-Draft    LinuxSampler Control P Line 2779  Internet-Draft    LinuxSampler Control P
2779           INSTRUMENT_FILE -           INSTRUMENT_FILE -
2780    
2781              the file name of the loaded instrument, "NONE" if there's no              the file name of the loaded instrument, "NONE" if there's no
2782              instrument yet loaded for this sampler channel              instrument yet loaded for this sampler channel (note: since
2783                LSCP 1.2 this path may contain escape sequences
2784                (Section 7.1))
2785    
2786           INSTRUMENT_NR -           INSTRUMENT_NR -
2787    
# Line 2772  Internet-Draft    LinuxSampler Control P Line 2789  Internet-Draft    LinuxSampler Control P
2789    
2790           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2791    
2792              the instrument name of the loaded instrument              the instrument name of the loaded instrument (note: since
2793                LSCP 1.2 this character string may contain escape sequences
2794                (Section 7.1))
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires June 7, 2008                 [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol        December 2007
2802    
2803    
2804           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2805    
# Line 2792  Internet-Draft    LinuxSampler Control P Line 2819  Internet-Draft    LinuxSampler Control P
2819    
2820              port number of the MIDI input device              port number of the MIDI input device
2821    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 50]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
2822           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2823    
2824              the MIDI input channel number this sampler channel should              the MIDI input channel number this sampler channel should
# Line 2832  Internet-Draft    LinuxSampler Control P Line 2850  Internet-Draft    LinuxSampler Control P
2850              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2851              values.              values.
2852    
2853    
2854    
2855    Schoenebeck               Expires June 7, 2008                 [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol        December 2007
2858    
2859    
2860     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2861    
2862     Example:     Example:
# Line 2848  Internet-Draft    LinuxSampler Control P Line 2873  Internet-Draft    LinuxSampler Control P
2873    
2874           "AUDIO_OUTPUT_ROUTING: 0,1"           "AUDIO_OUTPUT_ROUTING: 0,1"
2875    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 51]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
2876           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2877    
2878           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
# Line 2889  Internet-Draft    LinuxSampler Control P Line 2905  Internet-Draft    LinuxSampler Control P
2905        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2906    
2907     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
    is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or  
    "LIST CHANNELS" (Section 6.4.4) command.  
   
    Possible Answers:  
   
       LinuxSampler will answer by returning the number of active voices  
       on that channel.  
   
    Example:  
2908    
2909    
2910    
2911    Schoenebeck               Expires June 7, 2008                 [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol        December 2007
2914    
2915    
2916       is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2917       "LIST CHANNELS" (Section 6.4.4) command.
2918    
2919       Possible Answers:
2920    
2921          LinuxSampler will answer by returning the number of active voices
2922          on that channel.
2923    
2924       Example:
2925    
 Schoenebeck               Expires March 4, 2008                [Page 52]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
2926    
2927    
2928  6.4.12.  Current number of active disk streams  6.4.12.  Current number of active disk streams
# Line 2949  Internet-Draft    LinuxSampler Control P Line 2961  Internet-Draft    LinuxSampler Control P
2961     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
2962     sampler channel number the front-end is interested in as returned by     sampler channel number the front-end is interested in as returned by
2963     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2964    
2965    
2966    
2967    Schoenebeck               Expires June 7, 2008                 [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol        December 2007
2970    
2971    
2972     command.     command.
2973    
2974     Possible Answers:     Possible Answers:
# Line 2961  Internet-Draft    LinuxSampler Control P Line 2981  Internet-Draft    LinuxSampler Control P
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
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
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 53]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
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
2985        to sort them by itself if necessary.        to sort them by itself if necessary.
2986    
# Line 3003  Internet-Draft    LinuxSampler Control P Line 3015  Internet-Draft    LinuxSampler Control P
3015    
3016     Possible Answers:     Possible Answers:
3017    
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck               Expires June 7, 2008                 [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol        December 2007
3026    
3027    
3028        "OK" -        "OK" -
3029    
3030           on success           on success
# Line 3018  Internet-Draft    LinuxSampler Control P Line 3040  Internet-Draft    LinuxSampler Control P
3040           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3041           error message           error message
3042    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 54]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3043     Examples:     Examples:
3044    
3045    
# Line 3059  Internet-Draft    LinuxSampler Control P Line 3074  Internet-Draft    LinuxSampler Control P
3074           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3075           error message           error message
3076    
3077    
3078    
3079    Schoenebeck               Expires June 7, 2008                 [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol        December 2007
3082    
3083    
3084     Examples:     Examples:
3085    
3086    
# Line 3073  Internet-Draft    LinuxSampler Control P Line 3095  Internet-Draft    LinuxSampler Control P
3095    
3096     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3097     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 55]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3098     command, <audio-out> is the numerical ID of the sampler channel's     command, <audio-out> is the numerical ID of the sampler channel's
3099     audio output channel which should be rerouted and <audio-in> is the     audio output channel which should be rerouted and <audio-in> is the
3100     numerical ID of the audio channel of the selected audio output device     numerical ID of the audio channel of the selected audio output device
# Line 3115  Internet-Draft    LinuxSampler Control P Line 3129  Internet-Draft    LinuxSampler Control P
3129        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3130    
3131     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
3132    
3133    
3134    
3135    Schoenebeck               Expires June 7, 2008                 [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol        December 2007
3138    
3139    
3140     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3141     command and <midi-device-id> is the numerical ID of the MIDI input     command and <midi-device-id> is the numerical ID of the MIDI input
3142     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
# Line 3128  Internet-Draft    LinuxSampler Control P Line 3150  Internet-Draft    LinuxSampler Control P
3150    
3151        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3152    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 56]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3153           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
3154           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3155           message           message
# Line 3172  Internet-Draft    LinuxSampler Control P Line 3185  Internet-Draft    LinuxSampler Control P
3185    
3186           if MIDI input type was set, but there are noteworthy issue(s)           if MIDI input type was set, but there are noteworthy issue(s)
3187           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
          message  
3188    
       "ERR:<error-code>:<error-message>" -  
   
          in case it failed, providing an appropriate error code and  
          error message  
3189    
    Examples:  
3190    
3191    Schoenebeck               Expires June 7, 2008                 [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol        December 2007
3194    
3195    
3196             message
3197    
3198          "ERR:<error-code>:<error-message>" -
3199    
3200             in case it failed, providing an appropriate error code and
3201             error message
3202    
3203       Examples:
3204    
 Schoenebeck               Expires March 4, 2008                [Page 57]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
3205    
3206    
3207  6.4.19.  Setting MIDI input port  6.4.19.  Setting MIDI input port
# Line 3229  Internet-Draft    LinuxSampler Control P Line 3240  Internet-Draft    LinuxSampler Control P
3240     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3241     listen to by sending the following command:     listen to by sending the following command:
3242    
3243    
3244    
3245    
3246    
3247    Schoenebeck               Expires June 7, 2008                 [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol        December 2007
3250    
3251    
3252        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3253    
3254     Where <midi-input-chan> is the number of the new MIDI input channel     Where <midi-input-chan> is the number of the new MIDI input channel
# Line 3241  Internet-Draft    LinuxSampler Control P Line 3261  Internet-Draft    LinuxSampler Control P
3261    
3262           on success           on success
3263    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 58]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3264        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3265    
3266           if MIDI input channel was set, but there are noteworthy           if MIDI input channel was set, but there are noteworthy
# Line 3284  Internet-Draft    LinuxSampler Control P Line 3296  Internet-Draft    LinuxSampler Control P
3296    
3297        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3298    
          if channel volume was set, but there are noteworthy issue(s)  
          related, providing an appropriate warning code and warning  
          message  
3299    
       "ERR:<error-code>:<error-message>" -  
3300    
          in case it failed, providing an appropriate error code and  
          error message  
3301    
    Examples:  
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)
3309             related, providing an appropriate warning code and warning
3310             message
3311    
3312          "ERR:<error-code>:<error-message>" -
3313    
3314  Schoenebeck               Expires March 4, 2008                [Page 59]           in case it failed, providing an appropriate error code and
3315             error message
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
3316    
3317       Examples:
3318    
3319    
3320    
# Line 3340  Internet-Draft    LinuxSampler Control P Line 3351  Internet-Draft    LinuxSampler Control P
3351    
3352    
3353    
3354    
3355    
3356    
3357    
3358    
3359    Schoenebeck               Expires June 7, 2008                 [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol        December 2007
3362    
3363    
3364  6.4.23.  Soloing a sampler channel  6.4.23.  Soloing a sampler channel
3365    
3366     The front-end can solo/unsolo a specific sampler channel by sending     The front-end can solo/unsolo a specific sampler channel by sending
# Line 3354  Internet-Draft    LinuxSampler Control P Line 3375  Internet-Draft    LinuxSampler Control P
3375    
3376     Possible Answers:     Possible Answers:
3377    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 60]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3378        "OK" -        "OK" -
3379    
3380           on success           on success
# Line 3394  Internet-Draft    LinuxSampler Control P Line 3408  Internet-Draft    LinuxSampler Control P
3408    
3409        "NONE" -        "NONE" -
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires June 7, 2008                 [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol        December 2007
3418    
3419    
3420           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
3421           is not assigned any MIDI instrument map and thus will ignore           is not assigned any MIDI instrument map and thus will ignore
3422           all MIDI program change messages.           all MIDI program change messages.
# Line 3409  Internet-Draft    LinuxSampler Control P Line 3432  Internet-Draft    LinuxSampler Control P
3432           <map> with the respective numeric ID of the MIDI instrument map           <map> with the respective numeric ID of the MIDI instrument map
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
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 61]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3435           would fall back to "NONE".           would fall back to "NONE".
3436    
3437     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
# Line 3450  Internet-Draft    LinuxSampler Control P Line 3465  Internet-Draft    LinuxSampler Control P
3465     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3466     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3467     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3468     effect send entity.  The name does not have to be unique.  
3469    
3470    
3471    Schoenebeck               Expires June 7, 2008                 [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol        December 2007
3474    
3475    
3476       effect send entity.  The name does not have to be unique, but MUST be
3477       encapsulated into apostrophes and supports escape sequences as
3478       described in chapter "Character Set and Escape Sequences
3479       (Section 7.1)".
3480    
3481     By default, that is as initial routing, the effect send's audio     By default, that is as initial routing, the effect send's audio
3482     channels are automatically routed to the last audio channels of the     channels are automatically routed to the last audio channels of the
# Line 3465  Internet-Draft    LinuxSampler Control P Line 3491  Internet-Draft    LinuxSampler Control P
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,
3493     separate (sampler channel local) audio buffers are needed to render     separate (sampler channel local) audio buffers are needed to render
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 62]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3494     and mix the voices and route the audio signal afterwards to the     and mix the voices and route the audio signal afterwards to the
3495     master outputs and effect send outputs (along with their respective     master outputs and effect send outputs (along with their respective
3496     effect send levels).  A sampler channel without effect sends however     effect send levels).  A sampler channel without effect sends however
# Line 3502  Internet-Draft    LinuxSampler Control P Line 3520  Internet-Draft    LinuxSampler Control P
3520    
3521        S: "OK[1]"        S: "OK[1]"
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck               Expires June 7, 2008                 [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol        December 2007
3530    
3531    
3532  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
3533    
3534     The front-end can remove an existing effect send on a specific     The front-end can remove an existing effect send on a specific
# Line 3520  Internet-Draft    LinuxSampler Control P Line 3547  Internet-Draft    LinuxSampler Control P
3547    
3548        "OK" -        "OK" -
3549    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 63]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3550           on success           on success
3551    
3552        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3560  Internet-Draft    LinuxSampler Control P Line 3578  Internet-Draft    LinuxSampler Control P
3578    
3579     Example:     Example:
3580    
3581    
3582    
3583    Schoenebeck               Expires June 7, 2008                 [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol        December 2007
3586    
3587    
3588        C: "GET FX_SENDS 0"        C: "GET FX_SENDS 0"
3589    
3590        S: "2"        S: "2"
# Line 3577  Internet-Draft    LinuxSampler Control P Line 3602  Internet-Draft    LinuxSampler Control P
3602    
3603     Possible Answers:     Possible Answers:
3604    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 64]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3605        The sampler will answer by returning a comma separated list with        The sampler will answer by returning a comma separated list with
3606        all effect sends' numerical IDs on the given sampler channel.        all effect sends' numerical IDs on the given sampler channel.
3607    
# Line 3616  Internet-Draft    LinuxSampler Control P Line 3633  Internet-Draft    LinuxSampler Control P
3633        The sampler will answer by sending a <CRLF> separated list.  Each        The sampler will answer by sending a <CRLF> separated list.  Each
3634        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
3635        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
3636    
3637    
3638    
3639    Schoenebeck               Expires June 7, 2008                 [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol        December 2007
3642    
3643    
3644        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
3645        following categories are defined:        following categories are defined:
3646    
# Line 3623  Internet-Draft    LinuxSampler Control P Line 3648  Internet-Draft    LinuxSampler Control P
3648    
3649           NAME -           NAME -
3650    
3651              name of the effect send entity              name of the effect send entity (note that this character
3652                string may contain escape sequences (Section 7.1))
3653    
3654           MIDI_CONTROLLER -           MIDI_CONTROLLER -
3655    
# Line 3632  Internet-Draft    LinuxSampler Control P Line 3658  Internet-Draft    LinuxSampler Control P
3658    
3659           LEVEL -           LEVEL -
3660    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 65]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3661              optionally dotted number reflecting the effect send's              optionally dotted number reflecting the effect send's
3662              current send level (where a value < 1.0 means attenuation              current send level (where a value < 1.0 means attenuation
3663              and a value > 1.0 means amplification)              and a value > 1.0 means amplification)
# Line 3671  Internet-Draft    LinuxSampler Control P Line 3688  Internet-Draft    LinuxSampler Control P
3688    
3689           "."           "."
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires June 7, 2008                 [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol        December 2007
3698    
3699    
3700  6.4.30.  Changing effect send's name  6.4.30.  Changing effect send's name
3701    
3702     The front-end can alter the current name of an effect send entity by     The front-end can alter the current name of an effect send entity by
# Line 3683  Internet-Draft    LinuxSampler Control P Line 3709  Internet-Draft    LinuxSampler Control P
3709     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3710     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3711     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3712     effect send entity, which does not have to be unique.     effect send entity, which does not have to be unique (name MUST be
3713       encapsulated into apostrophes and supports escape sequences as
3714       described in chapter "Character Set and Escape Sequences
3715       (Section 7.1)").
3716    
3717     Possible Answers:     Possible Answers:
3718    
   
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 66]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3719        "OK" -        "OK" -
3720    
3721           on success           on success
# Line 3726  Internet-Draft    LinuxSampler Control P Line 3745  Internet-Draft    LinuxSampler Control P
3745     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3746     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3747     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3748    
3749    
3750    
3751    Schoenebeck               Expires June 7, 2008                 [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol        December 2007
3754    
3755    
3756     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
3757     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
3758     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.
# Line 3744  Internet-Draft    LinuxSampler Control P Line 3771  Internet-Draft    LinuxSampler Control P
3771    
3772     Possible Answers:     Possible Answers:
3773    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 67]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
3774        "OK" -        "OK" -
3775    
3776           on success           on success
# Line 3783  Internet-Draft    LinuxSampler Control P Line 3801  Internet-Draft    LinuxSampler Control P
3801        ctrl>        ctrl>
3802    
3803     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3804    
3805    
3806    
3807    Schoenebeck               Expires June 7, 2008                 [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol        December 2007
3810    
3811    
3812     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3813     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3814     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
# Line 3802  Internet-Draft    LinuxSampler Control P Line 3828  Internet-Draft    LinuxSampler Control P
3828           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3829           message           message
3830    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 68]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 3857  Internet-Draft    LinuxSampler Control P
3857    
3858     Possible Answers:     Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires June 7, 2008                 [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol        December 2007
3866    
3867    
3868        "OK" -        "OK" -
3869    
3870           on success           on success
# Line 3855  Internet-Draft    LinuxSampler Control P Line 3882  Internet-Draft    LinuxSampler Control P
3882    
3883     Example:     Example:
3884    
   
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 69]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 3912  Internet-Draft    LinuxSampler Control P
3912    
3913        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3914    
3915    
3916    
3917    
3918    
3919    Schoenebeck               Expires June 7, 2008                 [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol        December 2007
3922    
3923    
3924           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3925           error message           error message
3926    
# Line 3912  Internet-Draft    LinuxSampler Control P Line 3938  Internet-Draft    LinuxSampler Control P
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 March 4, 2008                [Page 70]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 3969  Internet-Draft    LinuxSampler Control P
3969     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
3970     event messages anymore by sending the following command:     event messages anymore by sending the following command:
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires June 7, 2008                 [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol        December 2007
3978    
3979    
3980        UNSUBSCRIBE <event-id>        UNSUBSCRIBE <event-id>
3981    
3982     Where <event-id> will be replaced by the respective event that client     Where <event-id> will be replaced by the respective event that client
# Line 3969  Internet-Draft    LinuxSampler Control P Line 3994  Internet-Draft    LinuxSampler Control P
3994           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3995           message           message
3996    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 71]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 4023  Internet-Draft    LinuxSampler Control P
4023    
4024           usually           usually
4025    
4026    
4027    
4028    
4029    
4030    
4031    Schoenebeck               Expires June 7, 2008                 [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol        December 2007
4034    
4035    
4036        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4037    
4038           on syntax error, e.g. non boolean value           on syntax error, e.g. non boolean value
# Line 4024  Internet-Draft    LinuxSampler Control P Line 4051  Internet-Draft    LinuxSampler Control P
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 March 4, 2008                [Page 72]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 4079  Internet-Draft    LinuxSampler Control P
4079        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4080        voices.        voices.
4081    
 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  Schoenebeck               Expires March 4, 2008                [Page 73]        RESET
4110    
4111  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007     Possible Answers:
4112    
4113          "OK" -
4114    
4115             always
4116    
4117       Examples:
4118    
4119    
4120  6.6.4.  General sampler informations  
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 Control P Line 4137  Internet-Draft    LinuxSampler Control P
4137    
4138           DESCRIPTION -           DESCRIPTION -
4139    
4140              arbitrary textual description about the sampler  
4141    
4142    
4143    Schoenebeck               Expires June 7, 2008                 [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol        December 2007
4146    
4147    
4148                arbitrary textual description about the sampler (note that
4149                the character string may contain escape sequences
4150                (Section 7.1))
4151    
4152           VERSION -           VERSION -
4153    
# Line 4127  Internet-Draft    LinuxSampler Control P Line 4166  Internet-Draft    LinuxSampler Control P
4166     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4167     Other fields might be added in future.     Other fields might be added in future.
4168    
4169  6.6.5.  Getting global volume attenuation  6.6.6.  Getting global volume attenuation
4170    
4171     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
4172     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4136  Internet-Draft    LinuxSampler Control P Line 4175  Internet-Draft    LinuxSampler Control P
4175    
4176     Possible Answers:     Possible Answers:
4177    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 74]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 4183  Internet-Draft    LinuxSampler Control P
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 Control P Line 4193  Internet-Draft    LinuxSampler Control P
4193     Where <volume> should be replaced by the optional dotted floating     Where <volume> should be replaced by the optional dotted floating
4194     point value, reflecting the new global volume parameter.  This value     point value, reflecting the new global volume parameter.  This value
4195     might usually be in the range between 0.0 and 1.0, that is for     might usually be in the range between 0.0 and 1.0, that is for
4196    
4197    
4198    
4199    Schoenebeck               Expires June 7, 2008                 [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol        December 2007
4202    
4203    
4204     attenuating the overall volume.     attenuating the overall volume.
4205    
4206     Possible Answers:     Possible Answers:
# Line 4194  Internet-Draft    LinuxSampler Control P Line 4232  Internet-Draft    LinuxSampler Control P
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 March 4, 2008                [Page 75]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 Control P Line 4250  Internet-Draft    LinuxSampler Control P
4250     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4251     current MIDI instrument map.     current MIDI instrument map.
4252    
4253    
4254    
4255    Schoenebeck               Expires June 7, 2008                 [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol        December 2007
4258    
4259    
4260  6.7.1.  Create a new MIDI instrument map  6.7.1.  Create a new MIDI instrument map
4261    
4262     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
# Line 4227  Internet-Draft    LinuxSampler Control P Line 4265  Internet-Draft    LinuxSampler Control P
4265        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4266    
4267     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
4268     to the new map.  MIDI instrument Map names do not have to be unique.     to the new map.  MIDI instrument Map names do not have to be unique,
4269       but MUST be encapsulated into apostrophes and support escape
4270       sequences as described in chapter "Character Set and Escape Sequences
4271       (Section 7.1)".
4272    
4273     Possible Answers:     Possible Answers:
4274    
# Line 4247  Internet-Draft    LinuxSampler Control P Line 4288  Internet-Draft    LinuxSampler Control P
4288    
4289        S: "OK[0]"        S: "OK[0]"
4290    
   
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 76]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4291        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4292    
4293        S: "OK[1]"        S: "OK[1]"
# Line 4275  Internet-Draft    LinuxSampler Control P Line 4306  Internet-Draft    LinuxSampler Control P
4306     Where <map> reflects the unique ID of the map to delete as returned     Where <map> reflects the unique ID of the map to delete as returned
4307     by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.     by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4308    
4309    
4310    
4311    Schoenebeck               Expires June 7, 2008                 [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol        December 2007
4314    
4315    
4316     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4317     following command:     following command:
4318    
# Line 4305  Internet-Draft    LinuxSampler Control P Line 4343  Internet-Draft    LinuxSampler Control P
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
4344     by sending the following command:     by sending the following command:
4345    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 77]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4346        GET MIDI_INSTRUMENT_MAPS        GET MIDI_INSTRUMENT_MAPS
4347    
4348     Possible Answers:     Possible Answers:
# Line 4332  Internet-Draft    LinuxSampler Control P Line 4362  Internet-Draft    LinuxSampler Control P
4362     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4363     following command:     following command:
4364    
4365    
4366    
4367    Schoenebeck               Expires June 7, 2008                 [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol        December 2007
4370    
4371    
4372        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4373    
4374     Possible Answers:     Possible Answers:
# Line 4361  Internet-Draft    LinuxSampler Control P Line 4398  Internet-Draft    LinuxSampler Control P
4398        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4399        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
4400        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 78]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4401        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
4402        following categories are defined:        following categories are defined:
4403    
# Line 4377  Internet-Draft    LinuxSampler Control P Line 4406  Internet-Draft    LinuxSampler Control P
4406           NAME -           NAME -
4407    
4408              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
4409              unique              unique (note that this character string may contain escape
4410                sequences (Section 7.1))
4411    
4412           DEFAULT -           DEFAULT -
4413    
# Line 4388  Internet-Draft    LinuxSampler Control P Line 4418  Internet-Draft    LinuxSampler Control P
4418    
4419     Example:     Example:
4420    
4421    
4422    
4423    Schoenebeck               Expires June 7, 2008                 [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol        December 2007
4426    
4427    
4428        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4429    
4430        S: "NAME: Standard Map"        S: "NAME: Standard Map"
# Line 4404  Internet-Draft    LinuxSampler Control P Line 4441  Internet-Draft    LinuxSampler Control P
4441        SET MIDI_INSTRUMENT_MAP NAME <map> <name>        SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4442    
4443     Where <map> is the numerical ID of the map and <name> the new custom     Where <map> is the numerical ID of the map and <name> the new custom
4444     name of the map, which does not have to be unique.     name of the map, which does not have to be unique (name MUST be
4445       encapsulated into apostrophes and supports escape sequences as
4446       described in chapter "Character Set and Escape Sequences
4447       (Section 7.1)").
4448    
4449     Possible Answers:     Possible Answers:
4450    
# Line 4418  Internet-Draft    LinuxSampler Control P Line 4458  Internet-Draft    LinuxSampler Control P
4458    
4459     Example:     Example:
4460    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 79]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4461        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"        C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4462    
4463        S: "OK"        S: "OK"
# Line 4440  Internet-Draft    LinuxSampler Control P Line 4473  Internet-Draft    LinuxSampler Control P
4473    
4474     Where <map> is the numeric ID of the map to alter, <midi_bank> is an     Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4475     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
4476    
4477    
4478    
4479    Schoenebeck               Expires June 7, 2008                 [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol        December 2007
4482    
4483    
4484     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4485     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4486     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
# Line 4474  Internet-Draft    LinuxSampler Control P Line 4515  Internet-Draft    LinuxSampler Control P
4515           instrument) are explicitly changed to "ON_DEMAND" and no           instrument) are explicitly changed to "ON_DEMAND" and no
4516           sampler channel is using the instrument anymore.           sampler channel is using the instrument anymore.
4517    
   
   
 Schoenebeck               Expires March 4, 2008                [Page 80]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4518        "PERSISTENT" -        "PERSISTENT" -
4519    
4520           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
# Line 4495  Internet-Draft    LinuxSampler Control P Line 4529  Internet-Draft    LinuxSampler Control P
4529           In case there is no <instr_load_mode> argument given, it will           In case there is no <instr_load_mode> argument given, it will
4530           be up to the InstrumentManager to decide which mode to use.           be up to the InstrumentManager to decide which mode to use.
4531           Usually it will use "ON_DEMAND" if an entry for the given           Usually it will use "ON_DEMAND" if an entry for the given
4532    
4533    
4534    
4535    Schoenebeck               Expires June 7, 2008                 [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol        December 2007
4538    
4539    
4540           instrument does not exist in the InstrumentManager's list yet,           instrument does not exist in the InstrumentManager's list yet,
4541           otherwise if an entry already exists, it will simply stick with           otherwise if an entry already exists, it will simply stick with
4542           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
# Line 4515  Internet-Draft    LinuxSampler Control P Line 4557  Internet-Draft    LinuxSampler Control P
4557     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4558     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4559     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4560     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes, supporting escape sequences as described in chapter
4561     displaying an appropriate name for mapped instruments (using "GET     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4562     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     entry, useful for frontends for displaying an appropriate name for
4563       mapped instruments (using "GET MIDI_INSTRUMENT INFO"
4564       (Section 6.7.11)).
4565    
4566     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4567     completely established in the sampler.  The OPTIONAL "NON_MODAL"     completely established in the sampler.  The OPTIONAL "NON_MODAL"
# Line 4529  Internet-Draft    LinuxSampler Control P Line 4573  Internet-Draft    LinuxSampler Control P
4573     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4574     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4575     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 81]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4576     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4577     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4578     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4548  Internet-Draft    LinuxSampler Control P Line 4584  Internet-Draft    LinuxSampler Control P
4584    
4585           usually           usually
4586    
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires June 7, 2008                 [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol        December 2007
4594    
4595    
4596        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4597    
4598           when the given map or engine does not exist or a value is out           when the given map or engine does not exist or a value is out
# Line 4585  Internet-Draft    LinuxSampler Control P Line 4630  Internet-Draft    LinuxSampler Control P
4630     The front-end can query the amount of currently existing entries in a     The front-end can query the amount of currently existing entries in a
4631     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4632    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 82]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4633        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
4634    
4635     The front-end can query the amount of currently existing entries in     The front-end can query the amount of currently existing entries in
# Line 4602  Internet-Draft    LinuxSampler Control P Line 4639  Internet-Draft    LinuxSampler Control P
4639    
4640     Possible Answers:     Possible Answers:
4641    
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires June 7, 2008                 [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol        December 2007
4650    
4651    
4652        The sampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
4653        in the MIDI instrument map(s).        in the MIDI instrument map(s).
4654    
# Line 4641  Internet-Draft    LinuxSampler Control P Line 4688  Internet-Draft    LinuxSampler Control P
4688    
4689     Example:     Example:
4690    
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 83]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4691        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
4692    
4693        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
# Line 4658  Internet-Draft    LinuxSampler Control P Line 4697  Internet-Draft    LinuxSampler Control P
4697     The front-end can delete an entry from a MIDI instrument map by     The front-end can delete an entry from a MIDI instrument map by
4698     sending the following command:     sending the following command:
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires June 7, 2008                 [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol        December 2007
4706    
4707    
4708        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4709    
4710     Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>     Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
# Line 4696  Internet-Draft    LinuxSampler Control P Line 4743  Internet-Draft    LinuxSampler Control P
4743    
4744     Possible Answers:     Possible Answers:
4745    
   
   
   
   
 Schoenebeck               Expires March 4, 2008                [Page 84]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
   
   
4746        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
4747        answer line begins with the information category name followed by        answer line begins with the information category name followed by
4748        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 4715  Internet-Draft    LinuxSampler Control P Line 4753  Internet-Draft    LinuxSampler Control P
4753    
4754           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
4755           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
4756    
4757    
4758    
4759    Schoenebeck               Expires June 7, 2008                 [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol        December 2007
4762    
4763    
4764           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
4765           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4766           be unique.           be unique. (note that this character string may contain escape
4767             sequences (Section 7.1))
4768    
4769        "ENGINE_NAME" -        "ENGINE_NAME" -
4770    
# Line 4725  Internet-Draft    LinuxSampler Control P Line 4772  Internet-Draft    LinuxSampler Control P
4772    
4773        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4774    
4775           File name of the instrument.           File name of the instrument (note that this path may contain
4776             escape sequences (Section 7.1)).
4777    
4778        "INSTRUMENT_NR" -        "INSTRUMENT_NR" -
4779    
# Line 4735  Internet-Draft    LinuxSampler Control P Line 4783  Internet-Draft    LinuxSampler Control P
4783    
4784           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
4785           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4786           cannot be changed.           cannot be changed (note that this character string may contain
4787             escape sequences (Section 7.1)).
4788    
4789        "LOAD_MODE" -        "LOAD_MODE" -
4790    
# Line 4752  Internet-Draft    LinuxSampler Control P Line 4801  Internet-Draft    LinuxSampler Control P
4801    
4802     Example:     Example:
4803    
4804          C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4805    
4806          S: "NAME: Drums for Foo Song"
4807    
4808             "ENGINE_NAME: GigEngine"
4809    
4810             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4811    
 Schoenebeck               Expires March 4, 2008                [Page 85]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
4812    
4813    
       C: "GET MIDI_INSTRUMENT INFO 1 45 120"  
4814    
4815        S: "NAME: Drums for Foo Song"  Schoenebeck               Expires June 7, 2008                 [Page 86]
4816    
4817           "ENGINE_NAME: GigEngine"  Internet-Draft        LinuxSampler Control Protocol        December 2007
4818    
          "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"  
4819    
4820           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
4821    
# Line 4809  Internet-Draft    LinuxSampler Control P Line 4857  Internet-Draft    LinuxSampler Control P
4857    
4858        S: "OK"        S: "OK"
4859    
4860          C: "CLEAR MIDI_INSTRUMENTS ALL"
4861    
4862          S: "OK"
4863    
4864    
4865    
 Schoenebeck               Expires March 4, 2008                [Page 86]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
4866    
4867    
       C: "CLEAR MIDI_INSTRUMENTS ALL"  
4868    
4869        S: "OK"  
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    
# Line 4864  Internet-Draft    LinuxSampler Control P Line 4916  Internet-Draft    LinuxSampler Control P
4916    
4917        S: "OK"        S: "OK"
4918    
4919    6.8.2.  Deleting an instrument directory
4920    
4921       The front-end can delete a particular instrument directory from the
4922       instruments database by sending the following command:
4923    
4924    
4925    
 Schoenebeck               Expires March 4, 2008                [Page 87]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
4926    
4927    Schoenebeck               Expires June 7, 2008                 [Page 88]
4928    
4929  6.8.2.  Deleting an instrument directory  Internet-Draft        LinuxSampler Control Protocol        December 2007
4930    
    The front-end can delete a particular instrument directory from the  
    instruments database by sending the following command:  
4931    
4932        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4933    
# Line 4920  Internet-Draft    LinuxSampler Control P Line 4971  Internet-Draft    LinuxSampler Control P
4971    
4972        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4973    
4974             if the given directory does not exist.
4975    
4976       Example:
4977    
4978    
4979    
4980    
 Schoenebeck               Expires March 4, 2008                [Page 88]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
4981    
4982    
4983           if the given directory does not exist.  Schoenebeck               Expires June 7, 2008                 [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol        December 2007
4986    
    Example:  
4987    
4988        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4989    
# Line 4977  Internet-Draft    LinuxSampler Control P Line 5029  Internet-Draft    LinuxSampler Control P
5029        GET DB_INSTRUMENT_DIRECTORY INFO <dir>        GET DB_INSTRUMENT_DIRECTORY INFO <dir>
5030    
5031     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5032       directory the front-end is interested in.
5033    
5034       Possible Answers:
5035    
5036    
 Schoenebeck               Expires March 4, 2008                [Page 89]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
5037    
5038    
5039     directory the front-end is interested in.  Schoenebeck               Expires June 7, 2008                 [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol        December 2007
5042    
    Possible Answers:  
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
# Line 5032  Internet-Draft    LinuxSampler Control P Line 5084  Internet-Draft    LinuxSampler Control P
5084     The front-end can alter the name of a specific instrument directory     The front-end can alter the name of a specific instrument directory
5085     by sending the following command:     by sending the following command:
5086    
5087          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5088    
5089       Where <dir> is the absolute path name of the directory and <name> is
5090       the new name for that directory.
5091    
5092    
5093    
 Schoenebeck               Expires March 4, 2008                [Page 90]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
5094    
5095    Schoenebeck               Expires June 7, 2008                 [Page 91]
5096    
5097        SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>  Internet-Draft        LinuxSampler Control Protocol        December 2007
5098    
    Where <dir> is the absolute path name of the directory and <name> is  
    the new name for that directory.  
5099    
5100     Possible Answers:     Possible Answers:
5101    
# Line 5089  Internet-Draft    LinuxSampler Control P Line 5140  Internet-Draft    LinuxSampler Control P
5140    
5141     Example:     Example:
5142    
5143          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5144          Acoustic'"
5145    
5146          S: "OK"
5147    
5148    
 Schoenebeck               Expires March 4, 2008                [Page 91]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
5149    
5150    
5151        C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/  Schoenebeck               Expires June 7, 2008                 [Page 92]
5152        Acoustic'"  
5153    Internet-Draft        LinuxSampler Control Protocol        December 2007
5154    
       S: "OK"  
5155    
5156  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
5157    
# Line 5146  Internet-Draft    LinuxSampler Control P Line 5197  Internet-Draft    LinuxSampler Control P
5197    
5198     Possible Answers:     Possible Answers:
5199    
5200          "OK" -
5201    
5202             on success
5203    
5204    
 Schoenebeck               Expires March 4, 2008                [Page 92]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
5205    
5206    
5207        "OK" -  Schoenebeck               Expires June 7, 2008                 [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol        December 2007
5210    
          on success  
5211    
5212        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5213    
# Line 5201  Internet-Draft    LinuxSampler Control P Line 5253  Internet-Draft    LinuxSampler Control P
5253    
5254     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5255    
5256          Restricts the search to directories, which date of last
5257          modification satisfies the specified period, where <date-after>
5258          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
5260    
5261    
5262    
5263  Schoenebeck               Expires March 4, 2008                [Page 93]  Schoenebeck               Expires June 7, 2008                 [Page 94]
5264    
5265  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5266    
5267    
       Restricts the search to directories, which date of last  
       modification satisfies the specified period, where <date-after>  
       and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-  
       after> is omitted the search is restricted to directories, which  
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 5257  Internet-Draft    LinuxSampler Control P Line 5309  Internet-Draft    LinuxSampler Control P
5309        [<instr_index>]        [<instr_index>]
5310    
5311     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5312       into apostrophes) in the instruments database in which only the new
5313       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
5315       file system (encapsulated into apostrophes).  In case an instrument
5316    
5317    
5318    
5319  Schoenebeck               Expires March 4, 2008                [Page 94]  Schoenebeck               Expires June 7, 2008                 [Page 95]
5320    
5321  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5322    
5323    
    into apostrophes) in the instruments database in which only the new  
    instruments (that are not already in the database) will be added,  
    <file_path> is the absolute path name of a file or directory in the  
    file system (encapsulated into apostrophes).  In case an instrument  
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 5314  Internet-Draft    LinuxSampler Control P Line 5366  Internet-Draft    LinuxSampler Control P
5366           numerical ID used to obtain status information about the job           numerical ID used to obtain status information about the job
5367           progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)           progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5368    
5369          "ERR:<error-code>:<error-message>" -
5370    
5371    
 Schoenebeck               Expires March 4, 2008                [Page 95]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
5372    
5373    
5374        "ERR:<error-code>:<error-message>" -  
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    
# Line 5370  Internet-Draft    LinuxSampler Control P Line 5424  Internet-Draft    LinuxSampler Control P
5424     including those located in subdirectories of the specified directory,     including those located in subdirectories of the specified directory,
5425     will be returned.     will be returned.
5426    
5427       Possible Answers:
5428    
5429    
 Schoenebeck               Expires March 4, 2008                [Page 96]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
5430    
5431    Schoenebeck               Expires June 7, 2008                 [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol        December 2007
5434    
    Possible Answers:  
5435    
5436        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5437    
# Line 5428  Internet-Draft    LinuxSampler Control P Line 5482  Internet-Draft    LinuxSampler Control P
5482    
5483    
5484    
5485  Schoenebeck               Expires March 4, 2008                [Page 97]  
5486    
5487  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  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
# Line 5484  Internet-Draft    LinuxSampler Control P Line 5540  Internet-Draft    LinuxSampler Control P
5540    
5541    
5542    
5543  Schoenebeck               Expires March 4, 2008                [Page 98]  Schoenebeck               Expires June 7, 2008                 [Page 99]
5544    
5545  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5546    
5547    
5548           MODIFIED -           MODIFIED -
# Line 5540  Internet-Draft    LinuxSampler Control P Line 5596  Internet-Draft    LinuxSampler Control P
5596    
5597    
5598    
5599  Schoenebeck               Expires March 4, 2008                [Page 99]  Schoenebeck               Expires June 7, 2008                [Page 100]
5600    
5601  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5602    
5603    
5604           "SIZE: 2050871870"           "SIZE: 2050871870"
# Line 5596  Internet-Draft    LinuxSampler Control P Line 5652  Internet-Draft    LinuxSampler Control P
5652    
5653    
5654    
5655  Schoenebeck               Expires March 4, 2008               [Page 100]  Schoenebeck               Expires June 7, 2008                [Page 101]
5656    
5657  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5658    
5659    
5660  6.8.17.  Moving an instrument  6.8.17.  Moving an instrument
# Line 5652  Internet-Draft    LinuxSampler Control P Line 5708  Internet-Draft    LinuxSampler Control P
5708    
5709    
5710    
5711  Schoenebeck               Expires March 4, 2008               [Page 101]  Schoenebeck               Expires June 7, 2008                [Page 102]
5712    
5713  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  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
# Line 5708  Internet-Draft    LinuxSampler Control P Line 5764  Internet-Draft    LinuxSampler Control P
5764    
5765    
5766    
5767  Schoenebeck               Expires March 4, 2008               [Page 102]  Schoenebeck               Expires June 7, 2008                [Page 103]
5768    
5769  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  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
# Line 5764  Internet-Draft    LinuxSampler Control P Line 5820  Internet-Draft    LinuxSampler Control P
5820    
5821    
5822    
5823  Schoenebeck               Expires March 4, 2008               [Page 103]  Schoenebeck               Expires June 7, 2008                [Page 104]
5824    
5825  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  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
# Line 5820  Internet-Draft    LinuxSampler Control P Line 5876  Internet-Draft    LinuxSampler Control P
5876    
5877    
5878    
5879  Schoenebeck               Expires March 4, 2008               [Page 104]  Schoenebeck               Expires June 7, 2008                [Page 105]
5880    
5881  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5882    
5883    
5884        S: "'/Piano Collection/Bosendorfer 290'"        S: "'/Piano Collection/Bosendorfer 290'"
# Line 5876  Internet-Draft    LinuxSampler Control P Line 5932  Internet-Draft    LinuxSampler Control P
5932    
5933    
5934    
5935  Schoenebeck               Expires March 4, 2008               [Page 105]  Schoenebeck               Expires June 7, 2008                [Page 106]
5936    
5937  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
5938    
5939    
5940     Example:     Example:
# Line 5932  Internet-Draft    LinuxSampler Control P Line 5988  Internet-Draft    LinuxSampler Control P
5988    
5989    
5990    
5991  Schoenebeck               Expires March 4, 2008               [Page 106]  Schoenebeck               Expires June 7, 2008                [Page 107]
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
5992    
5993    Internet-Draft        LinuxSampler Control Protocol        December 2007
5994    
5995        EDIT INSTRUMENT <sampler-channel>  
5996          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
5999     sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or     sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
# Line 5974  Internet-Draft    LinuxSampler Control P Line 6030  Internet-Draft    LinuxSampler Control P
6030    
6031     Examples:     Examples:
6032    
6033        C: "EDIT INSTRUMENT 0"        C: "EDIT CHANNEL INSTRUMENT 0"
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  Schoenebeck               Expires March 4, 2008               [Page 107]  
6199    
6200  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
6201    
6202    
6203    
6204    
6205    
6206    
6207    
6208    
6209    
6210    
6211    
6212    
6213    
6214    
6215    Schoenebeck               Expires June 7, 2008                [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol        December 2007
6218    
6219    
6220  7.  Command Syntax  7.  Command Syntax
# Line 6044  Internet-Draft    LinuxSampler Control P Line 6268  Internet-Draft    LinuxSampler Control P
6268    
6269    
6270    
6271  Schoenebeck               Expires March 4, 2008               [Page 108]  Schoenebeck               Expires June 7, 2008                [Page 112]
6272    
6273  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
6274    
6275    
6276        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6100  Internet-Draft    LinuxSampler Control P Line 6324  Internet-Draft    LinuxSampler Control P
6324    
6325    
6326    
6327  Schoenebeck               Expires March 4, 2008               [Page 109]  Schoenebeck               Expires June 7, 2008                [Page 113]
6328    
6329  Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 6156  Internet-Draft    LinuxSampler Control P Line 6380  Internet-Draft    LinuxSampler Control P
6380    
6381    
6382    
6383  Schoenebeck               Expires March 4, 2008               [Page 110]  Schoenebeck               Expires June 7, 2008                [Page 114]
6384    
6385  Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 6207  Internet-Draft    LinuxSampler Control P Line 6433  Internet-Draft    LinuxSampler Control P
6433    
6434        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
6435    
       / DB_INSTRUMENTS_JOB_INFO  
6436    
6437    
6438    
6439    Schoenebeck               Expires June 7, 2008                [Page 115]
6440    
6441  Schoenebeck               Expires March 4, 2008               [Page 111]  Internet-Draft        LinuxSampler Control Protocol        December 2007
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 6260  Internet-Draft    LinuxSampler Control P Line 6488  Internet-Draft    LinuxSampler Control P
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 March 4, 2008               [Page 112]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 6316  Internet-Draft    LinuxSampler Control P Line 6544  Internet-Draft    LinuxSampler Control P
6544    
6545        / CHANNEL SP VOICE_COUNT SP sampler_channel        / CHANNEL SP VOICE_COUNT SP sampler_channel
6546    
       / ENGINE SP INFO SP engine_name  
6547    
       / SERVER SP INFO  
6548    
6549    
6550    
6551    Schoenebeck               Expires June 7, 2008                [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol        December 2007
6554    
6555    
6556          / ENGINE SP INFO SP engine_name
6557    
6558  Schoenebeck               Expires March 4, 2008               [Page 113]        / SERVER SP INFO
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
6559    
6560          / TOTAL_STREAM_COUNT
6561    
6562        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6563    
# Line 6363  Internet-Draft    LinuxSampler Control P Line 6593  Internet-Draft    LinuxSampler Control P
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 March 4, 2008               [Page 114]        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6616          param_val_list
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 6424  Internet-Draft    LinuxSampler Control P Line 6656  Internet-Draft    LinuxSampler Control P
6656    
6657        / MIDI_INPUT_DEVICE SP string SP key_val_list        / MIDI_INPUT_DEVICE SP string SP key_val_list
6658    
       / 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          / FX_SEND SP sampler_channel SP midi_ctrl
6671    
6672  Schoenebeck               Expires March 4, 2008               [Page 115]        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
6673    
6674       reset_instruction =
6675    
6676        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
6677    
# Line 6482  Internet-Draft    LinuxSampler Control P Line 6714  Internet-Draft    LinuxSampler Control P
6714    
6715     load_instruction =     load_instruction =
6716    
       INSTRUMENT SP load_instr_args  
   
       / ENGINE SP load_engine_args  
6717    
    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 March 4, 2008               [Page 116]        / ENGINE SP load_engine_args
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 6530  Internet-Draft    LinuxSampler Control P Line 6760  Internet-Draft    LinuxSampler Control P
6760    
6761     edit_instruction =     edit_instruction =
6762    
6763        INSTRUMENT SP sampler_channel        CHANNEL SP INSTRUMENT SP sampler_channel
6764    
6765     format_instruction =     format_instruction =
6766    
# Line 6538  Internet-Draft    LinuxSampler Control P Line 6768  Internet-Draft    LinuxSampler Control P
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  Schoenebeck               Expires March 4, 2008               [Page 117]        /* epsilon (empty argument) */
6781    
6782  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007        / NON_MODAL SP
6783    
6784       key_val_list =
6785    
6786        string '=' param_val_list        string '=' param_val_list
6787    
# Line 6593  Internet-Draft    LinuxSampler Control P Line 6823  Internet-Draft    LinuxSampler Control P
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 March 4, 2008               [Page 118]     load_instr_args =
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 6649  Internet-Draft    LinuxSampler Control P Line 6881  Internet-Draft    LinuxSampler Control P
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 March 4, 2008               [Page 119]        number
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
6895    
6896       midi_prog =
6897    
6898          number
6899    
6900     midi_ctrl =     midi_ctrl =
6901    
# Line 6701  Internet-Draft    LinuxSampler Control P Line 6933  Internet-Draft    LinuxSampler Control P
6933    
6934     map_name =     map_name =
6935    
6936        stringval        stringval_escaped
6937    
6938     entry_name =     entry_name =
6939    
       stringval  
6940    
    fx_send_name =  
6941    
       stringval  
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       fx_send_name =
6951    
6952  Schoenebeck               Expires March 4, 2008               [Page 120]        stringval_escaped
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
6953    
6954       param_val_list =
6955    
6956        param_val        param_val
6957    
# Line 6743  Internet-Draft    LinuxSampler Control P Line 6975  Internet-Draft    LinuxSampler Control P
6975    
6976     query_val =     query_val =
6977    
6978        textval_escaped        text_escaped
6979    
6980        / stringval_escaped        / stringval_escaped
6981    
# Line 6761  Internet-Draft    LinuxSampler Control P Line 6993  Internet-Draft    LinuxSampler Control P
6993     supported the standard ASCII character set (ASCII code 0 - 127)     supported the standard ASCII character set (ASCII code 0 - 127)
6994     [RFC20], all younger versions of this protocol however support the     [RFC20], all younger versions of this protocol however support the
6995     Extended ASCII character set (ASCII code 0 - 255).  The same group of     Extended ASCII character set (ASCII code 0 - 255).  The same group of
    younger protocols also support escape sequences, but only for  
    certain, explicitly declared parts of the protocol.  The supported  
    escape sequences are defined as follows:  
   
   
   
6996    
6997    
6998    
6999    Schoenebeck               Expires June 7, 2008                [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol        December 2007
7002    
 Schoenebeck               Expires March 4, 2008               [Page 121]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 6812  Internet-Draft    LinuxSampler Control P Line 7040  Internet-Draft    LinuxSampler Control P
7040     (that is as double backslash), whereas in the old versions a single     (that is as double backslash), whereas in the old versions a single
7041     backslash was sufficient.     backslash was sufficient.
7042    
7043       The following LSCP commands support escape sequences as part of their
7044       filename / path based arguments and / or may contain a filename /
7045       path with escape sequences in their response:
7046    
7047          "LOAD INSTRUMENT" (Section 6.4.1)
7048    
7049          "GET CHANNEL INFO" (Section 6.4.10)
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck               Expires June 7, 2008                [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol        December 2007
7058    
7059    
7060          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7061    
7062          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7063    
7064          "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
7065    
7066          "ADD DB_INSTRUMENTS" (Section 6.8.11)
7067    
7068          "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
7069    
7070          "REMOVE DB_INSTRUMENT" (Section 6.8.12)
7071    
7072          "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
7073    
7074          "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
7075    
7076          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
7077    
7078          "GET DB_INSTRUMENTS" (Section 6.8.13)
7079    
7080          "LIST DB_INSTRUMENTS" (Section 6.8.14)
7081    
7082          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
7083    
7084          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7085    
7086          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7087    
7088          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7089    
7090          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7091    
7092          "FIND DB_INSTRUMENTS" (Section 6.8.20)
7093    
7094          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
7095    
7096          "MOVE DB_INSTRUMENT" (Section 6.8.17)
7097    
7098          "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
7099    
7100          "COPY DB_INSTRUMENT" (Section 6.8.18)
7101    
7102          "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
7103    
7104          "GET FILE INSTRUMENTS" (Section 6.10.1)
7105    
7106          "LIST FILE INSTRUMENTS" (Section 6.10.2)
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires June 7, 2008                [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol        December 2007
7114    
7115    
7116          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
7117    
7118       Note that the forward slash character ('/') has a special meaning in
7119       filename / path based arguments: it acts as separator of the nodes in
7120       the path, thus if a directory- or filename includes a forward slash
7121       (not intended as path node separator), you MUST escape that slash
7122       either with the respective hex escape sequence ("\x2f") or with the
7123       respective octal escape sequence ("\057").
7124    
7125       Note for Windows: file path arguments in LSCP are expected to use
7126       forward slashes as directory node separator similar to Unix based
7127       operating systems.  In contrast to Unix however a Windows typical
7128       drive character is expected to be prefixed to the path.  That is an
7129       original Windows file path like "D:\Sounds\My.gig" would become in
7130       LSCP: "D:/Sounds/My.gig".
7131    
7132       The following LSCP commands even support escape sequences as part of
7133       at least one of their text-based arguments (i.e. entity name,
7134       description) and / or may contain escape sequences in at least one of
7135       their text-based fields in their response:
7136    
7137          "GET SERVER INFO" (Section 6.6.5)
7138    
7139          "GET ENGINE INFO" (Section 6.4.9)
7140    
7141          "GET CHANNEL INFO" (Section 6.4.10)
7142    
7143          "CREATE FX_SEND" (Section 6.4.25)
7144    
7145          "GET FX_SEND INFO" (Section 6.4.29)
7146    
7147          "SET FX_SEND NAME" (Section 6.4.30)
7148    
7149          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7150    
7151          "GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5)
7152    
7153          "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
7154    
7155          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7156    
7157          "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
7158    
7159          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
7160    
7161          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7162    
7163    
7164    
7165    
7166    
7167    Schoenebeck               Expires June 7, 2008                [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol        December 2007
7170    
7171    
7172  Schoenebeck               Expires March 4, 2008               [Page 122]        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7173    
7174  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007        "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
7175    
7176          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
7177    
7178          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7179    
7180          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7181    
7182          "FIND DB_INSTRUMENTS" (Section 6.8.20)
7183    
7184       Please note that these lists are manually maintained.  If you find a
7185       command that also supports escape sequences we forgot to mention
7186       here, please report it!
7187    
7188    
7189    
7190    
7191    
7192    
7193    
7194    
7195    
7196    
7197    
7198    
7199    
7200    
7201    
7202    
7203    
7204    
7205    
7206    
7207    
7208    
7209    
7210    
7211    
7212    
7213    
7214    
7215    
7216    
7217    
7218    
7219    
7220    
7221    
7222    
7223    Schoenebeck               Expires June 7, 2008                [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol        December 2007
7226    
7227    
7228  8.  Events  8.  Events
# Line 6884  Internet-Draft    LinuxSampler Control P Line 7276  Internet-Draft    LinuxSampler Control P
7276    
7277    
7278    
7279  Schoenebeck               Expires March 4, 2008               [Page 123]  Schoenebeck               Expires June 7, 2008                [Page 130]
7280    
7281  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7282    
7283    
7284        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 6940  Internet-Draft    LinuxSampler Control P Line 7332  Internet-Draft    LinuxSampler Control P
7332    
7333    
7334    
7335  Schoenebeck               Expires March 4, 2008               [Page 124]  Schoenebeck               Expires June 7, 2008                [Page 131]
7336    
7337  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7338    
7339    
7340        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
# Line 6996  Internet-Draft    LinuxSampler Control P Line 7388  Internet-Draft    LinuxSampler Control P
7388    
7389    
7390    
7391  Schoenebeck               Expires March 4, 2008               [Page 125]  Schoenebeck               Expires June 7, 2008                [Page 132]
7392    
7393  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7394    
7395    
7396        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 7052  Internet-Draft    LinuxSampler Control P Line 7444  Internet-Draft    LinuxSampler Control P
7444    
7445    
7446    
7447  Schoenebeck               Expires March 4, 2008               [Page 126]  Schoenebeck               Expires June 7, 2008                [Page 133]
7448    
7449  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7450    
7451    
7452        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
# Line 7066  Internet-Draft    LinuxSampler Control P Line 7458  Internet-Draft    LinuxSampler Control P
7458     where <voices> will be replaced by the new number of all currently     where <voices> will be replaced by the new number of all currently
7459     active voices.     active voices.
7460    
7461  8.13.  Number of MIDI instrument maps changed  8.13.  Total number of active disk streams changed
7462    
7463       Client may want to be notified when the total number of disk streams
7464       on the back-end changes by issuing the following command:
7465    
7466          SUBSCRIBE TOTAL_STREAM_COUNT
7467    
7468       Server will start sending the following notification messages:
7469    
7470          "NOTIFY:TOTAL_STREAM_COUNT:<streams>"
7471    
7472       where <streams> will be replaced by the new number of all currently
7473       active disk streams.
7474    
7475    8.14.  Number of MIDI instrument maps changed
7476    
7477     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
7478     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 7080  Internet-Draft    LinuxSampler Control P Line 7486  Internet-Draft    LinuxSampler Control P
7486     where <maps> will be replaced by the new number of MIDI instrument     where <maps> will be replaced by the new number of MIDI instrument
7487     maps.     maps.
7488    
7489  8.14.  MIDI instrument map information changed  8.15.  MIDI instrument map information changed
7490    
7491     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
7492     instrument maps on the back-end by issuing the following command:     instrument maps on the back-end by issuing the following command:
# Line 7089  Internet-Draft    LinuxSampler Control P Line 7495  Internet-Draft    LinuxSampler Control P
7495    
7496     Server will start sending the following notification messages:     Server will start sending the following notification messages:
7497    
7498    
7499    
7500    
7501    
7502    
7503    Schoenebeck               Expires June 7, 2008                [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol        December 2007
7506    
7507    
7508        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
7509    
7510     where <map-id> will be replaced by the numerical ID of the MIDI     where <map-id> will be replaced by the numerical ID of the MIDI
# Line 7099  Internet-Draft    LinuxSampler Control P Line 7515  Internet-Draft    LinuxSampler Control P
7515     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
7516     message is sufficient here.     message is sufficient here.
7517    
7518  8.15.  Number of MIDI instruments changed  8.16.  Number of MIDI instruments changed
7519    
7520     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
7521     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
7522    
   
   
   
   
 Schoenebeck               Expires March 4, 2008               [Page 127]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 7123  Internet-Draft    LinuxSampler Control P Line 7530  Internet-Draft    LinuxSampler Control P
7530     which the nuber of instruments has changed and <instruments> will be     which the nuber of instruments has changed and <instruments> will be
7531     replaced by the new number of MIDI instruments in the specified map.     replaced by the new number of MIDI instruments in the specified map.
7532    
7533  8.16.  MIDI instrument information changed  8.17.  MIDI instrument information changed
7534    
7535     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
7536     instruments on the back-end by issuing the following command:     instruments on the back-end by issuing the following command:
# Line 7143  Internet-Draft    LinuxSampler Control P Line 7550  Internet-Draft    LinuxSampler Control P
7550     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
7551     empty notification message is sufficient here.     empty notification message is sufficient here.
7552    
7553  8.17.  Global settings changed  
7554    
7555    
7556    
7557    
7558    
7559    Schoenebeck               Expires June 7, 2008                [Page 135]
7560    
7561    Internet-Draft        LinuxSampler Control Protocol        December 2007
7562    
7563    
7564    8.18.  Global settings changed
7565    
7566     Client may want to be notified when changes to the global settings of     Client may want to be notified when changes to the global settings of
7567     the sampler were made by issuing the following command:     the sampler were made by issuing the following command:
# Line 7158  Internet-Draft    LinuxSampler Control P Line 7576  Internet-Draft    LinuxSampler Control P
7576        by the optional dotted floating point value, reflecting the new        by the optional dotted floating point value, reflecting the new
7577        global volume parameter.        global volume parameter.
7578    
7579    8.19.  Number of database instrument directories changed
   
   
   
   
   
 Schoenebeck               Expires March 4, 2008               [Page 128]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 7188  Internet-Draft    LinuxSampler Control P Line 7595  Internet-Draft    LinuxSampler Control P
7595     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
7596     sent for the subdirectories in that directory.     sent for the subdirectories in that directory.
7597    
7598  8.19.  Database instrument directory information changed  8.20.  Database instrument directory information changed
7599    
7600     Client may want to be notified when changes were made to directories     Client may want to be notified when changes were made to directories
7601     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 7202  Internet-Draft    LinuxSampler Control P Line 7609  Internet-Draft    LinuxSampler Control P
7609     where <dir-path> will be replaced by the absolute path name of the     where <dir-path> will be replaced by the absolute path name of the
7610     directory, for which information changes occurred.  The front-end     directory, for which information changes occurred.  The front-end
7611     will have to send the respective command to actually get the updated     will have to send the respective command to actually get the updated
7612    
7613    
7614    
7615    Schoenebeck               Expires June 7, 2008                [Page 136]
7616    
7617    Internet-Draft        LinuxSampler Control Protocol        December 2007
7618    
7619    
7620     directory info.  Because these messages will be triggered by LSCP     directory info.  Because these messages will be triggered by LSCP
7621     commands issued by other clients rather than real time events     commands issued by other clients rather than real time events
7622     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
# Line 7214  Internet-Draft    LinuxSampler Control P Line 7629  Internet-Draft    LinuxSampler Control P
7629     (encapsulated into apostrophes), which name is changes and <new-name>     (encapsulated into apostrophes), which name is changes and <new-name>
7630     is the new name of the directory, encapsulated into apostrophes.     is the new name of the directory, encapsulated into apostrophes.
7631    
7632    8.21.  Number of database instruments changed
   
   
   
   
   
 Schoenebeck               Expires March 4, 2008               [Page 129]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 7244  Internet-Draft    LinuxSampler Control P Line 7648  Internet-Draft    LinuxSampler Control P
7648     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
7649     sent for the instruments in that directory.     sent for the instruments in that directory.
7650    
7651  8.21.  Database instrument information changed  8.22.  Database instrument information changed
7652    
7653     Client may want to be notified when changes were made to instruments     Client may want to be notified when changes were made to instruments
7654     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 7261  Internet-Draft    LinuxSampler Control P Line 7665  Internet-Draft    LinuxSampler Control P
7665     info.  Because these messages will be triggered by LSCP commands     info.  Because these messages will be triggered by LSCP commands
7666     issued by other clients rather than real time events happening on the     issued by other clients rather than real time events happening on the
7667     server, it is believed that an empty notification message is     server, it is believed that an empty notification message is
    sufficient here.  
   
       "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"  
   
    where <old-instr-path> is the old absolute path name of the  
    instrument (encapsulated into apostrophes), which name is changes and  
    <new-name> is the new name of the instrument, encapsulated into  
    apostrophes.  
7668    
7669    
7670    
7671    Schoenebeck               Expires June 7, 2008                [Page 137]
7672    
7673    Internet-Draft        LinuxSampler Control Protocol        December 2007
7674    
7675    
7676       sufficient here.
7677    
7678  Schoenebeck               Expires March 4, 2008               [Page 130]        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 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 7299  Internet-Draft    LinuxSampler Control P Line 7700  Internet-Draft    LinuxSampler Control P
7700     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
7701     empty notification message is sufficient here.     empty notification message is sufficient here.
7702    
7703  8.23.  Miscellaneous and debugging events  8.24.  Miscellaneous and debugging events
7704    
7705     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
7706     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 7323  Internet-Draft    LinuxSampler Control P Line 7724  Internet-Draft    LinuxSampler Control P
7724    
7725    
7726    
7727    Schoenebeck               Expires June 7, 2008                [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol        December 2007
   
   
   
   
   
   
   
 Schoenebeck               Expires March 4, 2008               [Page 131]  
   
 Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  
7730    
7731    
7732  9.  Security Considerations  9.  Security Considerations
# Line 7388  Internet-Draft    LinuxSampler Control P Line 7780  Internet-Draft    LinuxSampler Control P
7780    
7781    
7782    
7783  Schoenebeck               Expires March 4, 2008               [Page 132]  Schoenebeck               Expires June 7, 2008                [Page 139]
7784    
7785  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7786    
7787    
7788  10.  Acknowledgments  10.  Acknowledgments
# Line 7444  Internet-Draft    LinuxSampler Control P Line 7836  Internet-Draft    LinuxSampler Control P
7836    
7837    
7838    
7839  Schoenebeck               Expires March 4, 2008               [Page 133]  Schoenebeck               Expires June 7, 2008                [Page 140]
7840    
7841  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7842    
7843    
7844  11.  References  11.  References
# Line 7500  Internet-Draft    LinuxSampler Control P Line 7892  Internet-Draft    LinuxSampler Control P
7892    
7893    
7894    
7895  Schoenebeck               Expires March 4, 2008               [Page 134]  Schoenebeck               Expires June 7, 2008                [Page 141]
7896    
7897  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7898    
7899    
7900  Author's Address  Author's Address
# Line 7556  Author's Address Line 7948  Author's Address
7948    
7949    
7950    
7951  Schoenebeck               Expires March 4, 2008               [Page 135]  Schoenebeck               Expires June 7, 2008                [Page 142]
7952    
7953  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007  Internet-Draft        LinuxSampler Control Protocol        December 2007
7954    
7955    
7956  Full Copyright Statement  Full Copyright Statement
# Line 7612  Acknowledgment Line 8004  Acknowledgment
8004    
8005    
8006    
8007  Schoenebeck               Expires March 4, 2008               [Page 136]  Schoenebeck               Expires June 7, 2008                [Page 143]
8008    
8009    
Legend:
Removed from v.1363  
changed lines
  Added in v.1572
  ViewVC Help
Powered by ViewVC