/[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 1189 by iliev, Wed May 16 14:42:04 2007 UTC revision 1773 by iliev, Wed Sep 10 15:14:31 2008 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: November 17, 2007                                  May 16, 2007  Expires: March 14, 2009                               September 10, 2008
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.2                                  LSCP 1.4
12    
13  Status of this Memo  Status of this Memo
14    
# Line 33  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on November 17, 2007.     This Internet-Draft will expire on March 14, 2009.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The IETF Trust (2007).     Copyright (C) The IETF Trust (2008).
41    
42    
43    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck             Expires November 17, 2007               [Page 1]  Schoenebeck              Expires March 14, 2009                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
58    
59    
60  Abstract  Abstract
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck             Expires November 17, 2007               [Page 2]  Schoenebeck              Expires March 14, 2009                 [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.  Getting all created MIDI input device list  . . . . .  37
# Line 124  Internet-Draft        LinuxSampler Contr Line 124  Internet-Draft        LinuxSampler Contr
124         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126         6.4.3.  Getting all created sampler channel count . . . . . .  45         6.4.3.  Getting all created sampler channel count . . . . . .  45
127         6.4.4.  Getting all created sampler channel list  . . . . . .  45         6.4.4.  Getting all created sampler channel list  . . . . . .  46
128         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  45         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  46         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47
130         6.4.7.  Getting amount of available engines . . . . . . . . .  47         6.4.7.  Getting amount of available engines . . . . . . . . .  48
131         6.4.8.  Getting all available engines . . . . . . . . . . . .  47         6.4.8.  Getting all available engines . . . . . . . . . . . .  48
132         6.4.9.  Getting information about an engine . . . . . . . . .  48         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information . . . . . . . . .  49         6.4.10. Getting sampler channel information . . . . . . . . .  49
134         6.4.11. Current number of active voices . . . . . . . . . . .  52         6.4.11. Current number of active voices . . . . . . . . . . .  52
135         6.4.12. Current number of active disk streams . . . . . . . .  52         6.4.12. Current number of active disk streams . . . . . . . .  53
136         6.4.13. Current fill state of disk stream buffers . . . . . .  53         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device . . . . . . . . . . . . .  54         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type . . . . . . . . . . . . . .  54         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55
139         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55         6.4.16. Setting audio output channel  . . . . . . . . . . . .  56
140         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  57         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58
143         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  59         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60
146         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  61
147         6.4.24. Assigning a MIDI instrument map to a sampler         6.4.24. Assigning a MIDI instrument map to a sampler
148                 channel . . . . . . . . . . . . . . . . . . . . . . .  61                 channel . . . . . . . . . . . . . . . . . . . . . . .  61
149         6.4.25. Adding an effect send to a sampler channel  . . . . .  62         6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150         6.4.26. Removing an effect send from a sampler channel  . . .  63         6.4.26. Removing an effect send from a sampler channel  . . .  64
151         6.4.27. Getting amount of effect sends on a sampler channel .  64         6.4.27. Getting amount of effect sends on a sampler channel .  64
152         6.4.28. Listing all effect sends on a sampler channel . . . .  64         6.4.28. Listing all effect sends on a sampler channel . . . .  65
153         6.4.29. Getting effect send information . . . . . . . . . . .  65         6.4.29. Getting effect send information . . . . . . . . . . .  65
154         6.4.30. Changing effect send's name . . . . . . . . . . . . .  66         6.4.30. Changing effect send's name . . . . . . . . . . . . .  67
155         6.4.31. Altering effect send's audio routing  . . . . . . . .  67         6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157         6.4.33. Altering effect send's send level . . . . . . . . . .  68         6.4.33. Altering effect send's send level . . . . . . . . . .  69
158         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  69         6.4.34. Sending MIDI messages to sampler channel  . . . . . .  70
159       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70         6.4.35. Resetting a sampler channel . . . . . . . . . . . . .  71
160         6.5.1.  Register front-end for receiving event messages . . .  70       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  72
161           6.5.1.  Register front-end for receiving event messages . . .  72
162         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
163                 messages  . . . . . . . . . . . . . . . . . . . . . .  71                 messages  . . . . . . . . . . . . . . . . . . . . . .  72
        6.5.3.  Enable or disable echo of commands  . . . . . . . . .  71  
164    
165    
166    
167  Schoenebeck             Expires November 17, 2007               [Page 3]  Schoenebeck              Expires March 14, 2009                 [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
170    
171    
172         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  73
173       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72         6.5.4.  Close client connection . . . . . . . . . . . . . . .  74
174         6.6.1.  Current number of active voices . . . . . . . . . . .  72       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  74
175         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73         6.6.1.  Current number of active voices . . . . . . . . . . .  74
176         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  74
177         6.6.4.  General sampler informations  . . . . . . . . . . . .  73         6.6.3.  Current number of active disk streams . . . . . . . .  74
178         6.6.5.  Getting global volume attenuation . . . . . . . . . .  74         6.6.4.  Reset sampler . . . . . . . . . . . . . . . . . . . .  75
179         6.6.6.  Setting global volume attenuation . . . . . . . . . .  74         6.6.5.  General sampler informations  . . . . . . . . . . . .  75
180       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75         6.6.6.  Getting global volume attenuation . . . . . . . . . .  76
181         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76         6.6.7.  Setting global volume attenuation . . . . . . . . . .  76
182         6.7.2.  Delete one particular or all MIDI instrument maps . .  76       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  77
183         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  77
184         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  77         6.7.2.  Delete one particular or all MIDI instrument maps . .  78
185         6.7.5.  Getting MIDI instrument map information . . . . . . .  78         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  79
186         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  79
187         6.7.7.  Create or replace a MIDI instrument map entry . . . .  79         6.7.5.  Getting MIDI instrument map information . . . . . . .  80
188         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  81
189           6.7.7.  Create or replace a MIDI instrument map entry . . . .  81
190           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  84
191         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
192                 instrument map  . . . . . . . . . . . . . . . . . . .  83                 instrument map  . . . . . . . . . . . . . . . . . . .  85
193         6.7.10. Remove an entry from the MIDI instrument map  . . . .  83         6.7.10. Remove an entry from the MIDI instrument map  . . . .  85
194         6.7.11. Get current settings of MIDI instrument map entry . .  84         6.7.11. Get current settings of MIDI instrument map entry . .  86
195         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  88
196       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  86       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  89
197         6.8.1.  Creating a new instrument directory . . . . . . . . .  86         6.8.1.  Creating a new instrument directory . . . . . . . . .  89
198         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  89
199         6.8.3.  Getting amount of instrument directories  . . . . . .  88         6.8.3.  Getting amount of instrument directories  . . . . . .  90
200         6.8.4.  Listing all directories in specific directory . . . .  88         6.8.4.  Listing all directories in specific directory . . . .  91
201         6.8.5.  Getting instrument directory information  . . . . . .  89         6.8.5.  Getting instrument directory information  . . . . . .  91
202         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  92
203         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  90         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  93
204         6.8.8.  Copying instrument directories  . . . . . . . . . . .  91         6.8.8.  Copying instrument directories  . . . . . . . . . . .  94
205         6.8.9.  Changing the description of directory . . . . . . . .  92         6.8.9.  Changing the description of directory . . . . . . . .  94
206         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  92         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  95
207         6.8.11. Adding instruments to the instruments database  . . .  94         6.8.11. Adding instruments to the instruments database  . . .  96
208         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  95         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  98
209         6.8.13. Getting amount of instruments . . . . . . . . . . . .  95         6.8.13. Getting amount of instruments . . . . . . . . . . . .  98
210         6.8.14. Listing all instruments in specific directory . . . .  96         6.8.14. Listing all instruments in specific directory . . . .  99
211         6.8.15. Getting instrument information  . . . . . . . . . . .  97         6.8.15. Getting instrument information  . . . . . . . . . . . 100
212         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . .  99         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 102
213         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . .  99         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 103
214         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 100         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 103
215         6.8.19. Changing the description of instrument  . . . . . . . 101         6.8.19. Changing the description of instrument  . . . . . . . 104
216         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 101         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 104
217     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 104         6.8.21. Getting job status information  . . . . . . . . . . . 107
218     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 117         6.8.22. Formatting the instruments database . . . . . . . . . 108
219       8.1.  Number of audio output devices changed  . . . . . . . . . 117         6.8.23. Checking for lost instrument files  . . . . . . . . . 108
220       8.2.  Audio output device's settings changed  . . . . . . . . . 117  
221       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 117  
222    
223    Schoenebeck              Expires March 14, 2009                 [Page 4]
224    
225  Schoenebeck             Expires November 17, 2007               [Page 4]  Internet-Draft        LinuxSampler Control Protocol       September 2008
226    
227  Internet-Draft        LinuxSampler Control Protocol             May 2007  
228           6.8.24. Replacing an instrument file  . . . . . . . . . . . . 109
229         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 109
230       8.4.  MIDI input device's settings changed  . . . . . . . . . . 118         6.9.1.  Opening an appropriate instrument editor
231       8.5.  Number of sampler channels changed  . . . . . . . . . . . 118                 application . . . . . . . . . . . . . . . . . . . . . 110
232       8.6.  Number of active voices changed . . . . . . . . . . . . . 118       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 111
233       8.7.  Number of active disk streams changed . . . . . . . . . . 119         6.10.1. Retrieving amount of instruments of a file  . . . . . 111
234       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 119         6.10.2. Retrieving all instruments of a file  . . . . . . . . 111
235       8.9.  Channel information changed . . . . . . . . . . . . . . . 119         6.10.3. Retrieving informations about one instrument in a
236       8.10. Number of effect sends changed  . . . . . . . . . . . . . 120                 file  . . . . . . . . . . . . . . . . . . . . . . . . 112
237       8.11. Effect send information changed . . . . . . . . . . . . . 120     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 115
238       8.12. Total number of active voices changed . . . . . . . . . . 120       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 129
239       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 121     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
240       8.14. MIDI instrument map information changed . . . . . . . . . 121       8.1.  Number of audio output devices changed  . . . . . . . . . 133
241       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 121       8.2.  Audio output device's settings changed  . . . . . . . . . 133
242       8.16. MIDI instrument information changed . . . . . . . . . . . 122       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 133
243       8.17. Global settings changed . . . . . . . . . . . . . . . . . 122       8.4.  MIDI input device's settings changed  . . . . . . . . . . 134
244       8.18. Number of database instrument directories changed . . . . 123       8.5.  Number of sampler channels changed  . . . . . . . . . . . 134
245       8.19. Database instrument directory information changed . . . . 123       8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 134
246       8.20. Number of database instruments changed  . . . . . . . . . 124       8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 135
247       8.21. Database instrument information changed . . . . . . . . . 124       8.8.  Number of active voices changed . . . . . . . . . . . . . 135
248       8.22. Miscellaneous and debugging events  . . . . . . . . . . . 125       8.9.  Number of active disk streams changed . . . . . . . . . . 136
249     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 126       8.10. Disk stream buffer fill state changed . . . . . . . . . . 136
250     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 127       8.11. Channel information changed . . . . . . . . . . . . . . . 136
251     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 128       8.12. Number of effect sends changed  . . . . . . . . . . . . . 137
252     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 129       8.13. Effect send information changed . . . . . . . . . . . . . 137
253     Intellectual Property and Copyright Statements  . . . . . . . . . 130       8.14. Total number of active voices changed . . . . . . . . . . 138
254         8.15. Total number of active disk streams changed . . . . . . . 138
255         8.16. Number of MIDI instrument maps changed  . . . . . . . . . 138
256         8.17. MIDI instrument map information changed . . . . . . . . . 138
257         8.18. Number of MIDI instruments changed  . . . . . . . . . . . 139
258         8.19. MIDI instrument information changed . . . . . . . . . . . 139
259         8.20. Global settings changed . . . . . . . . . . . . . . . . . 140
260         8.21. Number of database instrument directories changed . . . . 140
261         8.22. Database instrument directory information changed . . . . 140
262         8.23. Number of database instruments changed  . . . . . . . . . 141
263         8.24. Database instrument information changed . . . . . . . . . 141
264         8.25. Database job status information changed . . . . . . . . . 142
265         8.26. Miscellaneous and debugging events  . . . . . . . . . . . 142
266       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 143
267       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 144
268       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 145
269       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 146
270       Intellectual Property and Copyright Statements  . . . . . . . . . 147
271    
272    
273    
# Line 273  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279    Schoenebeck              Expires March 14, 2009                 [Page 5]
   
   
 Schoenebeck             Expires November 17, 2007               [Page 5]  
280    
281  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 294  Internet-Draft        LinuxSampler Contr Line 294  Internet-Draft        LinuxSampler Contr
294     end) and server (LinuxSampler) respectively.  Lines in examples must     end) and server (LinuxSampler) respectively.  Lines in examples must
295     be interpreted as every line being CRLF terminated (carriage return     be interpreted as every line being CRLF terminated (carriage return
296     character followed by line feed character as defined in the ASCII     character followed by line feed character as defined in the ASCII
297     standard), thus the following example:     standard [RFC20]), thus the following example:
298    
299        C: "some line"        C: "some line"
300    
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck             Expires November 17, 2007               [Page 6]  Schoenebeck              Expires March 14, 2009                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 363  Internet-Draft        LinuxSampler Contr Line 363  Internet-Draft        LinuxSampler Contr
363         sampler's LSCP minor version.         sampler's LSCP minor version.
364    
365     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
366     frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get     frontend can use the "GET SERVER INFO" (Section 6.6.5) command to get
367     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
368    
369    
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck             Expires November 17, 2007               [Page 7]  Schoenebeck              Expires March 14, 2009                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
394    
395    
396  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck             Expires November 17, 2007               [Page 8]  Schoenebeck              Expires March 14, 2009                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck             Expires November 17, 2007               [Page 9]  Schoenebeck              Expires March 14, 2009                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck             Expires November 17, 2007              [Page 10]  Schoenebeck              Expires March 14, 2009                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck             Expires November 17, 2007              [Page 11]  Schoenebeck              Expires March 14, 2009                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
618    
619    
620     set has the following format:     set has the following format:
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck             Expires November 17, 2007              [Page 12]  Schoenebeck              Expires March 14, 2009                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck             Expires November 17, 2007              [Page 13]  Schoenebeck              Expires March 14, 2009                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck             Expires November 17, 2007              [Page 14]  Schoenebeck              Expires March 14, 2009                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck             Expires November 17, 2007              [Page 15]  Schoenebeck              Expires March 14, 2009                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck             Expires November 17, 2007              [Page 16]  Schoenebeck              Expires March 14, 2009                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck             Expires November 17, 2007              [Page 17]  Schoenebeck              Expires March 14, 2009                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck             Expires November 17, 2007              [Page 18]  Schoenebeck              Expires March 14, 2009                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck             Expires November 17, 2007              [Page 19]  Schoenebeck              Expires March 14, 2009                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck             Expires November 17, 2007              [Page 20]  Schoenebeck              Expires March 14, 2009                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck             Expires November 17, 2007              [Page 21]  Schoenebeck              Expires March 14, 2009                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck             Expires November 17, 2007              [Page 22]  Schoenebeck              Expires March 14, 2009                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck             Expires November 17, 2007              [Page 23]  Schoenebeck              Expires March 14, 2009                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck             Expires November 17, 2007              [Page 24]  Schoenebeck              Expires March 14, 2009                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck             Expires November 17, 2007              [Page 25]  Schoenebeck              Expires March 14, 2009                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck             Expires November 17, 2007              [Page 26]  Schoenebeck              Expires March 14, 2009                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1458    
1459    
1460     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck             Expires November 17, 2007              [Page 27]  Schoenebeck              Expires March 14, 2009                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck             Expires November 17, 2007              [Page 28]  Schoenebeck              Expires March 14, 2009                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck             Expires November 17, 2007              [Page 29]  Schoenebeck              Expires March 14, 2009                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1626    
1627    
1628        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck             Expires November 17, 2007              [Page 30]  Schoenebeck              Expires March 14, 2009                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck             Expires November 17, 2007              [Page 31]  Schoenebeck              Expires March 14, 2009                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck             Expires November 17, 2007              [Page 32]  Schoenebeck              Expires March 14, 2009                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck             Expires November 17, 2007              [Page 33]  Schoenebeck              Expires March 14, 2009                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1850    
1851    
1852        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck             Expires November 17, 2007              [Page 34]  Schoenebeck              Expires March 14, 2009                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck             Expires November 17, 2007              [Page 35]  Schoenebeck              Expires March 14, 2009                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck             Expires November 17, 2007              [Page 36]  Schoenebeck              Expires March 14, 2009                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck             Expires November 17, 2007              [Page 37]  Schoenebeck              Expires March 14, 2009                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck             Expires November 17, 2007              [Page 38]  Schoenebeck              Expires March 14, 2009                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck             Expires November 17, 2007              [Page 39]  Schoenebeck              Expires March 14, 2009                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck             Expires November 17, 2007              [Page 40]  Schoenebeck              Expires March 14, 2009                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck             Expires November 17, 2007              [Page 41]  Schoenebeck              Expires March 14, 2009                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2328  Internet-Draft        LinuxSampler Contr Line 2328  Internet-Draft        LinuxSampler Contr
2328     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2329     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2330     MIDI port number, <key> by the name of the parameter to change and     MIDI port number, <key> by the name of the parameter to change and
2331     <value> by the new value for this parameter.     <value> by the new value for this parameter (encapsulated into
2332       apostrophes) or NONE (not encapsulated into apostrophes) for
2333       specifying no value for parameters allowing a list of values.
2334    
2335     Possible Answers:     Possible Answers:
2336    
# Line 2342  Internet-Draft        LinuxSampler Contr Line 2344  Internet-Draft        LinuxSampler Contr
2344           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2345           code and warning message           code and warning message
2346    
       "ERR:<error-code>:<error-message>" -  
   
2347    
2348    
2349    
2350    
2351  Schoenebeck             Expires November 17, 2007              [Page 42]  Schoenebeck              Expires March 14, 2009                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
2354    
2355    
2356          "ERR:<error-code>:<error-message>" -
2357    
2358           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2359           error message           error message
2360    
2361     Example:     Example:
2362    
2363          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2364    
2365          S: "OK"
2366    
2367          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2368    
2369          S: "OK"
2370    
2371  6.4.  Configuring sampler channels  6.4.  Configuring sampler channels
2372    
# Line 2380  Internet-Draft        LinuxSampler Contr Line 2388  Internet-Draft        LinuxSampler Contr
2388     of the sampler channel the instrument should be assigned to.  Each     of the sampler channel the instrument should be assigned to.  Each
2389     sampler channel can only have one instrument.     sampler channel can only have one instrument.
2390    
2391       Notice: since LSCP 1.2 the <filename> argument supports escape
2392       characters for special characters (see chapter "Character Set and
2393       Escape Sequences (Section 7.1)" for details) and accordingly
2394       backslash characters in the filename MUST now be escaped as well!
2395    
2396     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
2397     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2398     been fully loaded and the channel is ready to be used while NON_MODAL     been fully loaded and the channel is ready to be used while NON_MODAL
# Line 2388  Internet-Draft        LinuxSampler Contr Line 2401  Internet-Draft        LinuxSampler Contr
2401     (Section 6.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2402     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2403     such as making sure that the file could be read and it is of a proper     such as making sure that the file could be read and it is of a proper
2404    
2405    
2406    
2407    Schoenebeck              Expires March 14, 2009                [Page 43]
2408    
2409    Internet-Draft        LinuxSampler Control Protocol       September 2008
2410    
2411    
2412     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
2413     process should any errors be detected at that point.     process should any errors be detected at that point.
2414    
# Line 2401  Internet-Draft        LinuxSampler Contr Line 2422  Internet-Draft        LinuxSampler Contr
2422    
2423           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2424           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 43]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2425           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
2426           file), providing an appropriate warning code and warning           file), providing an appropriate warning code and warning
2427           message           message
# Line 2418  Internet-Draft        LinuxSampler Contr Line 2431  Internet-Draft        LinuxSampler Contr
2431           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2432           error message           error message
2433    
2434     Example:     Example (Unix):
2435    
2436          C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
2437    
2438          S: OK
2439    
2440       Example (Windows):
2441    
2442          C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
2443    
2444          S: OK
2445    
2446  6.4.2.  Loading a sampler engine  6.4.2.  Loading a sampler engine
2447    
# Line 2436  Internet-Draft        LinuxSampler Contr Line 2457  Internet-Draft        LinuxSampler Contr
2457     be assigned to.  This command should be issued after adding a new     be assigned to.  This command should be issued after adding a new
2458     sampler channel and before any other control commands on the new     sampler channel and before any other control commands on the new
2459     sampler channel.  It can also be used to change the engine type of a     sampler channel.  It can also be used to change the engine type of a
2460    
2461    
2462    
2463    Schoenebeck              Expires March 14, 2009                [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol       September 2008
2466    
2467    
2468     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
2469     force if a new engine instance should be created and assigned to the     force if a new engine instance should be created and assigned to the
2470     given sampler channel or if an already existing instance of that     given sampler channel or if an already existing instance of that
# Line 2458  Internet-Draft        LinuxSampler Contr Line 2487  Internet-Draft        LinuxSampler Contr
2487           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2488           error message           error message
2489    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 44]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2490     Example:     Example:
2491    
2492    
# Line 2488  Internet-Draft        LinuxSampler Contr Line 2510  Internet-Draft        LinuxSampler Contr
2510    
2511        S: "12"        S: "12"
2512    
2513    
2514    
2515    
2516    
2517    
2518    
2519    Schoenebeck              Expires March 14, 2009                [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol       September 2008
2522    
2523    
2524  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2525    
2526     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
# Line 2512  Internet-Draft        LinuxSampler Contr Line 2545  Internet-Draft        LinuxSampler Contr
2545     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2546     list by sending the following command:     list by sending the following command:
2547    
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2548        ADD CHANNEL        ADD CHANNEL
2549    
2550     This will increment the sampler channel count by one and the new     This will increment the sampler channel count by one and the new
# Line 2544  Internet-Draft        LinuxSampler Contr Line 2568  Internet-Draft        LinuxSampler Contr
2568    
2569        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck              Expires March 14, 2009                [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 2570  Internet-Draft        LinuxSampler Contr Line 2603  Internet-Draft        LinuxSampler Contr
2603    
2604     Possible Answers:     Possible Answers:
2605    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2606        "OK" -        "OK" -
2607    
2608           in case the given sampler channel could be removed           in case the given sampler channel could be removed
# Line 2596  Internet-Draft        LinuxSampler Contr Line 2622  Internet-Draft        LinuxSampler Contr
2622    
2623    
2624    
2625    
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck              Expires March 14, 2009                [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol       September 2008
2634    
2635    
2636  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
2637    
2638     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
# Line 2623  Internet-Draft        LinuxSampler Contr Line 2660  Internet-Draft        LinuxSampler Contr
2660    
2661     Possible Answers:     Possible Answers:
2662    
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2663        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
2664        engines' names encapsulated into apostrophes (').  Engine names        engines' names encapsulated into apostrophes (').  Engine names
2665        can consist of lower and upper cases, digits and underlines ("_"        can consist of lower and upper cases, digits and underlines ("_"
# Line 2654  Internet-Draft        LinuxSampler Contr Line 2681  Internet-Draft        LinuxSampler Contr
2681     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2682     AVAILABLE_ENGINES" (Section 6.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2683    
2684    
2685    
2686    
2687    Schoenebeck              Expires March 14, 2009                [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 2666  Internet-Draft        LinuxSampler Contr Line 2701  Internet-Draft        LinuxSampler Contr
2701    
2702           DESCRIPTION -           DESCRIPTION -
2703    
2704              arbitrary description text about the engine              arbitrary description text about the engine (note that the
2705                character string may contain escape sequences (Section 7.1))
2706    
2707           VERSION -           VERSION -
2708    
# Line 2680  Internet-Draft        LinuxSampler Contr Line 2716  Internet-Draft        LinuxSampler Contr
2716    
2717        S: "DESCRIPTION: this is Joe's custom sampler engine"        S: "DESCRIPTION: this is Joe's custom sampler engine"
2718    
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2719           "VERSION: testing-1.0"           "VERSION: testing-1.0"
2720    
2721           "."           "."
# Line 2710  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
2737        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
2738        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
2739        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2740    
2741    
2742    
2743    Schoenebeck              Expires March 14, 2009                [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol       September 2008
2746    
2747    
2748        following categories are defined:        following categories are defined:
2749    
2750    
# Line 2737  Internet-Draft        LinuxSampler Contr Line 2772  Internet-Draft        LinuxSampler Contr
2772              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
2773              of the selected audio output device each sampler output              of the selected audio output device each sampler output
2774              channel is routed to, e.g. "0,3" would mean the engine's              channel is routed to, e.g. "0,3" would mean the engine's
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 49]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2775              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
2776              device and the engine's output channel 1 is routed to the              device and the engine's output channel 1 is routed to the
2777              channel 3 of the audio output device              channel 3 of the audio output device
# Line 2752  Internet-Draft        LinuxSampler Contr Line 2779  Internet-Draft        LinuxSampler Contr
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 2760  Internet-Draft        LinuxSampler Contr Line 2789  Internet-Draft        LinuxSampler Contr
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 March 14, 2009                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol       September 2008
2802    
2803    
2804           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2805    
# Line 2791  Internet-Draft        LinuxSampler Contr Line 2830  Internet-Draft        LinuxSampler Contr
2830              (where a value < 1.0 means attenuation and a value > 1.0              (where a value < 1.0 means attenuation and a value > 1.0
2831              means amplification)              means amplification)
2832    
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2833           MUTE -           MUTE -
2834    
2835              Determines whether the channel is muted, "true" if the              Determines whether the channel is muted, "true" if the
# Line 2821  Internet-Draft        LinuxSampler Contr Line 2850  Internet-Draft        LinuxSampler Contr
2850              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2851              values.              values.
2852    
2853    
2854    
2855    Schoenebeck              Expires March 14, 2009                [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 2849  Internet-Draft        LinuxSampler Contr Line 2885  Internet-Draft        LinuxSampler Contr
2885    
2886           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2887    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2888           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2889    
2890           "VOLUME: 1.0"           "VOLUME: 1.0"
# Line 2877  Internet-Draft        LinuxSampler Contr Line 2905  Internet-Draft        LinuxSampler Contr
2905        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2906    
2907     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2908    
2909    
2910    
2911    Schoenebeck              Expires March 14, 2009                [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol       September 2008
2914    
2915    
2916     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2917     "LIST CHANNELS" (Section 6.4.4) command.     "LIST CHANNELS" (Section 6.4.4) command.
2918    
# Line 2905  Internet-Draft        LinuxSampler Contr Line 2941  Internet-Draft        LinuxSampler Contr
2941        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
2942        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
2943        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2944        return "NA" for not available.        return "NA" for not available.
2945    
2946     Example:     Example:
# Line 2933  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
2962     sampler channel number the front-end is interested in as returned by     sampler channel number the front-end is interested in as returned by
2963     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2964    
2965    
2966    
2967    Schoenebeck              Expires March 14, 2009                [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol       September 2008
2970    
2971    
2972     command.     command.
2973    
2974     Possible Answers:     Possible Answers:
# Line 2960  Internet-Draft        LinuxSampler Contr Line 2996  Internet-Draft        LinuxSampler Contr
2996    
2997        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2998    
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
2999        S: ""        S: ""
3000    
3001  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 2988  Internet-Draft        LinuxSampler Contr Line 3015  Internet-Draft        LinuxSampler Contr
3015    
3016     Possible Answers:     Possible Answers:
3017    
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck              Expires March 14, 2009                [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol       September 2008
3026    
3027    
3028        "OK" -        "OK" -
3029    
3030           on success           on success
# Line 3017  Internet-Draft        LinuxSampler Contr Line 3054  Internet-Draft        LinuxSampler Contr
3054        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3055        type>        type>
3056    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3057     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3058     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
3059    
# Line 3045  Internet-Draft        LinuxSampler Contr Line 3074  Internet-Draft        LinuxSampler Contr
3074           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3075           error message           error message
3076    
3077    
3078    
3079    Schoenebeck              Expires March 14, 2009                [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol       September 2008
3082    
3083    
3084     Examples:     Examples:
3085    
3086    
# Line 3072  Internet-Draft        LinuxSampler Contr Line 3108  Internet-Draft        LinuxSampler Contr
3108    
3109        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3110    
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3111           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3112           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3113           warning message           warning message
# Line 3102  Internet-Draft        LinuxSampler Contr Line 3129  Internet-Draft        LinuxSampler Contr
3129        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3130    
3131     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
3132    
3133    
3134    
3135    Schoenebeck              Expires March 14, 2009                [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 Contr Line 3163  Internet-Draft        LinuxSampler Contr
3163    
3164    
3165    
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3166  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
3167    
3168     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 3159  Internet-Draft        LinuxSampler Contr Line 3185  Internet-Draft        LinuxSampler Contr
3185    
3186           if MIDI input type was set, but there are noteworthy issue(s)           if MIDI input type was set, but there are noteworthy issue(s)
3187           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3188    
3189    
3190    
3191    Schoenebeck              Expires March 14, 2009                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol       September 2008
3194    
3195    
3196           message           message
3197    
3198        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3184  Internet-Draft        LinuxSampler Contr Line 3218  Internet-Draft        LinuxSampler Contr
3218    
3219        "OK" -        "OK" -
3220    
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3221           on success           on success
3222    
3223        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3215  Internet-Draft        LinuxSampler Contr Line 3240  Internet-Draft        LinuxSampler Contr
3240     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3241     listen to by sending the following command:     listen to by sending the following command:
3242    
3243    
3244    
3245    
3246    
3247    Schoenebeck              Expires March 14, 2009                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol       September 2008
3250    
3251    
3252        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3253    
3254     Where <midi-input-chan> is the number of the new MIDI input channel     Where <midi-input-chan> is the number of the new MIDI input channel
# Line 3242  Internet-Draft        LinuxSampler Contr Line 3276  Internet-Draft        LinuxSampler Contr
3276    
3277    
3278    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 58]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
   
   
3279  6.4.21.  Setting channel volume  6.4.21.  Setting channel volume
3280    
3281     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
# Line 3271  Internet-Draft        LinuxSampler Contr Line 3296  Internet-Draft        LinuxSampler Contr
3296    
3297        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3298    
3299    
3300    
3301    
3302    
3303    Schoenebeck              Expires March 14, 2009                [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol       September 2008
3306    
3307    
3308           if channel volume was set, but there are noteworthy issue(s)           if channel volume was set, but there are noteworthy issue(s)
3309           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3310           message           message
# Line 3298  Internet-Draft        LinuxSampler Contr Line 3332  Internet-Draft        LinuxSampler Contr
3332    
3333     Possible Answers:     Possible Answers:
3334    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3335        "OK" -        "OK" -
3336    
3337           on success           on success
# Line 3324  Internet-Draft        LinuxSampler Contr Line 3351  Internet-Draft        LinuxSampler Contr
3351    
3352    
3353    
3354    
3355    
3356    
3357    
3358    
3359    Schoenebeck              Expires March 14, 2009                [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 3353  Internet-Draft        LinuxSampler Contr Line 3390  Internet-Draft        LinuxSampler Contr
3390           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3391           error message           error message
3392    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3393     Examples:     Examples:
3394    
3395    
# Line 3379  Internet-Draft        LinuxSampler Contr Line 3408  Internet-Draft        LinuxSampler Contr
3408    
3409        "NONE" -        "NONE" -
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck              Expires March 14, 2009                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol       September 2008
3418    
3419    
3420           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
3421           is not assigned any MIDI instrument map and thus will ignore           is not assigned any MIDI instrument map and thus will ignore
3422           all MIDI program change messages.           all MIDI program change messages.
# Line 3410  Internet-Draft        LinuxSampler Contr Line 3448  Internet-Draft        LinuxSampler Contr
3448           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3449           error message           error message
3450    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3451     Examples:     Examples:
3452    
3453    
# Line 3434  Internet-Draft        LinuxSampler Contr Line 3465  Internet-Draft        LinuxSampler Contr
3465     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3466     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3467     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3468     effect send entity.  The name does not have to be unique.  
3469    
3470    
3471    Schoenebeck              Expires March 14, 2009                [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 3463  Internet-Draft        LinuxSampler Contr Line 3505  Internet-Draft        LinuxSampler Contr
3505           channel, where <fx-send-id> reflects the unique ID of the newly           channel, where <fx-send-id> reflects the unique ID of the newly
3506           created effect send entity           created effect send entity
3507    
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3508        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3509    
3510           when a new effect send could not be added, i.e. due to invalid           when a new effect send could not be added, i.e. due to invalid
# Line 3488  Internet-Draft        LinuxSampler Contr Line 3520  Internet-Draft        LinuxSampler Contr
3520    
3521        S: "OK[1]"        S: "OK[1]"
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck              Expires March 14, 2009                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 3519  Internet-Draft        LinuxSampler Contr Line 3560  Internet-Draft        LinuxSampler Contr
3560    
3561        S: "OK"        S: "OK"
3562    
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3563  6.4.27.  Getting amount of effect sends on a sampler channel  6.4.27.  Getting amount of effect sends on a sampler channel
3564    
3565     The front-end can ask for the amount of effect sends on a specific     The front-end can ask for the amount of effect sends on a specific
# Line 3547  Internet-Draft        LinuxSampler Contr Line 3578  Internet-Draft        LinuxSampler Contr
3578    
3579     Example:     Example:
3580    
3581    
3582    
3583    Schoenebeck              Expires March 14, 2009                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol       September 2008
3586    
3587    
3588        C: "GET FX_SENDS 0"        C: "GET FX_SENDS 0"
3589    
3590        S: "2"        S: "2"
# Line 3577  Internet-Draft        LinuxSampler Contr Line 3615  Internet-Draft        LinuxSampler Contr
3615    
3616        S: ""        S: ""
3617    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 64]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3618  6.4.29.  Getting effect send information  6.4.29.  Getting effect send information
3619    
3620     The front-end can ask for the current settings of an effect send     The front-end can ask for the current settings of an effect send
# Line 3603  Internet-Draft        LinuxSampler Contr Line 3633  Internet-Draft        LinuxSampler Contr
3633        The sampler will answer by sending a <CRLF> separated list.  Each        The sampler will answer by sending a <CRLF> separated list.  Each
3634        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
3635        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
3636    
3637    
3638    
3639    Schoenebeck              Expires March 14, 2009                [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 3610  Internet-Draft        LinuxSampler Contr Line 3648  Internet-Draft        LinuxSampler Contr
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 3633  Internet-Draft        LinuxSampler Contr Line 3672  Internet-Draft        LinuxSampler Contr
3672              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3673              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3674    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3675     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3676    
3677     Example:     Example:
# Line 3657  Internet-Draft        LinuxSampler Contr Line 3688  Internet-Draft        LinuxSampler Contr
3688    
3689           "."           "."
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck              Expires March 14, 2009                [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 3669  Internet-Draft        LinuxSampler Contr Line 3709  Internet-Draft        LinuxSampler Contr
3709     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3710     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3711     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3712     effect send entity, which does not have to be unique.     effect send entity, which does not have to be unique (name MUST be
3713       encapsulated into apostrophes and supports escape sequences as
3714       described in chapter "Character Set and Escape Sequences
3715       (Section 7.1)").
3716    
3717     Possible Answers:     Possible Answers:
3718    
# Line 3688  Internet-Draft        LinuxSampler Contr Line 3731  Internet-Draft        LinuxSampler Contr
3731    
3732        S: "OK"        S: "OK"
3733    
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3734  6.4.31.  Altering effect send's audio routing  6.4.31.  Altering effect send's audio routing
3735    
3736     The front-end can alter the destination of an effect send's audio     The front-end can alter the destination of an effect send's audio
# Line 3711  Internet-Draft        LinuxSampler Contr Line 3745  Internet-Draft        LinuxSampler Contr
3745     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3746     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3747     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3748    
3749    
3750    
3751    Schoenebeck              Expires March 14, 2009                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol       September 2008
3754    
3755    
3756     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
3757     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
3758     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.
# Line 3746  Internet-Draft        LinuxSampler Contr Line 3788  Internet-Draft        LinuxSampler Contr
3788    
3789     Example:     Example:
3790    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3791        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3792    
3793        S: "OK"        S: "OK"
# Line 3766  Internet-Draft        LinuxSampler Contr Line 3801  Internet-Draft        LinuxSampler Contr
3801        ctrl>        ctrl>
3802    
3803     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3804    
3805    
3806    
3807    Schoenebeck              Expires March 14, 2009                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol       September 2008
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 3801  Internet-Draft        LinuxSampler Contr Line 3844  Internet-Draft        LinuxSampler Contr
3844     The front-end can alter the current send level of an effect send     The front-end can alter the current send level of an effect send
3845     entity by sending the following command:     entity by sending the following command:
3846    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3847        SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>        SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3848    
3849     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
# Line 3822  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857    
3858     Possible Answers:     Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck              Expires March 14, 2009                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol       September 2008
3866    
3867    
3868        "OK" -        "OK" -
3869    
3870           on success           on success
# Line 3843  Internet-Draft        LinuxSampler Contr Line 3886  Internet-Draft        LinuxSampler Contr
3886    
3887        S: "OK"        S: "OK"
3888    
3889  6.4.34.  Resetting a sampler channel  6.4.34.  Sending MIDI messages to sampler channel
3890    
3891       The front-end can send MIDI events to specific sampler channel by
3892       sending the following command:
3893    
3894          SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>
3895    
3896       Where <sampler-chan> is the sampler channel number as returned by the
3897       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3898       command, <arg1> and <arg2> arguments depend on the <midi-msg>
3899       argument, which specifies the MIDI message type.  Currently, the
3900       following MIDI messages are supported:
3901    
3902          "NOTE_ON" -
3903    
3904             For turning on MIDI notes, where <arg1> specifies the key
3905             number and <arg2> the velocity as described in the MIDI
3906             specification.
3907    
3908          "NOTE_OFF" -
3909    
3910             For turning a currently playing MIDI note off, where <arg1>
3911             specifies the key number and <arg2> the velocity as described
3912             in the MIDI specification.
3913    
3914       CAUTION: This command is provided for implementations of virtual MIDI
3915       keyboards and no realtime guarantee whatsoever will be made!
3916    
3917    
3918    
3919    Schoenebeck              Expires March 14, 2009                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol       September 2008
3922    
3923    
3924       Possible Answers:
3925    
3926          "OK" -
3927    
3928             on success
3929    
3930          "ERR:<error-code>:<error-message>" -
3931    
3932             in case it failed, providing an appropriate error code and
3933             error message
3934    
3935       Example:
3936    
3937          C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
3938    
3939          S: "OK"
3940    
3941    6.4.35.  Resetting a sampler channel
3942    
3943     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3944     following command:     following command:
# Line 3857  Internet-Draft        LinuxSampler Contr Line 3952  Internet-Draft        LinuxSampler Contr
3952    
3953     Possible Answers:     Possible Answers:
3954    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
3955        "OK" -        "OK" -
3956    
3957           on success           on success
# Line 3884  Internet-Draft        LinuxSampler Contr Line 3971  Internet-Draft        LinuxSampler Contr
3971    
3972    
3973    
3974    
3975    Schoenebeck              Expires March 14, 2009                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol       September 2008
3978    
3979    
3980    
3981    
3982  6.5.  Controlling connection  6.5.  Controlling connection
3983    
3984     The following commands are used to control the connection to     The following commands are used to control the connection to
# Line 3911  Internet-Draft        LinuxSampler Contr Line 4006  Internet-Draft        LinuxSampler Contr
4006           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4007           message           message
4008    
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4009        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4010    
4011           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3940  Internet-Draft        LinuxSampler Contr Line 4025  Internet-Draft        LinuxSampler Contr
4025     Where <event-id> will be replaced by the respective event that client     Where <event-id> will be replaced by the respective event that client
4026     doesn't want to receive anymore.     doesn't want to receive anymore.
4027    
4028    
4029    
4030    
4031    Schoenebeck              Expires March 14, 2009                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol       September 2008
4034    
4035    
4036     Possible Answers:     Possible Answers:
4037    
4038        "OK" -        "OK" -
# Line 3969  Internet-Draft        LinuxSampler Contr Line 4062  Internet-Draft        LinuxSampler Contr
4062        SET ECHO <value>        SET ECHO <value>
4063    
4064     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4065     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
4066     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
4067     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 3997  Internet-Draft        LinuxSampler Contr Line 4082  Internet-Draft        LinuxSampler Contr
4082    
4083    
4084    
4085    
4086    
4087    Schoenebeck              Expires March 14, 2009                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol       September 2008
4090    
4091    
4092    
4093    
4094  6.5.4.  Close client connection  6.5.4.  Close client connection
4095    
4096     The client can close its network connection to LinuxSampler by     The client can close its network connection to LinuxSampler by
# Line 4023  Internet-Draft        LinuxSampler Contr Line 4117  Internet-Draft        LinuxSampler Contr
4117        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4118        voices on the sampler.        voices on the sampler.
4119    
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4120  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
4121    
4122     The front-end can ask for the maximum number of active voices by     The front-end can ask for the maximum number of active voices by
# Line 4045  Internet-Draft        LinuxSampler Contr Line 4129  Internet-Draft        LinuxSampler Contr
4129        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4130        voices.        voices.
4131    
4132  6.6.3.  Reset sampler  6.6.3.  Current number of active disk streams
4133    
4134       The front-end can ask for the current number of active disk streams
4135       on the sampler by sending the following command:
4136    
4137          GET TOTAL_STREAM_COUNT
4138    
4139       Possible Answers:
4140    
4141    
4142    
4143    Schoenebeck              Expires March 14, 2009                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol       September 2008
4146    
4147    
4148          LinuxSampler will answer by returning the number of all active
4149          disk streams on the sampler.
4150    
4151    6.6.4.  Reset sampler
4152    
4153     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
4154     command:     command:
# Line 4062  Internet-Draft        LinuxSampler Contr Line 4165  Internet-Draft        LinuxSampler Contr
4165    
4166    
4167    
4168  6.6.4.  General sampler informations  6.6.5.  General sampler informations
4169    
4170     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
4171     instance by sending the following command:     instance by sending the following command:
# Line 4081  Internet-Draft        LinuxSampler Contr Line 4184  Internet-Draft        LinuxSampler Contr
4184    
4185           DESCRIPTION -           DESCRIPTION -
4186    
4187                arbitrary textual description about the sampler (note that
4188                the character string may contain escape sequences
4189                (Section 7.1))
4190    
4191             VERSION -
4192    
4193                version of the sampler
4194    
 Schoenebeck             Expires November 17, 2007              [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
4195    
4196    
             arbitrary textual description about the sampler  
4197    
          VERSION -  
4198    
4199              version of the sampler  Schoenebeck              Expires March 14, 2009                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol       September 2008
4202    
4203    
4204           PROTOCOL_VERSION -           PROTOCOL_VERSION -
4205    
# Line 4108  Internet-Draft        LinuxSampler Contr Line 4214  Internet-Draft        LinuxSampler Contr
4214     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4215     Other fields might be added in future.     Other fields might be added in future.
4216    
4217  6.6.5.  Getting global volume attenuation  6.6.6.  Getting global volume attenuation
4218    
4219     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
4220     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4125  Internet-Draft        LinuxSampler Contr Line 4231  Internet-Draft        LinuxSampler Contr
4231     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
4232     this parameter.     this parameter.
4233    
4234  6.6.6.  Setting global volume attenuation  6.6.7.  Setting global volume attenuation
4235    
4236     The client can alter the current global sampler-wide volume     The client can alter the current global sampler-wide volume
4237     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4137  Internet-Draft        LinuxSampler Contr Line 4243  Internet-Draft        LinuxSampler Contr
4243     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
4244     attenuating the overall volume.     attenuating the overall volume.
4245    
4246       Possible Answers:
4247    
4248          "OK" -
4249    
4250             on success
4251    
 Schoenebeck             Expires November 17, 2007              [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
4252    
4253    
    Possible Answers:  
4254    
4255        "OK" -  Schoenebeck              Expires March 14, 2009                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol       September 2008
4258    
          on success  
4259    
4260        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4261    
# Line 4192  Internet-Draft        LinuxSampler Contr Line 4298  Internet-Draft        LinuxSampler Contr
4298     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4299     current MIDI instrument map.     current MIDI instrument map.
4300    
4301    6.7.1.  Create a new MIDI instrument map
4302    
4303       The front-end can add a new MIDI instrument map by sending the
4304       following command:
4305    
4306    
4307    
4308    
 Schoenebeck             Expires November 17, 2007              [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
4309    
4310    
4311  6.7.1.  Create a new MIDI instrument map  Schoenebeck              Expires March 14, 2009                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol       September 2008
4314    
    The front-end can add a new MIDI instrument map by sending the  
    following command:  
4315    
4316        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4317    
4318     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
4319     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,
4320       but MUST be encapsulated into apostrophes and support escape
4321       sequences as described in chapter "Character Set and Escape Sequences
4322       (Section 7.1)".
4323    
4324     Possible Answers:     Possible Answers:
4325    
# Line 4252  Internet-Draft        LinuxSampler Contr Line 4362  Internet-Draft        LinuxSampler Contr
4362    
4363    
4364    
4365  Schoenebeck             Expires November 17, 2007              [Page 76]  
4366    
4367    Schoenebeck              Expires March 14, 2009                [Page 78]
4368    
4369  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
4370    
4371    
4372        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
# Line 4308  Internet-Draft        LinuxSampler Contr Line 4420  Internet-Draft        LinuxSampler Contr
4420    
4421    
4422    
4423  Schoenebeck             Expires November 17, 2007              [Page 77]  Schoenebeck              Expires March 14, 2009                [Page 79]
4424    
4425  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
4426    
4427    
4428        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
# Line 4350  Internet-Draft        LinuxSampler Contr Line 4462  Internet-Draft        LinuxSampler Contr
4462           NAME -           NAME -
4463    
4464              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
4465              unique              unique (note that this character string may contain escape
4466                sequences (Section 7.1))
4467    
4468           DEFAULT -           DEFAULT -
4469    
# Line 4363  Internet-Draft        LinuxSampler Contr Line 4476  Internet-Draft        LinuxSampler Contr
4476    
4477    
4478    
4479    Schoenebeck              Expires March 14, 2009                [Page 80]
 Schoenebeck             Expires November 17, 2007              [Page 78]  
4480    
4481  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
4482    
4483    
4484        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
# Line 4385  Internet-Draft        LinuxSampler Contr Line 4497  Internet-Draft        LinuxSampler Contr
4497        SET MIDI_INSTRUMENT_MAP NAME <map> <name>        SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4498    
4499     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
4500     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
4501       encapsulated into apostrophes and supports escape sequences as
4502       described in chapter "Character Set and Escape Sequences
4503       (Section 7.1)").
4504    
4505     Possible Answers:     Possible Answers:
4506    
# Line 4414  Internet-Draft        LinuxSampler Contr Line 4529  Internet-Draft        LinuxSampler Contr
4529    
4530     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
4531     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
    <midi_prog> an integer value between 0..127 reflecting the MIDI  
    program change index, <engine_name> a sampler engine name as returned  
    by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not  
4532    
4533    
4534    
4535  Schoenebeck             Expires November 17, 2007              [Page 79]  Schoenebeck              Expires March 14, 2009                [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
4538    
4539    
4540       <midi_prog> an integer value between 0..127 reflecting the MIDI
4541       program change index, <engine_name> a sampler engine name as returned
4542       by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4543     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
4544     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes,
4545     <instrument_index> the index (integer value) of the instrument within     supporting escape sequences as described in chapter "Character Set
4546     the given file, <volume_value> reflects the master volume of the     and Escape Sequences (Section 7.1)"), <instrument_index> the index
4547     instrument as optionally dotted number (where a value < 1.0 means     (integer value) of the instrument within the given file,
4548     attenuation and a value > 1.0 means amplification).  This parameter     <volume_value> reflects the master volume of the instrument as
4549     easily allows to adjust the volume of all intruments within a custom     optionally dotted number (where a value < 1.0 means attenuation and a
4550     instrument map without having to adjust their instrument files.  The     value > 1.0 means amplification).  This parameter easily allows to
4551     OPTIONAL <instr_load_mode> argument defines the life time of the     adjust the volume of all intruments within a custom instrument map
4552     instrument, that is when the instrument should be loaded, when freed     without having to adjust their instrument files.  The OPTIONAL
4553     and has exactly the following possibilities:     <instr_load_mode> argument defines the life time of the instrument,
4554       that is when the instrument should be loaded, when freed and has
4555       exactly the following possibilities:
4556    
4557        "ON_DEMAND" -        "ON_DEMAND" -
4558    
# Line 4468  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585           In case there is no <instr_load_mode> argument given, it will           In case there is no <instr_load_mode> argument given, it will
4586           be up to the InstrumentManager to decide which mode to use.           be up to the InstrumentManager to decide which mode to use.
4587           Usually it will use "ON_DEMAND" if an entry for the given           Usually it will use "ON_DEMAND" if an entry for the given
          instrument does not exist in the InstrumentManager's list yet,  
          otherwise if an entry already exists, it will simply stick with  
          the mode currently reflected by the already existing entry,  
          that is it will not change the mode.  
4588    
4589    
4590    
4591    Schoenebeck              Expires March 14, 2009                [Page 82]
 Schoenebeck             Expires November 17, 2007              [Page 80]  
4592    
4593  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
4594    
4595    
4596             instrument does not exist in the InstrumentManager's list yet,
4597             otherwise if an entry already exists, it will simply stick with
4598             the mode currently reflected by the already existing entry,
4599             that is it will not change the mode.
4600    
4601     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
4602     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
4603     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
# Line 4496  Internet-Draft        LinuxSampler Contr Line 4613  Internet-Draft        LinuxSampler Contr
4613     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4614     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4615     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4616     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes, supporting escape sequences as described in chapter
4617     displaying an appropriate name for mapped instruments (using "GET     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4618     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     entry, useful for frontends for displaying an appropriate name for
4619       mapped instruments (using "GET MIDI_INSTRUMENT INFO"
4620       (Section 6.7.11)).
4621    
4622     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4623     completely established in the sampler.  The OPTIONAL "NON_MODAL"     completely established in the sampler.  The OPTIONAL "NON_MODAL"
# Line 4521  Internet-Draft        LinuxSampler Contr Line 4640  Internet-Draft        LinuxSampler Contr
4640    
4641           usually           usually
4642    
       "ERR:<error-code>:<error-message>" -  
4643    
          when the given map or engine does not exist or a value is out  
          of range  
4644    
    Examples:  
4645    
4646    
4647    Schoenebeck              Expires March 14, 2009                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol       September 2008
4650    
4651    
4652          "ERR:<error-code>:<error-message>" -
4653    
4654  Schoenebeck             Expires November 17, 2007              [Page 81]           when the given map or engine does not exist or a value is out
4655             of range
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
4656    
4657       Examples:
4658    
4659        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4660        0.8 PERSISTENT"        0.8 PERSISTENT"
# Line 4576  Internet-Draft        LinuxSampler Contr Line 4695  Internet-Draft        LinuxSampler Contr
4695    
4696     Possible Answers:     Possible Answers:
4697    
       The sampler will answer by sending the current number of entries  
       in the MIDI instrument map(s).  
4698    
    Example:  
4699    
       C: "GET MIDI_INSTRUMENTS 0"  
4700    
       S: "234"  
4701    
4702    
4703    Schoenebeck              Expires March 14, 2009                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol       September 2008
4706    
4707    
4708  Schoenebeck             Expires November 17, 2007              [Page 82]        The sampler will answer by sending the current number of entries
4709          in the MIDI instrument map(s).
4710  Internet-Draft        LinuxSampler Control Protocol             May 2007  
4711       Example:
4712    
4713          C: "GET MIDI_INSTRUMENTS 0"
4714    
4715          S: "234"
4716    
4717        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
4718    
# Line 4632  Internet-Draft        LinuxSampler Contr Line 4753  Internet-Draft        LinuxSampler Contr
4753     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
4754     sending the following command:     sending the following command:
4755    
4756    
4757    
4758    
4759    Schoenebeck              Expires March 14, 2009                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol       September 2008
4762    
4763    
4764        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4765    
4766     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 4641  Internet-Draft        LinuxSampler Contr Line 4770  Internet-Draft        LinuxSampler Contr
4770    
4771     Possible Answers:     Possible Answers:
4772    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4773        "OK" -        "OK" -
4774    
4775           usually           usually
# Line 4688  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809    
4810           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
4811           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
          mapped instrument.  It can be set and changed with the "MAP  
          MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to  
          be unique.  
   
       "ENGINE_NAME" -  
4812    
          Name of the engine to be deployed for this instrument.  
4813    
4814    
4815    Schoenebeck              Expires March 14, 2009                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol       September 2008
4818    
4819    
4820             mapped instrument.  It can be set and changed with the "MAP
4821             MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4822             be unique. (note that this character string may contain escape
4823             sequences (Section 7.1))
4824    
4825  Schoenebeck             Expires November 17, 2007              [Page 84]        "ENGINE_NAME" -
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
4826    
4827             Name of the engine to be deployed for this instrument.
4828    
4829        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4830    
4831           File name of the instrument.           File name of the instrument (note that this path may contain
4832             escape sequences (Section 7.1)).
4833    
4834        "INSTRUMENT_NR" -        "INSTRUMENT_NR" -
4835    
# Line 4717  Internet-Draft        LinuxSampler Contr Line 4839  Internet-Draft        LinuxSampler Contr
4839    
4840           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
4841           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4842           cannot be changed.           cannot be changed (note that this character string may contain
4843             escape sequences (Section 7.1)).
4844    
4845        "LOAD_MODE" -        "LOAD_MODE" -
4846    
# Line 4742  Internet-Draft        LinuxSampler Contr Line 4865  Internet-Draft        LinuxSampler Contr
4865    
4866           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4867    
          "INSTRUMENT_NR: 0"  
4868    
          "INSTRUMENT_NAME: Joe's Drumkit"  
4869    
          "LOAD_MODE: PERSISTENT"  
4870    
4871           "VOLUME: 1.0"  Schoenebeck              Expires March 14, 2009                [Page 87]
4872    
4873           "."  Internet-Draft        LinuxSampler Control Protocol       September 2008
4874    
4875    
4876             "INSTRUMENT_NR: 0"
4877    
4878             "INSTRUMENT_NAME: Joe's Drumkit"
4879    
4880             "LOAD_MODE: PERSISTENT"
4881    
4882  Schoenebeck             Expires November 17, 2007              [Page 85]           "VOLUME: 1.0"
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
4883    
4884             "."
4885    
4886  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
4887    
# Line 4795  Internet-Draft        LinuxSampler Contr Line 4917  Internet-Draft        LinuxSampler Contr
4917    
4918        S: "OK"        S: "OK"
4919    
4920    
4921    
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck              Expires March 14, 2009                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol       September 2008
4930    
4931    
4932  6.8.  Managing Instruments Database  6.8.  Managing Instruments Database
4933    
4934     The following commands describe how to use and manage the instruments     The following commands describe how to use and manage the instruments
4935     database.     database.
4936    
4937       Notice:
4938    
4939          All command arguments representing a path or instrument/directory
4940          name support escape sequences as described in chapter "Character
4941          Set and Escape Sequences (Section 7.1)".
4942    
4943          All occurrences of a forward slash in instrument and directory
4944          names are escaped with its hex (\x2f) or octal (\057) escape
4945          sequence.
4946    
4947  6.8.1.  Creating a new instrument directory  6.8.1.  Creating a new instrument directory
4948    
4949     The front-end can add a new instrument directory to the instruments     The front-end can add a new instrument directory to the instruments
# Line 4810  Internet-Draft        LinuxSampler Contr Line 4954  Internet-Draft        LinuxSampler Contr
4954     Where <dir> is the absolute path name of the directory to be created     Where <dir> is the absolute path name of the directory to be created
4955     (encapsulated into apostrophes).     (encapsulated into apostrophes).
4956    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
4957     Possible Answers:     Possible Answers:
4958    
4959        "OK" -        "OK" -
# Line 4840  Internet-Draft        LinuxSampler Contr Line 4977  Internet-Draft        LinuxSampler Contr
4977     The front-end can delete a particular instrument directory from the     The front-end can delete a particular instrument directory from the
4978     instruments database by sending the following command:     instruments database by sending the following command:
4979    
4980    
4981    
4982    
4983    Schoenebeck              Expires March 14, 2009                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol       September 2008
4986    
4987    
4988        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>        REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4989    
4990     Where <dir> is the absolute path name of the directory to delete.     Where <dir> is the absolute path name of the directory to delete.
# Line 4863  Internet-Draft        LinuxSampler Contr Line 5008  Internet-Draft        LinuxSampler Contr
5008    
5009        S: "OK"        S: "OK"
5010    
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5011  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
5012    
5013     The front-end can retrieve the current amount of directories in a     The front-end can retrieve the current amount of directories in a
# Line 4896  Internet-Draft        LinuxSampler Contr Line 5031  Internet-Draft        LinuxSampler Contr
5031    
5032     Example:     Example:
5033    
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck              Expires March 14, 2009                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol       September 2008
5042    
5043    
5044        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"        C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
5045    
5046        S: "2"        S: "2"
# Line 4921  Internet-Draft        LinuxSampler Contr Line 5066  Internet-Draft        LinuxSampler Contr
5066    
5067           if the given directory does not exist.           if the given directory does not exist.
5068    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5069     Example:     Example:
5070    
5071        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
# Line 4952  Internet-Draft        LinuxSampler Contr Line 5089  Internet-Draft        LinuxSampler Contr
5089    
5090     Possible Answers:     Possible Answers:
5091    
5092    
5093    
5094    
5095    Schoenebeck              Expires March 14, 2009                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol       September 2008
5098    
5099    
5100        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5101        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5102        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
# Line 4962  Internet-Draft        LinuxSampler Contr Line 5107  Internet-Draft        LinuxSampler Contr
5107    
5108           DESCRIPTION -           DESCRIPTION -
5109    
5110              A brief description of the directory content              A brief description of the directory content.  Note that the
5111                character string may contain escape sequences (Section 7.1).
5112    
5113           CREATED -           CREATED -
5114    
# Line 4978  Internet-Draft        LinuxSampler Contr Line 5124  Internet-Draft        LinuxSampler Contr
5124    
5125     Example:     Example:
5126    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5127        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
5128    
5129        S: "DESCRIPTION: Piano collection of instruments in GigaSampler        S: "DESCRIPTION: Piano collection of instruments in GigaSampler
# Line 5006  Internet-Draft        LinuxSampler Contr Line 5145  Internet-Draft        LinuxSampler Contr
5145     Where <dir> is the absolute path name of the directory and <name> is     Where <dir> is the absolute path name of the directory and <name> is
5146     the new name for that directory.     the new name for that directory.
5147    
5148    
5149    
5150    
5151    Schoenebeck              Expires March 14, 2009                [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol       September 2008
5154    
5155    
5156     Possible Answers:     Possible Answers:
5157    
5158        "OK" -        "OK" -
# Line 5034  Internet-Draft        LinuxSampler Contr Line 5181  Internet-Draft        LinuxSampler Contr
5181     Where <dir> is the absolute path name of the directory to move and     Where <dir> is the absolute path name of the directory to move and
5182     <dst> is the location where the directory will be moved to.     <dst> is the location where the directory will be moved to.
5183    
   
   
 Schoenebeck             Expires November 17, 2007              [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5184     Possible Answers:     Possible Answers:
5185    
5186        "OK" -        "OK" -
# Line 5061  Internet-Draft        LinuxSampler Contr Line 5201  Internet-Draft        LinuxSampler Contr
5201    
5202        S: "OK"        S: "OK"
5203    
5204    
5205    
5206    
5207    Schoenebeck              Expires March 14, 2009                [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol       September 2008
5210    
5211    
5212  6.8.8.  Copying instrument directories  6.8.8.  Copying instrument directories
5213    
5214     The front-end can copy a specific instrument directory by sending the     The front-end can copy a specific instrument directory by sending the
# Line 5089  Internet-Draft        LinuxSampler Contr Line 5237  Internet-Draft        LinuxSampler Contr
5237        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5238        '/Acoustic/Pianos'"        '/Acoustic/Pianos'"
5239    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5240        S: "OK"        S: "OK"
5241    
5242  6.8.9.  Changing the description of directory  6.8.9.  Changing the description of directory
# Line 5107  Internet-Draft        LinuxSampler Contr Line 5247  Internet-Draft        LinuxSampler Contr
5247        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5248    
5249     Where <dir> is the absolute path name of the directory and <desc> is     Where <dir> is the absolute path name of the directory and <desc> is
5250     the new description for the directory.     the new description for the directory (encapsulated into apostrophes,
5251       supporting escape sequences as described in chapter "Character Set
5252       and Escape Sequences (Section 7.1)").
5253    
5254     Possible Answers:     Possible Answers:
5255    
# Line 5115  Internet-Draft        LinuxSampler Contr Line 5257  Internet-Draft        LinuxSampler Contr
5257    
5258           on success           on success
5259    
5260    
5261    
5262    
5263    Schoenebeck              Expires March 14, 2009                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol       September 2008
5266    
5267    
5268        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5269    
5270           in case the given directory does not exists.           in case the given directory does not exists.
# Line 5144  Internet-Draft        LinuxSampler Contr Line 5294  Internet-Draft        LinuxSampler Contr
5294     NAME='<search-string>'     NAME='<search-string>'
5295    
5296        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5297        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5298          escape sequences as described in chapter "Character Set and Escape
5299          Sequences (Section 7.1)").
   
 Schoenebeck             Expires November 17, 2007              [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
5300    
5301     CREATED='[<date-after>]..[<date-before>]'     CREATED='[<date-after>]..[<date-before>]'
5302    
# Line 5168  Internet-Draft        LinuxSampler Contr Line 5313  Internet-Draft        LinuxSampler Contr
5313        modification satisfies the specified period, where <date-after>        modification satisfies the specified period, where <date-after>
5314        and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-        and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5315        after> is omitted the search is restricted to directories, which        after> is omitted the search is restricted to directories, which
5316    
5317    
5318    
5319    Schoenebeck              Expires March 14, 2009                [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol       September 2008
5322    
5323    
5324        are last modified before <date-before>.  If <date-before> is        are last modified before <date-before>.  If <date-before> is
5325        omitted, the search is restricted to directories, which are last        omitted, the search is restricted to directories, which are last
5326        modified after <date-after>.        modified after <date-after>.
# Line 5175  Internet-Draft        LinuxSampler Contr Line 5328  Internet-Draft        LinuxSampler Contr
5328     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5329    
5330        Restricts the search to directories with description that        Restricts the search to directories with description that
5331        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5332          apostrophes, supporting escape sequences as described in chapter
5333          "Character Set and Escape Sequences (Section 7.1)").
5334    
5335     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5336     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
# Line 5201  Internet-Draft        LinuxSampler Contr Line 5356  Internet-Draft        LinuxSampler Contr
5356    
5357        S: "'/Piano Collection','/Percussions'"        S: "'/Piano Collection','/Percussions'"
5358    
   
   
   
 Schoenebeck             Expires November 17, 2007              [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5359  6.8.11.  Adding instruments to the instruments database  6.8.11.  Adding instruments to the instruments database
5360    
5361     The front-end can add one or more instruments to the instruments     The front-end can add one or more instruments to the instruments
5362     database by sending the following command:     database by sending the following command:
5363    
5364        ADD DB_INSTRUMENTS [<mode>] <db_dir> <file_path> [<instr_index>]        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>
5365          [<instr_index>]
5366    
5367     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5368     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
5369     instruments (that are not already in the database) will be added,     instruments (that are not already in the database) will be added,
5370     <file_path> is the absolute path name of a file or directory in the     <file_path> is the absolute path name of a file or directory in the
5371     file system (encapsulated into apostrophes).  In case an instrument     file system (encapsulated into apostrophes).  In case an instrument
5372    
5373    
5374    
5375    Schoenebeck              Expires March 14, 2009                [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol       September 2008
5378    
5379    
5380     file is supplied, only the instruments in the specified file will be     file is supplied, only the instruments in the specified file will be
5381     added to the instruments database.  If the optional <instr_index>     added to the instruments database.  If the optional <instr_index>
5382     (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 5230  Internet-Draft        LinuxSampler Contr Line 5386  Internet-Draft        LinuxSampler Contr
5386     is provided as <file_path> and specifies how the scanning will be     is provided as <file_path> and specifies how the scanning will be
5387     done and has exactly the following possibilities:     done and has exactly the following possibilities:
5388    
5389          "RECURSIVE" -
5390    
5391             All instruments will be processed, including those in the
5392             subdirectories, and the respective subdirectory tree structure
5393             will be recreated in the instruments database
5394    
5395        "NON_RECURSIVE" -        "NON_RECURSIVE" -
5396    
5397           Only the instruments in the specified directory will be added,           Only the instruments in the specified directory will be added,
# Line 5242  Internet-Draft        LinuxSampler Contr Line 5404  Internet-Draft        LinuxSampler Contr
5404           not be recreated in the instruments database.  All instruments           not be recreated in the instruments database.  All instruments
5405           will be added directly in the specified database directory.           will be added directly in the specified database directory.
5406    
5407        not supplied -     The difference between regular and NON_MODAL versions of the command
5408       is that the regular command returns when the scanning is finished
5409           The subdirectory tree structure will be recreated in the     while NON_MODAL version returns immediately and a background process
5410           instruments database and all instruments will be processed and     is launched.  The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5411           added to the respective subdirectory in the instruments     command can be used to monitor the scanning progress.
          database.  
5412    
5413     Possible Answers:     Possible Answers:
5414    
5415        "OK" -        "OK" -
5416    
5417           on success           on success when NON_MODAL is not supplied
5418    
5419          "OK[<job-id>]" -
5420    
5421             on success when NON_MODAL is supplied, where <job-id> is a
5422             numerical ID used to obtain status information about the job
5423             progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5424    
5425          "ERR:<error-code>:<error-message>" -
5426    
5427    
5428    
 Schoenebeck             Expires November 17, 2007              [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
5429    
5430    
5431        "ERR:<error-code>:<error-message>" -  Schoenebeck              Expires March 14, 2009                [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol       September 2008
5434    
5435    
5436           if an invalid path is specified.           if an invalid path is specified.
5437    
# Line 5314  Internet-Draft        LinuxSampler Contr Line 5480  Internet-Draft        LinuxSampler Contr
5480     including those located in subdirectories of the specified directory,     including those located in subdirectories of the specified directory,
5481     will be returned.     will be returned.
5482    
5483       Possible Answers:
5484    
5485    
 Schoenebeck             Expires November 17, 2007              [Page 95]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
5486    
5487    Schoenebeck              Expires March 14, 2009                [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol       September 2008
5490    
    Possible Answers:  
5491    
5492        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5493    
# Line 5372  Internet-Draft        LinuxSampler Contr Line 5538  Internet-Draft        LinuxSampler Contr
5538    
5539    
5540    
5541  Schoenebeck             Expires November 17, 2007              [Page 96]  
5542    
5543    Schoenebeck              Expires March 14, 2009                [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
5546    
5547    
5548  6.8.15.  Getting instrument information  6.8.15.  Getting instrument information
# Line 5399  Internet-Draft        LinuxSampler Contr Line 5567  Internet-Draft        LinuxSampler Contr
5567    
5568           INSTRUMENT_FILE -           INSTRUMENT_FILE -
5569    
5570              File name of the instrument.              File name of the instrument.  Note that the character string
5571                may contain escape sequences (Section 7.1).
5572    
5573           INSTRUMENT_NR -           INSTRUMENT_NR -
5574    
# Line 5427  Internet-Draft        LinuxSampler Contr Line 5596  Internet-Draft        LinuxSampler Contr
5596    
5597    
5598    
5599    Schoenebeck              Expires March 14, 2009               [Page 100]
 Schoenebeck             Expires November 17, 2007              [Page 97]  
5600    
5601  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
5602    
5603    
5604           MODIFIED -           MODIFIED -
# Line 5441  Internet-Draft        LinuxSampler Contr Line 5609  Internet-Draft        LinuxSampler Contr
5609    
5610           DESCRIPTION -           DESCRIPTION -
5611    
5612              A brief description of the instrument              A brief description of the instrument.  Note that the
5613                character string may contain escape sequences (Section 7.1).
5614    
5615           IS_DRUM -           IS_DRUM -
5616    
# Line 5450  Internet-Draft        LinuxSampler Contr Line 5619  Internet-Draft        LinuxSampler Contr
5619    
5620           PRODUCT -           PRODUCT -
5621    
5622              The product title of the instrument              The product title of the instrument.  Note that the
5623                character string may contain escape sequences (Section 7.1).
5624    
5625           ARTISTS -           ARTISTS -
5626    
5627              Lists the artist names              Lists the artist names.  Note that the character string may
5628                contain escape sequences (Section 7.1).
5629    
5630           KEYWORDS -           KEYWORDS -
5631    
5632              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
5633              Keywords are separated with semicolon and blank.              Keywords are separated with semicolon and blank.  Note that
5634                the character string may contain escape sequences
5635                (Section 7.1).
5636    
5637     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5638    
# Line 5475  Internet-Draft        LinuxSampler Contr Line 5648  Internet-Draft        LinuxSampler Contr
5648    
5649           "FORMAT_VERSION: 2"           "FORMAT_VERSION: 2"
5650    
          "SIZE: 2050871870"  
5651    
          "CREATED: 2007-02-05 10:23:12"  
5652    
          "MODIFIED: 2007-04-07 12:50:21"  
5653    
5654    
5655    Schoenebeck              Expires March 14, 2009               [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol       September 2008
5658    
5659    
5660             "SIZE: 2050871870"
5661    
5662  Schoenebeck             Expires November 17, 2007              [Page 98]           "CREATED: 2007-02-05 10:23:12"
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
5663    
5664             "MODIFIED: 2007-04-07 12:50:21"
5665    
5666           "DESCRIPTION: "           "DESCRIPTION: "
5667    
# Line 5529  Internet-Draft        LinuxSampler Contr Line 5703  Internet-Draft        LinuxSampler Contr
5703    
5704        S: "OK"        S: "OK"
5705    
 6.8.17.  Moving an instrument  
5706    
    The front-end can move a specific instrument to another directory by  
    sending the following command:  
5707    
       MOVE DB_INSTRUMENT <instr> <dst>  
   
    Where <instr> is the absolute path name of the instrument to move and  
5708    
5709    
5710    
5711  Schoenebeck             Expires November 17, 2007              [Page 99]  Schoenebeck              Expires March 14, 2009               [Page 102]
5712    
5713  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
5714    
5715    
5716    6.8.17.  Moving an instrument
5717    
5718       The front-end can move a specific instrument to another directory by
5719       sending the following command:
5720    
5721          MOVE DB_INSTRUMENT <instr> <dst>
5722    
5723       Where <instr> is the absolute path name of the instrument to move and
5724     <dst> is the directory where the instrument will be moved to.     <dst> is the directory where the instrument will be moved to.
5725    
5726     Possible Answers:     Possible Answers:
# Line 5584  Internet-Draft        LinuxSampler Contr Line 5760  Internet-Draft        LinuxSampler Contr
5760    
5761        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck              Expires March 14, 2009               [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol       September 2008
5770    
5771    
5772           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
5773           instrument with name equal to the name of the specified           instrument with name equal to the name of the specified
5774           instrument already exists in the destination directory.           instrument already exists in the destination directory.
# Line 5593  Internet-Draft        LinuxSampler Contr Line 5778  Internet-Draft        LinuxSampler Contr
5778        C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'        C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
5779        '/Acoustic/Pianos/'"        '/Acoustic/Pianos/'"
5780    
   
   
   
 Schoenebeck             Expires November 17, 2007             [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5781        S: "OK"        S: "OK"
5782    
5783  6.8.19.  Changing the description of instrument  6.8.19.  Changing the description of instrument
# Line 5611  Internet-Draft        LinuxSampler Contr Line 5788  Internet-Draft        LinuxSampler Contr
5788        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5789    
5790     Where <instr> is the absolute path name of the instrument and <desc>     Where <instr> is the absolute path name of the instrument and <desc>
5791     is the new description for the instrument.     is the new description for the instrument (encapsulated into
5792       apostrophes, supporting escape sequences as described in chapter
5793       "Character Set and Escape Sequences (Section 7.1)").
5794    
5795     Possible Answers:     Possible Answers:
5796    
# Line 5638  Internet-Draft        LinuxSampler Contr Line 5817  Internet-Draft        LinuxSampler Contr
5817        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>        FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5818    
5819     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5820    
5821    
5822    
5823    Schoenebeck              Expires March 14, 2009               [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol       September 2008
5826    
5827    
5828     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5829     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5830     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
# Line 5647  Internet-Draft        LinuxSampler Contr Line 5834  Internet-Draft        LinuxSampler Contr
5834     NAME='<search-string>'     NAME='<search-string>'
5835    
5836        Restricts the search to instruments, which names satisfy the        Restricts the search to instruments, which names satisfy the
5837        supplied search string.        supplied search string (encapsulated into apostrophes, supporting
5838          escape sequences as described in chapter "Character Set and Escape
5839          Sequences (Section 7.1)").
   
   
 Schoenebeck             Expires November 17, 2007             [Page 101]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
5840    
5841     SIZE=[<min>]..[<max>]     SIZE=[<min>]..[<max>]
5842    
# Line 5687  Internet-Draft        LinuxSampler Contr Line 5868  Internet-Draft        LinuxSampler Contr
5868     DESCRIPTION='<search-string>'     DESCRIPTION='<search-string>'
5869    
5870        Restricts the search to instruments with description that        Restricts the search to instruments with description that
5871        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5872          apostrophes, supporting escape sequences as described in chapter
5873          "Character Set and Escape Sequences (Section 7.1)").
5874    
5875     PRODUCT='<search-string>'     PRODUCT='<search-string>'
5876    
5877    
5878    
5879    Schoenebeck              Expires March 14, 2009               [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol       September 2008
5882    
5883    
5884        Restricts the search to instruments with product info that        Restricts the search to instruments with product info that
5885        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5886          apostrophes, supporting escape sequences as described in chapter
5887          "Character Set and Escape Sequences (Section 7.1)").
5888    
5889     ARTISTS='<search-string>'     ARTISTS='<search-string>'
5890    
5891        Restricts the search to instruments with artists info that        Restricts the search to instruments with artists info that
5892        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5893          apostrophes, supporting escape sequences as described in chapter
5894          "Character Set and Escape Sequences (Section 7.1)").
5895    
5896     KEYWORDS='<search-string>'     KEYWORDS='<search-string>'
5897    
5898        Restricts the search to instruments with keyword list that        Restricts the search to instruments with keyword list that
5899        satisfies the supplied search string.        satisfies the supplied search string (encapsulated into
5900          apostrophes, supporting escape sequences as described in chapter
5901          "Character Set and Escape Sequences (Section 7.1)").
5902    
5903     IS_DRUM=true | false     IS_DRUM=true | false
5904    
   
   
 Schoenebeck             Expires November 17, 2007             [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
5905        Either true or false.  Restricts the search to drum kits or        Either true or false.  Restricts the search to drum kits or
5906        chromatic instruments.        chromatic instruments.
5907    
# Line 5740  Internet-Draft        LinuxSampler Contr Line 5929  Internet-Draft        LinuxSampler Contr
5929        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+        C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5930        290'"        290'"
5931    
5932    
5933    
5934    
5935    Schoenebeck              Expires March 14, 2009               [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol       September 2008
5938    
5939    
5940        S: "'/Piano Collection/Bosendorfer 290'"        S: "'/Piano Collection/Bosendorfer 290'"
5941    
5942        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01        C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
# Line 5748  Internet-Draft        LinuxSampler Contr Line 5945  Internet-Draft        LinuxSampler Contr
5945        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5946        Steinway D'"        Steinway D'"
5947    
5948    6.8.21.  Getting job status information
5949    
5950       The front-end can ask for the current status of a particular database
5951       instruments job by sending the following command:
5952    
5953          GET DB_INSTRUMENTS_JOB INFO <job-id>
5954    
5955       Where <job-id> should be replaced by the numerical ID of the job the
5956       front-end is interested in.
5957    
5958       Possible Answers:
5959    
5960          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5961          answer line begins with the settings category name followed by a
5962          colon and then a space character <SP> and finally the info
5963          character string to that setting category.  At the moment the
5964          following categories are defined:
5965    
5966    
5967    
5968             FILES_TOTAL -
5969    
5970                The total number of files scheduled for scanning
5971    
5972             FILES_SCANNED -
5973    
5974                The current number of scanned files
5975    
5976             SCANNING -
5977    
5978                The absolute path name of the file which is currently being
5979                scanned
5980    
5981             STATUS -
5982    
5983                An integer value between 0 and 100 indicating the scanning
5984                progress percentage of the file which is currently being
5985                scanned
5986    
5987       The mentioned fields above don't have to be in particular order.
5988    
5989    
5990    
5991    Schoenebeck              Expires March 14, 2009               [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol       September 2008
5994    
5995    
5996       Example:
5997    
5998          C: "GET DB_INSTRUMENTS_JOB INFO 2"
5999    
6000          S: "FILES_TOTAL: 12"
6001    
6002             "FILES_SCANNED: 7"
6003    
6004             "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
6005    
6006             "STATUS: 42"
6007    
6008             "."
6009    
6010    6.8.22.  Formatting the instruments database
6011    
6012       The front-end can remove all instruments and directories and re-
6013       create the instruments database structure (e.g., in case of a
6014       database corruption) by sending the following command:
6015    
6016          FORMAT INSTRUMENTS_DB
6017    
6018       Possible Answers:
6019    
6020          "OK" -
6021    
6022             on success
6023    
6024          "ERR:<error-code>:<error-message>" -
6025    
6026             If the formatting of the instruments database failed.
6027    
6028    6.8.23.  Checking for lost instrument files
6029    
6030       The front-end can retrieve the list of all instrument files in the
6031       instruments database that don't exist in the filesystem by sending
6032       the following command:
6033    
6034          FIND LOST DB_INSTRUMENT_FILES
6035    
6036       Possible Answers:
6037    
6038          A comma separated list with the absolute path names (encapsulated
6039          into apostrophes) of all lost instrument files.
6040    
6041          "ERR:<error-code>:<error-message>" -
6042    
6043    
6044    
6045    
6046    
6047    Schoenebeck              Expires March 14, 2009               [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol       September 2008
6050    
6051    
6052             in case it failed, providing an appropriate error code and
6053             error message.
6054    
6055       Example:
6056    
6057          C: "FIND LOST DB_INSTRUMENT_FILES"
6058    
6059          S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
6060          Piano.gig'"
6061    
6062    6.8.24.  Replacing an instrument file
6063    
6064       The front-end can substitute all occurrences of an instrument file in
6065       the instruments database with a new one by sending the following
6066       command:
6067    
6068          SET DB_INSTRUMENT FILE_PATH <old_path> <new_path>
6069    
6070       Where <old_path> is the absolute path name of the instrument file to
6071       substitute with <new_path>.
6072    
6073       Possible Answers:
6074    
6075          "OK" -
6076    
6077             on success
6078    
6079          "ERR:<error-code>:<error-message>" -
6080    
6081             in case it failed, providing an appropriate error code and
6082             error message.
6083    
6084       Example:
6085    
6086          C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig'
6087          '/gigs/pianos/Bosendorfer 290.gig'"
6088    
6089          S: "OK"
6090    
6091    6.9.  Editing Instruments
6092    
6093       The sampler allows to edit instruments while playing with the sampler
6094       by spawning an external (3rd party) instrument editor application for
6095       a given instrument.  The 3rd party instrument editor applications
6096       have to place a respective plugin DLL file into the sampler's plugins
6097       directory.  The sampler will automatically try to load all plugin
6098       DLLs in that directory on startup and only on startup!
6099    
6100    
6101    
6102    
6103    Schoenebeck              Expires March 14, 2009               [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol       September 2008
6106    
6107    
6108       At the moment there is only one command for this feature set, but
6109       this will most probably change in future.
6110    
6111    6.9.1.  Opening an appropriate instrument editor application
6112    
6113       The front-end can request to open an appropriate instrument editor
6114       application by sending the following command:
6115    
6116          EDIT CHANNEL INSTRUMENT <sampler-channel>
6117    
6118       Where <sampler-channel> should be replaced by the number of the
6119       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
6120       "LIST CHANNELS" (Section 6.4.4) command.
6121    
6122       The sampler will try to ask all registered instrument editors (or to
6123       be more specific: their sampler plugins) whether they are capable to
6124       handle the instrument on the given sampler channel.  The sampler will
6125       simply use the first instrument editor application which replied with
6126       a positive answer and spawn that instrument editor application within
6127       the sampler's process and provide that application access to the
6128       instrument's data structures, so both applications can share and
6129       access the same instruments data at the same time, thus allowing to
6130       immediately hear changes with the sampler made by the instrument
6131       editor.
6132    
6133       Note: consequently instrument editors are always spawned locally on
6134       the same machine where the sampler is running on!
6135    
6136       Possible Answers:
6137    
6138          "OK" -
6139    
6140             when an appropriate instrument editor was launched
6141    
6142          "WRN:<warning-code>:<warning-message>" -
6143    
6144             when an appropriate instrument editor was launched, but there
6145             are noteworthy issues
6146    
6147          "ERR:<error-code>:<error-message>" -
6148    
6149             when an appropriate instrument editor could not be launched
6150    
6151       Examples:
6152    
6153          C: "EDIT CHANNEL INSTRUMENT 0"
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck              Expires March 14, 2009               [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol       September 2008
6162    
6163    
6164          S: "OK"
6165    
6166    6.10.  Managing Files
6167    
6168       You can query detailed informations about files located at the same
6169       system where the sampler instance is running on.  Using this command
6170       set allows to retrieve file informations even remotely from another
6171       machine.
6172    
6173    6.10.1.  Retrieving amount of instruments of a file
6174    
6175       The front-end can retrieve the amount of instruments within a given
6176       instrument file by sending the following command:
6177    
6178          GET FILE INSTRUMENTS <filename>
6179    
6180       Where <filename> is the name of the instrument file (encapsulated
6181       into apostrophes, supporting escape sequences as described in chapter
6182       "Character Set and Escape Sequences (Section 7.1)").
6183    
6184       The sampler will try to ask all sampler engines, whether they support
6185       the given file and ask the first engine with a positive answer for
6186       the amount of instruments.
6187    
6188       Possible Answers:
6189    
6190          On success, the sampler will answer by returning the amount of
6191          instruments.
6192    
6193          "ERR:<error-code>:<error-message>" -
6194    
6195             if the file could not be handled
6196    
6197       Examples:
6198    
6199          C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6200    
6201          S: "10"
6202    
6203    6.10.2.  Retrieving all instruments of a file
6204    
6205       The front-end can retrieve a list of all instruments within a given
6206       instrument file by sending the following command:
6207    
6208          LIST FILE INSTRUMENTS <filename>
6209    
6210       Where <filename> is the name of the instrument file (encapsulated
6211       into apostrophes, supporting escape sequences as described in chapter
6212    
6213    
6214    
6215    Schoenebeck              Expires March 14, 2009               [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol       September 2008
6218    
6219    
6220       "Character Set and Escape Sequences (Section 7.1)").
6221    
6222       The sampler will try to ask all sampler engines, whether they support
6223       the given file and ask the first engine with a positive answer for a
6224       list of IDs for the instruments in the given file.
6225    
6226       Possible Answers:
6227    
6228          On success, the sampler will answer by returning a comma separated
6229          list of instrument IDs.
6230    
6231          "ERR:<error-code>:<error-message>" -
6232    
6233             if the file could not be handled
6234    
6235       Examples:
6236    
6237          C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6238    
6239          S: "0,1,2,3,4,5,6,7,8,9"
6240    
6241    6.10.3.  Retrieving informations about one instrument in a file
6242    
6243       The front-end can retrieve detailed informations about a specific
6244       instrument within a given instrument file by sending the following
6245       command:
6246    
6247          GET FILE INSTRUMENT INFO <filename> <instr-id>
6248    
6249       Where <filename> is the name of the instrument file (encapsulated
6250       into apostrophes, supporting escape sequences as described in chapter
6251       "Character Set and Escape Sequences (Section 7.1)") and <instr-id> is
6252       the numeric instrument ID as returned by the "LIST FILE INSTRUMENTS"
6253       (Section 6.10.2) command.
6254    
6255       The sampler will try to ask all sampler engines, whether they support
6256       the given file and ask the first engine with a positive answer for
6257       informations about the specific instrument in the given file.
6258    
6259       Possible Answers:
6260    
6261          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6262          answer line begins with the settings category name followed by a
6263          colon and then a space character <SP> and finally the info
6264          character string to that setting category.  At the moment the
6265          following categories are defined:
6266    
6267    
6268    
6269    
6270    
6271    Schoenebeck              Expires March 14, 2009               [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol       September 2008
6274    
6275    
6276    
6277    
6278             NAME -
6279    
6280                name of the instrument as stored in the instrument file
6281    
6282             FORMAT_FAMILY -
6283    
6284                name of the sampler format of the given instrument
6285    
6286             FORMAT_VERSION -
6287    
6288                version of the sampler format the instrumen is stored as
6289    
6290             PRODUCT -
6291    
6292                official product name of the instrument as stored in the
6293                file
6294    
6295             ARTISTS -
6296    
6297                artists / sample library vendor of the instrument
6298    
6299             KEY_BINDINGS -
6300    
6301                comma separated list of integer values representing the
6302                instrument's key mapping in the range between 0 .. 127,
6303                reflecting the analog meaning of the MIDI specification.
6304    
6305             KEYSWITCH_BINDINGS -
6306    
6307                comma separated list of integer values representing the
6308                instrument's keyswitch mapping in the range between 0 ..
6309                127, reflecting the analog meaning of the MIDI
6310                specification.
6311    
6312       The mentioned fields above don't have to be in particular order.
6313    
6314       Example:
6315    
6316          C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
6317    
6318          S: "NAME: Lunatic Loops"
6319    
6320             "FORMAT_FAMILY: GIG"
6321    
6322             "FORMAT_VERSION: 3"
6323    
6324    
6325  Schoenebeck             Expires November 17, 2007             [Page 103]  
6326    
6327    Schoenebeck              Expires March 14, 2009               [Page 113]
6328    
6329  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
6330    
6331    
6332             "PRODUCT: The Backbone Bongo Beats"
6333    
6334             "ARTISTS: Jimmy the Fish"
6335    
6336             "."
6337    
6338    
6339    
6340    
6341    
6342    
6343    
6344    
6345    
6346    
6347    
6348    
6349    
6350    
6351    
6352    
6353    
6354    
6355    
6356    
6357    
6358    
6359    
6360    
6361    
6362    
6363    
6364    
6365    
6366    
6367    
6368    
6369    
6370    
6371    
6372    
6373    
6374    
6375    
6376    
6377    
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck              Expires March 14, 2009               [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol       September 2008
6386    
6387    
6388  7.  Command Syntax  7.  Command Syntax
# Line 5820  Internet-Draft        LinuxSampler Contr Line 6436  Internet-Draft        LinuxSampler Contr
6436    
6437    
6438    
6439  Schoenebeck             Expires November 17, 2007             [Page 104]  Schoenebeck              Expires March 14, 2009               [Page 115]
6440    
6441  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
6442    
6443    
6444        / LIST SP list_instruction        / LIST SP list_instruction
# Line 5847  Internet-Draft        LinuxSampler Contr Line 6463  Internet-Draft        LinuxSampler Contr
6463    
6464        / COPY SP copy_instruction        / COPY SP copy_instruction
6465    
6466          / EDIT SP edit_instruction
6467    
6468          / FORMAT SP format_instruction
6469    
6470          SEND SP send_instruction
6471    
6472        / RESET        / RESET
6473    
6474        / QUIT        / QUIT
# Line 5855  Internet-Draft        LinuxSampler Contr Line 6477  Internet-Draft        LinuxSampler Contr
6477    
6478        CHANNEL        CHANNEL
6479    
6480        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6481    
6482        / DB_INSTRUMENTS SP FLAT SP pathname SP pathname        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6483    
6484        / DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6485    
6486        / DB_INSTRUMENTS SP pathname SP pathname        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6487    
6488        / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6489          instrument_index
6490    
       / MIDI_INSTRUMENT_MAP  
6491    
       / MIDI_INSTRUMENT_MAP SP map_name  
6492    
    subscribe_event =  
6493    
       AUDIO_OUTPUT_DEVICE_COUNT  
6494    
6495    Schoenebeck              Expires March 14, 2009               [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol       September 2008
6498    
6499    
6500          / DB_INSTRUMENTS SP db_path SP filename
6501    
6502  Schoenebeck             Expires November 17, 2007             [Page 105]        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6503    
6504  Internet-Draft        LinuxSampler Control Protocol             May 2007        / MIDI_INSTRUMENT_MAP
6505    
6506          / MIDI_INSTRUMENT_MAP SP map_name
6507    
6508       subscribe_event =
6509    
6510          AUDIO_OUTPUT_DEVICE_COUNT
6511    
6512        / AUDIO_OUTPUT_DEVICE_INFO        / AUDIO_OUTPUT_DEVICE_INFO
6513    
# Line 5889  Internet-Draft        LinuxSampler Contr Line 6517  Internet-Draft        LinuxSampler Contr
6517    
6518        / CHANNEL_COUNT        / CHANNEL_COUNT
6519    
6520          / CHANNEL_MIDI
6521    
6522          / DEVICE_MIDI
6523    
6524        / VOICE_COUNT        / VOICE_COUNT
6525    
6526        / STREAM_COUNT        / STREAM_COUNT
# Line 5913  Internet-Draft        LinuxSampler Contr Line 6545  Internet-Draft        LinuxSampler Contr
6545    
6546        / DB_INSTRUMENT_DIRECTORY_INFO        / DB_INSTRUMENT_DIRECTORY_INFO
6547    
6548    
6549    
6550    
6551    Schoenebeck              Expires March 14, 2009               [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol       September 2008
6554    
6555    
6556        / DB_INSTRUMENT_COUNT        / DB_INSTRUMENT_COUNT
6557    
6558        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
6559    
6560          / DB_INSTRUMENTS_JOB_INFO
6561    
6562        / MISCELLANEOUS        / MISCELLANEOUS
6563    
6564          / TOTAL_STREAM_COUNT
6565    
6566        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6567    
6568        / GLOBAL_INFO        / GLOBAL_INFO
# Line 5929  Internet-Draft        LinuxSampler Contr Line 6573  Internet-Draft        LinuxSampler Contr
6573    
6574        / AUDIO_OUTPUT_DEVICE_INFO        / AUDIO_OUTPUT_DEVICE_INFO
6575    
   
   
   
 Schoenebeck             Expires November 17, 2007             [Page 106]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
6576        / MIDI_INPUT_DEVICE_COUNT        / MIDI_INPUT_DEVICE_COUNT
6577    
6578        / MIDI_INPUT_DEVICE_INFO        / MIDI_INPUT_DEVICE_INFO
6579    
6580        / CHANNEL_COUNT        / CHANNEL_COUNT
6581    
6582          / CHANNEL_MIDI
6583    
6584          / DEVICE_MIDI
6585    
6586        / VOICE_COUNT        / VOICE_COUNT
6587    
6588        / STREAM_COUNT        / STREAM_COUNT
# Line 5961  Internet-Draft        LinuxSampler Contr Line 6601  Internet-Draft        LinuxSampler Contr
6601    
6602        / MIDI_INSTRUMENT_COUNT        / MIDI_INSTRUMENT_COUNT
6603    
6604    
6605    
6606    
6607    Schoenebeck              Expires March 14, 2009               [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol       September 2008
6610    
6611    
6612        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
6613    
6614        / DB_INSTRUMENT_DIRECTORY_COUNT        / DB_INSTRUMENT_DIRECTORY_COUNT
# Line 5971  Internet-Draft        LinuxSampler Contr Line 6619  Internet-Draft        LinuxSampler Contr
6619    
6620        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
6621    
6622          / DB_INSTRUMENTS_JOB_INFO
6623    
6624        / MISCELLANEOUS        / MISCELLANEOUS
6625    
6626          / TOTAL_STREAM_COUNT
6627    
6628        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6629    
6630        / GLOBAL_INFO        / GLOBAL_INFO
# Line 5986  Internet-Draft        LinuxSampler Contr Line 6638  Internet-Draft        LinuxSampler Contr
6638        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
6639        instr_load_mode        instr_load_mode
6640    
   
   
 Schoenebeck             Expires November 17, 2007             [Page 107]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
6641        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6642        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
6643        entry_name        entry_name
# Line 6011  Internet-Draft        LinuxSampler Contr Line 6656  Internet-Draft        LinuxSampler Contr
6656    
6657        / MIDI_INSTRUMENT_MAP SP midi_map        / MIDI_INSTRUMENT_MAP SP midi_map
6658    
6659    
6660    
6661    
6662    
6663    Schoenebeck              Expires March 14, 2009               [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol       September 2008
6666    
6667    
6668        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6669    
6670        / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6671    
6672        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
6673    
6674        / DB_INSTRUMENT SP pathname        / DB_INSTRUMENT SP db_path
6675    
6676     get_instruction =     get_instruction =
6677    
# Line 6041  Internet-Draft        LinuxSampler Contr Line 6695  Internet-Draft        LinuxSampler Contr
6695        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6696        key_val_list        key_val_list
6697    
   
   
   
 Schoenebeck             Expires November 17, 2007             [Page 108]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
6698        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
6699    
6700        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 6066  Internet-Draft        LinuxSampler Contr Line 6712  Internet-Draft        LinuxSampler Contr
6712        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
6713        string        string
6714    
6715    
6716    
6717    
6718    
6719    Schoenebeck              Expires March 14, 2009               [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol       September 2008
6722    
6723    
6724        / CHANNELS        / CHANNELS
6725    
6726        / CHANNEL SP INFO SP sampler_channel        / CHANNEL SP INFO SP sampler_channel
# Line 6080  Internet-Draft        LinuxSampler Contr Line 6735  Internet-Draft        LinuxSampler Contr
6735    
6736        / SERVER SP INFO        / SERVER SP INFO
6737    
6738          / TOTAL_STREAM_COUNT
6739    
6740        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6741    
6742        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
# Line 6096  Internet-Draft        LinuxSampler Contr Line 6753  Internet-Draft        LinuxSampler Contr
6753    
6754        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6755    
6756          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6757    
6758          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6759    
6760          / DB_INSTRUMENT_DIRECTORIES SP db_path
6761    
6762          / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6763    
6764  Schoenebeck             Expires November 17, 2007             [Page 109]        / DB_INSTRUMENTS SP RECURSIVE SP db_path
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6765    
6766          / DB_INSTRUMENTS SP db_path
6767    
6768        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / DB_INSTRUMENT SP INFO SP db_path
6769    
6770        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENTS_JOB SP INFO SP number
6771    
       / DB_INSTRUMENT_DIRECTORIES SP pathname  
6772    
       / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname  
6773    
       / DB_INSTRUMENTS SP RECURSIVE SP pathname  
6774    
6775        / DB_INSTRUMENTS SP pathname  Schoenebeck              Expires March 14, 2009               [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol       September 2008
6778    
       / DB_INSTRUMENT SP INFO SP pathname  
6779    
6780        / VOLUME        / VOLUME
6781    
6782          / FILE SP INSTRUMENTS SP filename
6783    
6784          / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6785    
6786     set_instruction =     set_instruction =
6787    
6788        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
# Line 6132  Internet-Draft        LinuxSampler Contr Line 6794  Internet-Draft        LinuxSampler Contr
6794        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6795        param_val_list        param_val_list
6796    
6797          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6798    
6799        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6800        param_val_list        param_val_list
6801    
# Line 6150  Internet-Draft        LinuxSampler Contr Line 6814  Internet-Draft        LinuxSampler Contr
6814        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6815        volume_value        volume_value
6816    
6817        / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6818    
6819          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6820          stringval_escaped
6821    
6822          / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6823    
6824          / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6825    
6826          / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6827    
 Schoenebeck             Expires November 17, 2007             [Page 110]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6828    
6829    
       / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval  
6830    
6831        / DB_INSTRUMENT SP NAME SP pathname SP dirname  Schoenebeck              Expires March 14, 2009               [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol       September 2008
6834    
       / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval  
6835    
6836        / ECHO SP boolean        / ECHO SP boolean
6837    
# Line 6197  Internet-Draft        LinuxSampler Contr Line 6863  Internet-Draft        LinuxSampler Contr
6863    
6864     find_instruction =     find_instruction =
6865    
6866        DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list        DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6867    
6868        / DB_INSTRUMENTS SP pathname SP query_val_list        / DB_INSTRUMENTS SP db_path SP query_val_list
6869    
6870        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
6871        query_val_list        query_val_list
6872    
6873        / DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
   
    move_instruction =  
6874    
6875          / LOST SP DB_INSTRUMENT_FILES
6876    
6877       move_instruction =
6878    
6879          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6880    
6881          / DB_INSTRUMENT SP db_path SP db_path
6882    
6883  Schoenebeck             Expires November 17, 2007             [Page 111]     copy_instruction =
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6884    
6885    
       DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  
6886    
6887        / DB_INSTRUMENT SP pathname SP pathname  Schoenebeck              Expires March 14, 2009               [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol       September 2008
6890    
    copy_instruction =  
6891    
6892        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6893    
6894        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
6895    
6896     destroy_instruction =     destroy_instruction =
6897    
# Line 6264  Internet-Draft        LinuxSampler Contr Line 6930  Internet-Draft        LinuxSampler Contr
6930    
6931        / VOLUME SP sampler_channel SP volume_value        / VOLUME SP sampler_channel SP volume_value
6932    
6933          / MUTE SP sampler_channel SP boolean
6934    
6935          / SOLO SP sampler_channel SP boolean
6936    
6937          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6938    
6939    
 Schoenebeck             Expires November 17, 2007             [Page 112]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
6940    
6941    
       / MUTE SP sampler_channel SP boolean  
6942    
6943        / SOLO SP sampler_channel SP boolean  Schoenebeck              Expires March 14, 2009               [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol       September 2008
6946    
       / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map  
6947    
6948        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6949    
6950        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6951    
6952       edit_instruction =
6953    
6954          CHANNEL SP INSTRUMENT SP sampler_channel
6955    
6956       format_instruction =
6957    
6958          INSTRUMENTS_DB
6959    
6960     modal_arg =     modal_arg =
6961    
6962        /* epsilon (empty argument) */        /* epsilon (empty argument) */
# Line 6319  Internet-Draft        LinuxSampler Contr Line 6993  Internet-Draft        LinuxSampler Contr
6993    
6994        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
6995    
       / MIDI_INSTRUMENT_MAPS  
   
6996    
6997    
6998    
6999  Schoenebeck             Expires November 17, 2007             [Page 113]  Schoenebeck              Expires March 14, 2009               [Page 125]
7000    
7001  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7002    
7003    
7004          / MIDI_INSTRUMENT_MAPS
7005    
7006        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
7007    
7008        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
7009    
7010          / DB_INSTRUMENT_DIRECTORIES SP db_path
7011    
7012          / DB_INSTRUMENTS SP RECURSIVE SP db_path
7013    
7014          / DB_INSTRUMENTS SP db_path
7015    
7016        / DB_INSTRUMENT_DIRECTORIES SP pathname        / FILE SP INSTRUMENTS SP filename
7017    
7018        / DB_INSTRUMENTS SP RECURSIVE SP pathname     send_instruction =
7019    
7020        / DB_INSTRUMENTS SP pathname        CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP
7021          number
7022    
7023     load_instr_args =     load_instr_args =
7024    
# Line 6367  Internet-Draft        LinuxSampler Contr Line 7048  Internet-Draft        LinuxSampler Contr
7048    
7049     audio_output_type_name =     audio_output_type_name =
7050    
       string  
7051    
    midi_input_port_index =  
7052    
       number  
7053    
    midi_input_channel_index =  
7054    
7055        number  Schoenebeck              Expires March 14, 2009               [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol       September 2008
7058    
7059    
7060          string
7061    
7062       midi_input_port_index =
7063    
7064  Schoenebeck             Expires November 17, 2007             [Page 114]        number
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
7065    
7066       midi_input_channel_index =
7067    
7068          number
7069    
7070        / ALL        / ALL
7071    
# Line 6423  Internet-Draft        LinuxSampler Contr Line 7105  Internet-Draft        LinuxSampler Contr
7105    
7106     fx_send_id =     fx_send_id =
7107    
       number  
7108    
    engine_name =  
7109    
       string  
   
    pathname =  
   
       stringval  
7110    
7111    Schoenebeck              Expires March 14, 2009               [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol       September 2008
7114    
7115    
7116          number
7117    
7118  Schoenebeck             Expires November 17, 2007             [Page 115]     engine_name =
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
7119    
7120          string
7121    
7122     dirname =     filename =
7123    
7124        stringval        path
7125    
7126     filename =     db_path =
7127    
7128        stringval        path
7129    
7130     map_name =     map_name =
7131    
7132        stringval        stringval_escaped
7133    
7134     entry_name =     entry_name =
7135    
7136        stringval        stringval_escaped
7137    
7138     fx_send_name =     fx_send_name =
7139    
7140        stringval        stringval_escaped
7141    
7142     param_val_list =     param_val_list =
7143    
# Line 6483  Internet-Draft        LinuxSampler Contr Line 7161  Internet-Draft        LinuxSampler Contr
7161    
7162        / query_val_list SP string '=' query_val        / query_val_list SP string '=' query_val
7163    
7164    
7165    
7166    
7167    Schoenebeck              Expires March 14, 2009               [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol       September 2008
7170    
7171    
7172     query_val =     query_val =
7173    
7174        string        text_escaped
7175    
7176        / stringval        / stringval_escaped
7177    
7178       scan_mode =
7179    
7180          RECURSIVE
7181    
7182          / NON_RECURSIVE
7183    
7184          / FLAT
7185    
7186    7.1.  Character Set and Escape Sequences
7187    
7188       Older versions of this protocol up to and including v1.1 only
7189       supported the standard ASCII character set (ASCII code 0 - 127)
7190       [RFC20], all younger versions of this protocol however support the
7191       Extended ASCII character set (ASCII code 0 - 255).  The same group of
7192       younger protocols also support escape sequences, but only for
7193       certain, explicitly declared parts of the protocol.  The supported
7194       escape sequences are defined as follows:
7195    
7196       +------------------------+------------------------------------------+
7197       | ASCII Character        | Translated into (Name)                   |
7198       | Sequence               |                                          |
7199       +------------------------+------------------------------------------+
7200       | \n                     | new line                                 |
7201       |                        |                                          |
7202       | \r                     | carriage return                          |
7203       |                        |                                          |
7204       | \f                     | form feed                                |
7205       |                        |                                          |
7206       | \t                     | horizontal tab                           |
7207       |                        |                                          |
7208       | \v                     | vertical tab                             |
7209       |                        |                                          |
7210       | \'                     | apostrophe                               |
7211       |                        |                                          |
7212       | \"                     | quotation mark                           |
7213       |                        |                                          |
7214       | \\                     | backslash                                |
7215       |                        |                                          |
7216       | \OOO                   | three digit octal ASCII code of the      |
7217       |                        | character                                |
7218       |                        |                                          |
7219    
7220    
7221  Schoenebeck             Expires November 17, 2007             [Page 116]  
7222    
7223    Schoenebeck              Expires March 14, 2009               [Page 129]
7224    
7225  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7226    
7227    
7228       | \xHH                   | two digit hex ASCII code of the          |
7229       |                        | character                                |
7230       +------------------------+------------------------------------------+
7231    
7232       Notice: due to the transition of certain parts of the protocol which
7233       now support escape sequences, a slight backward incompatibility to
7234       protocols version v1.1 and younger has been introduced.  The only
7235       difference is that in parts of the protocol where escape characters
7236       are now supported, a backslash characters MUST be escaped as well
7237       (that is as double backslash), whereas in the old versions a single
7238       backslash was sufficient.
7239    
7240       The following LSCP commands support escape sequences as part of their
7241       filename / path based arguments and / or may contain a filename /
7242       path with escape sequences in their response:
7243    
7244          "LOAD INSTRUMENT" (Section 6.4.1)
7245    
7246          "GET CHANNEL INFO" (Section 6.4.10)
7247    
7248          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7249    
7250          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7251    
7252          "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
7253    
7254          "ADD DB_INSTRUMENTS" (Section 6.8.11)
7255    
7256          "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
7257    
7258          "REMOVE DB_INSTRUMENT" (Section 6.8.12)
7259    
7260          "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
7261    
7262          "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
7263    
7264          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
7265    
7266          "GET DB_INSTRUMENTS" (Section 6.8.13)
7267    
7268          "LIST DB_INSTRUMENTS" (Section 6.8.14)
7269    
7270          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
7271    
7272          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7273    
7274          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7275    
7276    
7277    
7278    
7279    Schoenebeck              Expires March 14, 2009               [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol       September 2008
7282    
7283    
7284          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7285    
7286          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7287    
7288          "FIND DB_INSTRUMENTS" (Section 6.8.20)
7289    
7290          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
7291    
7292          "MOVE DB_INSTRUMENT" (Section 6.8.17)
7293    
7294          "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
7295    
7296          "COPY DB_INSTRUMENT" (Section 6.8.18)
7297    
7298          "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
7299    
7300          "FIND LOST DB_INSTRUMENT_FILES" (Section 6.8.23)
7301    
7302          "SET DB_INSTRUMENT FILE_PATH" (Section 6.8.24)
7303    
7304          "GET FILE INSTRUMENTS" (Section 6.10.1)
7305    
7306          "LIST FILE INSTRUMENTS" (Section 6.10.2)
7307    
7308          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
7309    
7310       Note that the forward slash character ('/') has a special meaning in
7311       filename / path based arguments: it acts as separator of the nodes in
7312       the path, thus if a directory- or filename includes a forward slash
7313       (not intended as path node separator), you MUST escape that slash
7314       either with the respective hex escape sequence ("\x2f") or with the
7315       respective octal escape sequence ("\057").
7316    
7317       Note for Windows: file path arguments in LSCP are expected to use
7318       forward slashes as directory node separator similar to Unix based
7319       operating systems.  In contrast to Unix however a Windows typical
7320       drive character is expected to be prefixed to the path.  That is an
7321       original Windows file path like "D:\Sounds\My.gig" would become in
7322       LSCP: "D:/Sounds/My.gig".
7323    
7324       The following LSCP commands even support escape sequences as part of
7325       at least one of their text-based arguments (i.e. entity name,
7326       description) and / or may contain escape sequences in at least one of
7327       their text-based fields in their response:
7328    
7329          "GET SERVER INFO" (Section 6.6.5)
7330    
7331    
7332    
7333    
7334    
7335    Schoenebeck              Expires March 14, 2009               [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol       September 2008
7338    
7339    
7340          "GET ENGINE INFO" (Section 6.4.9)
7341    
7342          "GET CHANNEL INFO" (Section 6.4.10)
7343    
7344          "CREATE FX_SEND" (Section 6.4.25)
7345    
7346          "GET FX_SEND INFO" (Section 6.4.29)
7347    
7348          "SET FX_SEND NAME" (Section 6.4.30)
7349    
7350          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7351    
7352          "GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5)
7353    
7354          "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
7355    
7356          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
7357    
7358          "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
7359    
7360          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
7361    
7362          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
7363    
7364          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
7365    
7366          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
7367    
7368          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
7369    
7370          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7371    
7372          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
7373    
7374          "FIND DB_INSTRUMENTS" (Section 6.8.20)
7375    
7376       Please note that these lists are manually maintained.  If you find a
7377       command that also supports escape sequences we forgot to mention
7378       here, please report it!
7379    
7380    
7381    
7382    
7383    
7384    
7385    
7386    
7387    
7388    
7389    
7390    
7391    Schoenebeck              Expires March 14, 2009               [Page 132]
7392    
7393    Internet-Draft        LinuxSampler Control Protocol       September 2008
7394    
7395    
7396  8.  Events  8.  Events
# Line 6548  Internet-Draft        LinuxSampler Contr Line 7444  Internet-Draft        LinuxSampler Contr
7444    
7445    
7446    
7447  Schoenebeck             Expires November 17, 2007             [Page 117]  Schoenebeck              Expires March 14, 2009               [Page 133]
7448    
7449  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7450    
7451    
7452        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 6591  Internet-Draft        LinuxSampler Contr Line 7487  Internet-Draft        LinuxSampler Contr
7487     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
7488     channels.     channels.
7489    
7490  8.6.  Number of active voices changed  8.6.  MIDI data on a sampler channel arrived
7491    
7492     Client may want to be notified when the number of voices on the back-     Client may want to be notified when MIDI data arrive on sampler
7493     end changes by issuing the following command:     channels on back-end side, by issuing the following command:
7494    
7495        SUBSCRIBE VOICE_COUNT        SUBSCRIBE CHANNEL_MIDI
7496    
7497       Server will start sending one of the the following notification
7498       messages:
7499    
    Server will start sending the following notification messages:  
7500    
7501    
7502    
7503    Schoenebeck              Expires March 14, 2009               [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol       September 2008
7506    
7507    
7508          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"
7509    
7510  Schoenebeck             Expires November 17, 2007             [Page 118]        "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"
7511    
7512       where <channel-id> will be replaced by the ID of the sampler channel
7513       where the MIDI data arrived. <note> and <velocity> are integer values
7514       in the range between 0 .. 127, reflecting the analog meaning of the
7515       MIDI specification.
7516    
7517       CAUTION: no guarantee whatsoever will be made that MIDI events are
7518       actually all delivered by this mechanism!  With other words: events
7519       could be lost at any time!  This restriction was made to keep the RT-
7520       safeness of the backend's MIDI and audio thread unaffected by this
7521       feature.
7522    
7523    8.7.  MIDI data on a MIDI input device arrived
7524    
7525       Client may want to be notified when MIDI data arrive on MIDI input
7526       devices by issuing the following command:
7527    
7528          SUBSCRIBE DEVICE_MIDI
7529    
7530       Server will start sending one of the the following notification
7531       messages:
7532    
7533          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note>
7534          <velocity>"
7535    
7536          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note>
7537          <velocity>"
7538    
7539       where <device-id> <port-id> will be replaced by the IDs of the
7540       respective MIDI input device and the device's MIDI port where the
7541       MIDI data arrived. <note> and <velocity> are integer values in the
7542       range between 0 .. 127, reflecting the analog meaning of the MIDI
7543       specification.
7544    
7545       CAUTION: no guarantee whatsoever will be made that MIDI events are
7546       actually all delivered by this mechanism!  With other words: events
7547       could be lost at any time!  This restriction was made to keep the RT-
7548       safeness of the backend's MIDI and audio thread unaffected by this
7549       feature.
7550    
7551    8.8.  Number of active voices changed
7552    
7553       Client may want to be notified when the number of voices on the back-
7554       end changes by issuing the following command:
7555    
7556    
7557    
7558    
7559    Schoenebeck              Expires March 14, 2009               [Page 135]
7560    
7561  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7562    
7563    
7564          SUBSCRIBE VOICE_COUNT
7565    
7566       Server will start sending the following notification messages:
7567    
7568        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
7569    
# Line 6615  Internet-Draft        LinuxSampler Contr Line 7571  Internet-Draft        LinuxSampler Contr
7571     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
7572     voices on that channel.     voices on that channel.
7573    
7574  8.7.  Number of active disk streams changed  8.9.  Number of active disk streams changed
7575    
7576     Client may want to be notified when the number of streams on the     Client may want to be notified when the number of streams on the
7577     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 6631  Internet-Draft        LinuxSampler Contr Line 7587  Internet-Draft        LinuxSampler Contr
7587     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
7588     active disk streams on that channel.     active disk streams on that channel.
7589    
7590  8.8.  Disk stream buffer fill state changed  8.10.  Disk stream buffer fill state changed
7591    
7592     Client may want to be notified when the buffer fill state of a disk     Client may want to be notified when the buffer fill state of a disk
7593     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 6648  Internet-Draft        LinuxSampler Contr Line 7604  Internet-Draft        LinuxSampler Contr
7604     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
7605     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
7606    
7607  8.9.  Channel information changed  8.11.  Channel information changed
7608    
7609     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
7610     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
7611    
       SUBSCRIBE CHANNEL_INFO  
7612    
    Server will start sending the following notification messages:  
7613    
7614    
7615    Schoenebeck              Expires March 14, 2009               [Page 136]
7616    
7617    Internet-Draft        LinuxSampler Control Protocol       September 2008
7618    
7619    
7620  Schoenebeck             Expires November 17, 2007             [Page 119]        SUBSCRIBE CHANNEL_INFO
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
7621    
7622       Server will start sending the following notification messages:
7623    
7624        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
7625    
# Line 6674  Internet-Draft        LinuxSampler Contr Line 7630  Internet-Draft        LinuxSampler Contr
7630     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
7631     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
7632    
7633  8.10.  Number of effect sends changed  8.12.  Number of effect sends changed
7634    
7635     Client may want to be notified when the number of effect sends on a     Client may want to be notified when the number of effect sends on a
7636     particular sampler channel is changed by issuing the following     particular sampler channel is changed by issuing the following
# Line 6691  Internet-Draft        LinuxSampler Contr Line 7647  Internet-Draft        LinuxSampler Contr
7647     sends> will be replaced by the new number of effect sends on that     sends> will be replaced by the new number of effect sends on that
7648     channel.     channel.
7649    
7650  8.11.  Effect send information changed  8.13.  Effect send information changed
7651    
7652     Client may want to be notified when changes were made to effect sends     Client may want to be notified when changes were made to effect sends
7653     on a a particular sampler channel by issuing the following command:     on a a particular sampler channel by issuing the following command:
# Line 6707  Internet-Draft        LinuxSampler Contr Line 7663  Internet-Draft        LinuxSampler Contr
7663     send-id> will be replaced by the numerical ID of the changed effect     send-id> will be replaced by the numerical ID of the changed effect
7664     send.     send.
7665    
 8.12.  Total number of active voices changed  
   
    Client may want to be notified when the total number of voices on the  
    back-end changes by issuing the following command:  
7666    
7667    
7668    
7669    
7670    
7671  Schoenebeck             Expires November 17, 2007             [Page 120]  Schoenebeck              Expires March 14, 2009               [Page 137]
7672    
7673  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7674    
7675    
7676    8.14.  Total number of active voices changed
7677    
7678       Client may want to be notified when the total number of voices on the
7679       back-end changes by issuing the following command:
7680    
7681        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
7682    
7683     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 6730  Internet-Draft        LinuxSampler Contr Line 7687  Internet-Draft        LinuxSampler Contr
7687     where <voices> will be replaced by the new number of all currently     where <voices> will be replaced by the new number of all currently
7688     active voices.     active voices.
7689    
7690  8.13.  Number of MIDI instrument maps changed  8.15.  Total number of active disk streams changed
7691    
7692       Client may want to be notified when the total number of disk streams
7693       on the back-end changes by issuing the following command:
7694    
7695          SUBSCRIBE TOTAL_STREAM_COUNT
7696    
7697       Server will start sending the following notification messages:
7698    
7699          "NOTIFY:TOTAL_STREAM_COUNT:<streams>"
7700    
7701       where <streams> will be replaced by the new number of all currently
7702       active disk streams.
7703    
7704    8.16.  Number of MIDI instrument maps changed
7705    
7706     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
7707     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 6744  Internet-Draft        LinuxSampler Contr Line 7715  Internet-Draft        LinuxSampler Contr
7715     where <maps> will be replaced by the new number of MIDI instrument     where <maps> will be replaced by the new number of MIDI instrument
7716     maps.     maps.
7717    
7718  8.14.  MIDI instrument map information changed  8.17.  MIDI instrument map information changed
7719    
7720     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
7721     instrument maps on the back-end by issuing the following command:     instrument maps on the back-end by issuing the following command:
7722    
7723    
7724    
7725    
7726    
7727    Schoenebeck              Expires March 14, 2009               [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol       September 2008
7730    
7731    
7732        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
7733    
7734     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 6763  Internet-Draft        LinuxSampler Contr Line 7743  Internet-Draft        LinuxSampler Contr
7743     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
7744     message is sufficient here.     message is sufficient here.
7745    
7746  8.15.  Number of MIDI instruments changed  8.18.  Number of MIDI instruments changed
7747    
7748     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
7749     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
7750    
   
   
   
   
 Schoenebeck             Expires November 17, 2007             [Page 121]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
7751        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
7752    
7753     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 6787  Internet-Draft        LinuxSampler Contr Line 7758  Internet-Draft        LinuxSampler Contr
7758     which the nuber of instruments has changed and <instruments> will be     which the nuber of instruments has changed and <instruments> will be
7759     replaced by the new number of MIDI instruments in the specified map.     replaced by the new number of MIDI instruments in the specified map.
7760    
7761  8.16.  MIDI instrument information changed  8.19.  MIDI instrument information changed
7762    
7763     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
7764     instruments on the back-end by issuing the following command:     instruments on the back-end by issuing the following command:
# Line 6807  Internet-Draft        LinuxSampler Contr Line 7778  Internet-Draft        LinuxSampler Contr
7778     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
7779     empty notification message is sufficient here.     empty notification message is sufficient here.
7780    
7781  8.17.  Global settings changed  
7782    
7783    Schoenebeck              Expires March 14, 2009               [Page 139]
7784    
7785    Internet-Draft        LinuxSampler Control Protocol       September 2008
7786    
7787    
7788    8.20.  Global settings changed
7789    
7790     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
7791     the sampler were made by issuing the following command:     the sampler were made by issuing the following command:
# Line 6822  Internet-Draft        LinuxSampler Contr Line 7800  Internet-Draft        LinuxSampler Contr
7800        by the optional dotted floating point value, reflecting the new        by the optional dotted floating point value, reflecting the new
7801        global volume parameter.        global volume parameter.
7802    
7803    8.21.  Number of database instrument directories changed
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007             [Page 122]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
 8.18.  Number of database instrument directories changed  
7804    
7805     Client may want to be notified when the number of instrument     Client may want to be notified when the number of instrument
7806     directories in a particular directory in the instruments database is     directories in a particular directory in the instruments database is
# Line 6852  Internet-Draft        LinuxSampler Contr Line 7819  Internet-Draft        LinuxSampler Contr
7819     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
7820     sent for the subdirectories in that directory.     sent for the subdirectories in that directory.
7821    
7822  8.19.  Database instrument directory information changed  8.22.  Database instrument directory information changed
7823    
7824     Client may want to be notified when changes were made to directories     Client may want to be notified when changes were made to directories
7825     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 6866  Internet-Draft        LinuxSampler Contr Line 7833  Internet-Draft        LinuxSampler Contr
7833     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
7834     directory, for which information changes occurred.  The front-end     directory, for which information changes occurred.  The front-end
7835     will have to send the respective command to actually get the updated     will have to send the respective command to actually get the updated
7836    
7837    
7838    
7839    Schoenebeck              Expires March 14, 2009               [Page 140]
7840    
7841    Internet-Draft        LinuxSampler Control Protocol       September 2008
7842    
7843    
7844     directory info.  Because these messages will be triggered by LSCP     directory info.  Because these messages will be triggered by LSCP
7845     commands issued by other clients rather than real time events     commands issued by other clients rather than real time events
7846     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
# Line 6878  Internet-Draft        LinuxSampler Contr Line 7853  Internet-Draft        LinuxSampler Contr
7853     (encapsulated into apostrophes), which name is changes and <new-name>     (encapsulated into apostrophes), which name is changes and <new-name>
7854     is the new name of the directory, encapsulated into apostrophes.     is the new name of the directory, encapsulated into apostrophes.
7855    
7856    8.23.  Number of database instruments changed
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007             [Page 123]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
 8.20.  Number of database instruments changed  
7857    
7858     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
7859     particular directory in the instruments database is changed by     particular directory in the instruments database is changed by
# Line 6908  Internet-Draft        LinuxSampler Contr Line 7872  Internet-Draft        LinuxSampler Contr
7872     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
7873     sent for the instruments in that directory.     sent for the instruments in that directory.
7874    
7875  8.21.  Database instrument information changed  8.24.  Database instrument information changed
7876    
7877     Client may want to be notified when changes were made to instruments     Client may want to be notified when changes were made to instruments
7878     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 6925  Internet-Draft        LinuxSampler Contr Line 7889  Internet-Draft        LinuxSampler Contr
7889     info.  Because these messages will be triggered by LSCP commands     info.  Because these messages will be triggered by LSCP commands
7890     issued by other clients rather than real time events happening on the     issued by other clients rather than real time events happening on the
7891     server, it is believed that an empty notification message is     server, it is believed that an empty notification message is
7892    
7893    
7894    
7895    Schoenebeck              Expires March 14, 2009               [Page 141]
7896    
7897    Internet-Draft        LinuxSampler Control Protocol       September 2008
7898    
7899    
7900     sufficient here.     sufficient here.
7901    
7902        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"        "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
# Line 6934  Internet-Draft        LinuxSampler Contr Line 7906  Internet-Draft        LinuxSampler Contr
7906     <new-name> is the new name of the instrument, encapsulated into     <new-name> is the new name of the instrument, encapsulated into
7907     apostrophes.     apostrophes.
7908    
7909    8.25.  Database job status information changed
7910    
7911       Client may want to be notified when the status of particular database
7912       instruments job is changed by issuing the following command:
7913    
7914          SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
7915    
7916       Server will start sending the following notification messages:
7917    
7918          "NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"
7919    
7920       where <job-id> will be replaced by the numerical ID of the job, which
7921       status is changed.  The front-end will have to send the respective
7922       command to actually get the status info.  Because these messages will
7923       be triggered by LSCP commands issued by other clients rather than
7924       real time events happening on the server, it is believed that an
7925       empty notification message is sufficient here.
7926    
7927  Schoenebeck             Expires November 17, 2007             [Page 124]  8.26.  Miscellaneous and debugging events
   
 Internet-Draft        LinuxSampler Control Protocol             May 2007  
   
   
 8.22.  Miscellaneous and debugging events  
7928    
7929     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
7930     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 6969  Internet-Draft        LinuxSampler Contr Line 7948  Internet-Draft        LinuxSampler Contr
7948    
7949    
7950    
7951    Schoenebeck              Expires March 14, 2009               [Page 142]
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 Schoenebeck             Expires November 17, 2007             [Page 125]  
7952    
7953  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7954    
7955    
7956  9.  Security Considerations  9.  Security Considerations
# Line 7052  Internet-Draft        LinuxSampler Contr Line 8004  Internet-Draft        LinuxSampler Contr
8004    
8005    
8006    
8007  Schoenebeck             Expires November 17, 2007             [Page 126]  Schoenebeck              Expires March 14, 2009               [Page 143]
8008    
8009  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
8010    
8011    
8012  10.  Acknowledgments  10.  Acknowledgments
# Line 7108  Internet-Draft        LinuxSampler Contr Line 8060  Internet-Draft        LinuxSampler Contr
8060    
8061    
8062    
8063  Schoenebeck             Expires November 17, 2007             [Page 127]  Schoenebeck              Expires March 14, 2009               [Page 144]
8064    
8065  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
8066    
8067    
8068  11.  References  11.  References
8069    
8070       [RFC20]    UCLA, "ASCII format for Network Interchange", RFC 20,
8071                  1969.
8072    
8073     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
8074                Requirement Levels", RFC 2119, 1997.                Requirement Levels", RFC 2119, 1997.
8075    
# Line 7161  Internet-Draft        LinuxSampler Contr Line 8116  Internet-Draft        LinuxSampler Contr
8116    
8117    
8118    
8119    Schoenebeck              Expires March 14, 2009               [Page 145]
   
   
 Schoenebeck             Expires November 17, 2007             [Page 128]  
8120    
8121  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
8122    
8123    
8124  Author's Address  Author's Address
# Line 7220  Author's Address Line 8172  Author's Address
8172    
8173    
8174    
8175  Schoenebeck             Expires November 17, 2007             [Page 129]  Schoenebeck              Expires March 14, 2009               [Page 146]
8176    
8177  Internet-Draft        LinuxSampler Control Protocol             May 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
8178    
8179    
8180  Full Copyright Statement  Full Copyright Statement
8181    
8182     Copyright (C) The IETF Trust (2007).     Copyright (C) The IETF Trust (2008).
8183    
8184     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
8185     contained in BCP 78, and except as set forth therein, the authors     contained in BCP 78, and except as set forth therein, the authors
# Line 7276  Acknowledgment Line 8228  Acknowledgment
8228    
8229    
8230    
8231  Schoenebeck             Expires November 17, 2007             [Page 130]  Schoenebeck              Expires March 14, 2009               [Page 147]
8232    
Legend:
Removed from v.1189  
changed lines
  Added in v.1773
  ViewVC Help
Powered by ViewVC