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

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

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

revision 1430 by schoenebeck, Sun Oct 14 23:39:14 2007 UTC revision 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: April 17, 2008                                 October 15, 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 April 17, 2008.     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 April 17, 2008                 [Page 1]  Schoenebeck              Expires March 14, 2009                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                 [Page 2]  Schoenebeck              Expires March 14, 2009                 [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol         October 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  . . . . . . . . . . . .  46         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47
130         6.4.7.  Getting amount of available engines . . . . . . . . .  47         6.4.7.  Getting amount of available engines . . . . . . . . .  48
131         6.4.8.  Getting all available engines . . . . . . . . . . . .  48         6.4.8.  Getting all available engines . . . . . . . . . . . .  48
132         6.4.9.  Getting information about an engine . . . . . . . . .  48         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information . . . . . . . . .  49         6.4.10. Getting sampler channel information . . . . . . . . .  49
# Line 136  Internet-Draft        LinuxSampler Contr Line 136  Internet-Draft        LinuxSampler Contr
136         6.4.13. Current fill state of disk stream buffers . . . . . .  53         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device . . . . . . . . . . . . .  54         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55
139         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55         6.4.16. Setting audio output channel  . . . . . . . . . . . .  56
140         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58
143         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60
146         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  61
147         6.4.24. Assigning a MIDI instrument map to a sampler         6.4.24. Assigning a MIDI instrument map to a sampler
148                 channel . . . . . . . . . . . . . . . . . . . . . . .  61                 channel . . . . . . . . . . . . . . . . . . . . . . .  61
149         6.4.25. Adding an effect send to a sampler channel  . . . . .  62         6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150         6.4.26. Removing an effect send from a sampler channel  . . .  63         6.4.26. Removing an effect send from a sampler channel  . . .  64
151         6.4.27. Getting amount of effect sends on a sampler channel .  64         6.4.27. Getting amount of effect sends on a sampler channel .  64
152         6.4.28. Listing all effect sends on a sampler channel . . . .  64         6.4.28. Listing all effect sends on a sampler channel . . . .  65
153         6.4.29. Getting effect send information . . . . . . . . . . .  65         6.4.29. Getting effect send information . . . . . . . . . . .  65
154         6.4.30. Changing effect send's name . . . . . . . . . . . . .  66         6.4.30. Changing effect send's name . . . . . . . . . . . . .  67
155         6.4.31. Altering effect send's audio routing  . . . . . . . .  67         6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157         6.4.33. Altering effect send's send level . . . . . . . . . .  69         6.4.33. Altering effect send's send level . . . . . . . . . .  69
158         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70         6.4.34. 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  . . . . . . . . .  72  
164    
165    
166    
167  Schoenebeck              Expires April 17, 2008                 [Page 3]  Schoenebeck              Expires March 14, 2009                 [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol         October 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 . . . . . . . . . . . . . . . . . . . . .  73         6.5.4.  Close client connection . . . . . . . . . . . . . . .  74
174         6.6.1.  Current number of active voices . . . . . . . . . . .  73       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  . . . . . . . . . . . .  74         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 . . . . . . . . . .  75         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 . .  77       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  77
183         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  78         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  77
184         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78         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 . . . .  80         6.7.5.  Getting MIDI instrument map information . . . . . . .  80
188         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  83         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  . . . .  84         6.7.10. Remove an entry from the MIDI instrument map  . . . .  85
194         6.7.11. Get current settings of MIDI instrument map entry . .  85         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 . . . . . . . . . . . . . .  87       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  89
197         6.8.1.  Creating a new instrument directory . . . . . . . . .  87         6.8.1.  Creating a new instrument directory . . . . . . . . .  89
198         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  89
199         6.8.3.  Getting amount of instrument directories  . . . . . .  89         6.8.3.  Getting amount of instrument directories  . . . . . .  90
200         6.8.4.  Listing all directories in specific directory . . . .  89         6.8.4.  Listing all directories in specific directory . . . .  91
201         6.8.5.  Getting instrument directory information  . . . . . .  90         6.8.5.  Getting instrument directory information  . . . . . .  91
202         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  92
203         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  93
204         6.8.8.  Copying instrument directories  . . . . . . . . . . .  92         6.8.8.  Copying instrument directories  . . . . . . . . . . .  94
205         6.8.9.  Changing the description of directory . . . . . . . .  93         6.8.9.  Changing the description of directory . . . . . . . .  94
206         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  95
207         6.8.11. Adding instruments to the instruments database  . . .  95         6.8.11. Adding instruments to the instruments database  . . .  96
208         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  98
209         6.8.13. Getting amount of instruments . . . . . . . . . . . .  97         6.8.13. Getting amount of instruments . . . . . . . . . . . .  98
210         6.8.14. Listing all instruments in specific directory . . . .  97         6.8.14. Listing all instruments in specific directory . . . .  99
211         6.8.15. Getting instrument information  . . . . . . . . . . .  98         6.8.15. Getting instrument information  . . . . . . . . . . . 100
212         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 102
213         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 101         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 103
214         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 103
215         6.8.19. Changing the description of instrument  . . . . . . . 102         6.8.19. Changing the description of instrument  . . . . . . . 104
216         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 104
217         6.8.21. Getting job status information  . . . . . . . . . . . 105         6.8.21. Getting job status information  . . . . . . . . . . . 107
218         6.8.22. Formatting the instruments database . . . . . . . . . 106         6.8.22. Formatting the instruments database . . . . . . . . . 108
219       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107         6.8.23. Checking for lost instrument files  . . . . . . . . . 108
        6.9.1.  Opening an appropriate instrument editor  
                application . . . . . . . . . . . . . . . . . . . . . 107  
220    
221    
222    
223  Schoenebeck              Expires April 17, 2008                 [Page 4]  Schoenebeck              Expires March 14, 2009                 [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
   
   
    7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 109  
      7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 122  
    8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 126  
      8.1.  Number of audio output devices changed  . . . . . . . . . 126  
      8.2.  Audio output device's settings changed  . . . . . . . . . 126  
      8.3.  Number of MIDI input devices changed  . . . . . . . . . . 126  
      8.4.  MIDI input device's settings changed  . . . . . . . . . . 127  
      8.5.  Number of sampler channels changed  . . . . . . . . . . . 127  
      8.6.  Number of active voices changed . . . . . . . . . . . . . 127  
      8.7.  Number of active disk streams changed . . . . . . . . . . 128  
      8.8.  Disk stream buffer fill state changed . . . . . . . . . . 128  
      8.9.  Channel information changed . . . . . . . . . . . . . . . 128  
      8.10. Number of effect sends changed  . . . . . . . . . . . . . 129  
      8.11. Effect send information changed . . . . . . . . . . . . . 129  
      8.12. Total number of active voices changed . . . . . . . . . . 129  
      8.13. Number of MIDI instrument maps changed  . . . . . . . . . 130  
      8.14. MIDI instrument map information changed . . . . . . . . . 130  
      8.15. Number of MIDI instruments changed  . . . . . . . . . . . 130  
      8.16. MIDI instrument information changed . . . . . . . . . . . 131  
      8.17. Global settings changed . . . . . . . . . . . . . . . . . 131  
      8.18. Number of database instrument directories changed . . . . 132  
      8.19. Database instrument directory information changed . . . . 132  
      8.20. Number of database instruments changed  . . . . . . . . . 133  
      8.21. Database instrument information changed . . . . . . . . . 133  
      8.22. Database job status information changed . . . . . . . . . 134  
      8.23. Miscellaneous and debugging events  . . . . . . . . . . . 134  
    9.  Security Considerations . . . . . . . . . . . . . . . . . . . 135  
    10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 136  
    11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 137  
    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 138  
    Intellectual Property and Copyright Statements  . . . . . . . . . 139  
   
   
   
   
   
   
   
   
   
   
226    
227    
228           6.8.24. Replacing an instrument file  . . . . . . . . . . . . 109
229         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 109
230           6.9.1.  Opening an appropriate instrument editor
231                   application . . . . . . . . . . . . . . . . . . . . . 110
232         6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 111
233           6.10.1. Retrieving amount of instruments of a file  . . . . . 111
234           6.10.2. Retrieving all instruments of a file  . . . . . . . . 111
235           6.10.3. Retrieving informations about one instrument in a
236                   file  . . . . . . . . . . . . . . . . . . . . . . . . 112
237       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 115
238         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 129
239       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
240         8.1.  Number of audio output devices changed  . . . . . . . . . 133
241         8.2.  Audio output device's settings changed  . . . . . . . . . 133
242         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 133
243         8.4.  MIDI input device's settings changed  . . . . . . . . . . 134
244         8.5.  Number of sampler channels changed  . . . . . . . . . . . 134
245         8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 134
246         8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 135
247         8.8.  Number of active voices changed . . . . . . . . . . . . . 135
248         8.9.  Number of active disk streams changed . . . . . . . . . . 136
249         8.10. Disk stream buffer fill state changed . . . . . . . . . . 136
250         8.11. Channel information changed . . . . . . . . . . . . . . . 136
251         8.12. Number of effect sends changed  . . . . . . . . . . . . . 137
252         8.13. Effect send information changed . . . . . . . . . . . . . 137
253         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 276  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck              Expires April 17, 2008                 [Page 5]  Schoenebeck              Expires March 14, 2009                 [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck              Expires April 17, 2008                 [Page 6]  Schoenebeck              Expires March 14, 2009                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                 [Page 7]  Schoenebeck              Expires March 14, 2009                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                 [Page 8]  Schoenebeck              Expires March 14, 2009                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                 [Page 9]  Schoenebeck              Expires March 14, 2009                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 10]  Schoenebeck              Expires March 14, 2009                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 11]  Schoenebeck              Expires March 14, 2009                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 12]  Schoenebeck              Expires March 14, 2009                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 13]  Schoenebeck              Expires March 14, 2009                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 14]  Schoenebeck              Expires March 14, 2009                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 15]  Schoenebeck              Expires March 14, 2009                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 16]  Schoenebeck              Expires March 14, 2009                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 17]  Schoenebeck              Expires March 14, 2009                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 18]  Schoenebeck              Expires March 14, 2009                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 19]  Schoenebeck              Expires March 14, 2009                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 20]  Schoenebeck              Expires March 14, 2009                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 21]  Schoenebeck              Expires March 14, 2009                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 22]  Schoenebeck              Expires March 14, 2009                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 23]  Schoenebeck              Expires March 14, 2009                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 24]  Schoenebeck              Expires March 14, 2009                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 25]  Schoenebeck              Expires March 14, 2009                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 26]  Schoenebeck              Expires March 14, 2009                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 27]  Schoenebeck              Expires March 14, 2009                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 28]  Schoenebeck              Expires March 14, 2009                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 29]  Schoenebeck              Expires March 14, 2009                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 30]  Schoenebeck              Expires March 14, 2009                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 31]  Schoenebeck              Expires March 14, 2009                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 32]  Schoenebeck              Expires March 14, 2009                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 33]  Schoenebeck              Expires March 14, 2009                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 34]  Schoenebeck              Expires March 14, 2009                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 35]  Schoenebeck              Expires March 14, 2009                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 36]  Schoenebeck              Expires March 14, 2009                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 37]  Schoenebeck              Expires March 14, 2009                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 38]  Schoenebeck              Expires March 14, 2009                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 39]  Schoenebeck              Expires March 14, 2009                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 40]  Schoenebeck              Expires March 14, 2009                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol         October 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 April 17, 2008                [Page 41]  Schoenebeck              Expires March 14, 2009                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol         October 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 2348  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck              Expires April 17, 2008                [Page 42]  Schoenebeck              Expires March 14, 2009                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
2354    
2355    
2356        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck              Expires April 17, 2008                [Page 43]  Schoenebeck              Expires March 14, 2009                [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol         October 2007  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
# Line 2431  Internet-Draft        LinuxSampler Contr Line 2431  Internet-Draft        LinuxSampler Contr
2431           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2432           error message           error message
2433    
2434     Example:     Example (Unix):
2435    
2436          C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
2437    
2438          S: OK
2439    
2440       Example (Windows):
2441    
2442          C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
2443    
2444          S: OK
2445    
2446  6.4.2.  Loading a sampler engine  6.4.2.  Loading a sampler engine
2447    
# Line 2449  Internet-Draft        LinuxSampler Contr Line 2457  Internet-Draft        LinuxSampler Contr
2457     be assigned to.  This command should be issued after adding a new     be assigned to.  This command should be issued after adding a new
2458     sampler channel and before any other control commands on the new     sampler channel and before any other control commands on the new
2459     sampler channel.  It can also be used to change the engine type of a     sampler channel.  It can also be used to change the engine type of a
    sampler channel.  This command has (currently) no way to define or  
    force if a new engine instance should be created and assigned to the  
    given sampler channel or if an already existing instance of that  
    engine type, shared with other sampler channels, should be used.  
   
    Possible Answers:  
2460    
2461    
2462    
2463    Schoenebeck              Expires March 14, 2009                [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol       September 2008
2466    
2467    
2468  Schoenebeck              Expires April 17, 2008                [Page 44]     sampler channel.  This command has (currently) no way to define or
2469       force if a new engine instance should be created and assigned to the
2470  Internet-Draft        LinuxSampler Control Protocol         October 2007     given sampler channel or if an already existing instance of that
2471       engine type, shared with other sampler channels, should be used.
2472    
2473       Possible Answers:
2474    
2475        "OK" -        "OK" -
2476    
# Line 2503  Internet-Draft        LinuxSampler Contr Line 2510  Internet-Draft        LinuxSampler Contr
2510    
2511        S: "12"        S: "12"
2512    
2513    
2514    
2515    
2516    
2517    
2518    
2519    Schoenebeck              Expires 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 2513  Internet-Draft        LinuxSampler Contr Line 2531  Internet-Draft        LinuxSampler Contr
2531    
2532     Possible Answers:     Possible Answers:
2533    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2534        LinuxSampler will answer by returning a comma separated list with        LinuxSampler will answer by returning a comma separated list with
2535        all sampler channels numerical IDs.        all sampler channels numerical IDs.
2536    
# Line 2558  Internet-Draft        LinuxSampler Contr Line 2568  Internet-Draft        LinuxSampler Contr
2568    
2569        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck              Expires 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 2571  Internet-Draft        LinuxSampler Contr Line 2590  Internet-Draft        LinuxSampler Contr
2590    
2591    
2592    
   
 Schoenebeck              Expires April 17, 2008                [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
   
   
2593  6.4.6.  Removing a sampler channel  6.4.6.  Removing a sampler channel
2594    
2595     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
# Line 2611  Internet-Draft        LinuxSampler Contr Line 2622  Internet-Draft        LinuxSampler Contr
2622    
2623    
2624    
2625    
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck              Expires 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 2625  Internet-Draft        LinuxSampler Contr Line 2647  Internet-Draft        LinuxSampler Contr
2647    
2648     Example:     Example:
2649    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2650        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2651    
2652        S: "4"        S: "4"
# Line 2667  Internet-Draft        LinuxSampler Contr Line 2681  Internet-Draft        LinuxSampler Contr
2681     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2682     AVAILABLE_ENGINES" (Section 6.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2683    
2684    
2685    
2686    
2687    Schoenebeck              Expires 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 2682  Internet-Draft        LinuxSampler Contr Line 2704  Internet-Draft        LinuxSampler Contr
2704              arbitrary description text about the engine (note that the              arbitrary description text about the engine (note that the
2705              character string may contain escape sequences (Section 7.1))              character string may contain escape sequences (Section 7.1))
2706    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2707           VERSION -           VERSION -
2708    
2709              arbitrary character string regarding the engine's version              arbitrary character string regarding the engine's version
# Line 2722  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
2737        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
2738        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
2739        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2740    
2741    
2742    
2743    Schoenebeck              Expires 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 2760  Internet-Draft        LinuxSampler Contr
2760              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2761              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2762              signal, "NONE" if there's no device connected to this              signal, "NONE" if there's no device connected to this
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 49]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2763              sampler channel              sampler channel
2764    
2765           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
# Line 2778  Internet-Draft        LinuxSampler Contr Line 2793  Internet-Draft        LinuxSampler Contr
2793              LSCP 1.2 this character string may contain escape sequences              LSCP 1.2 this character string may contain escape sequences
2794              (Section 7.1))              (Section 7.1))
2795    
2796    
2797    
2798    
2799    Schoenebeck              Expires March 14, 2009                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol       September 2008
2802    
2803    
2804           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2805    
2806              integer values 0 to 100 indicating loading progress              integer values 0 to 100 indicating loading progress
# Line 2792  Internet-Draft        LinuxSampler Contr Line 2815  Internet-Draft        LinuxSampler Contr
2815              commands, "NONE" if there's no device connected to this              commands, "NONE" if there's no device connected to this
2816              sampler channel              sampler channel
2817    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2818           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2819    
2820              port number of the MIDI input device              port number of the MIDI input device
# Line 2836  Internet-Draft        LinuxSampler Contr Line 2850  Internet-Draft        LinuxSampler Contr
2850              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2851              values.              values.
2852    
2853    
2854    
2855    Schoenebeck              Expires 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 2848  Internet-Draft        LinuxSampler Contr Line 2869  Internet-Draft        LinuxSampler Contr
2869    
2870           "AUDIO_OUTPUT_DEVICE: 0"           "AUDIO_OUTPUT_DEVICE: 0"
2871    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2872           "AUDIO_OUTPUT_CHANNELS: 2"           "AUDIO_OUTPUT_CHANNELS: 2"
2873    
2874           "AUDIO_OUTPUT_ROUTING: 0,1"           "AUDIO_OUTPUT_ROUTING: 0,1"
# Line 2893  Internet-Draft        LinuxSampler Contr Line 2905  Internet-Draft        LinuxSampler Contr
2905        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2906    
2907     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
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 2925  Internet-Draft        LinuxSampler Contr
2925    
2926    
2927    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
   
   
2928  6.4.12.  Current number of active disk streams  6.4.12.  Current number of active disk streams
2929    
2930     The front-end can ask for the current number of active disk streams     The front-end can ask for the current number of active disk streams
# Line 2951  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
2962     sampler channel number the front-end is interested in as returned by     sampler channel number the front-end is interested in as returned by
2963     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2964    
2965    
2966    
2967    Schoenebeck              Expires 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 2961  Internet-Draft        LinuxSampler Contr Line 2979  Internet-Draft        LinuxSampler Contr
2979        "NA" for *not available* in case the engine which is deployed        "NA" for *not available* in case the engine which is deployed
2980        doesn't support disk streaming.  Each entry in the answer list        doesn't support disk streaming.  Each entry in the answer list
2981        will begin with the stream's ID in brackets followed by the        will begin with the stream's ID in brackets followed by the
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2982        numerical representation of the fill size (either in bytes or        numerical representation of the fill size (either in bytes or
2983        percentage).  Note: due to efficiency reasons the fill states in        percentage).  Note: due to efficiency reasons the fill states in
2984        the response are not in particular order, thus the front-end has        the response are not in particular order, thus the front-end has
# Line 3005  Internet-Draft        LinuxSampler Contr Line 3015  Internet-Draft        LinuxSampler Contr
3015    
3016     Possible Answers:     Possible Answers:
3017    
       "OK" -  
3018    
          on success  
3019    
       "WRN:<warning-code>:<warning-message>" -  
3020    
          if audio output device was set, but there are noteworthy  
          issue(s) related, providing an appropriate warning code and  
          warning message  
3021    
3022    
3023    Schoenebeck              Expires March 14, 2009                [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol       September 2008
3026    
3027    
3028          "OK" -
3029    
3030             on success
3031    
3032  Schoenebeck              Expires April 17, 2008                [Page 54]        "WRN:<warning-code>:<warning-message>" -
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
3033    
3034             if audio output device was set, but there are noteworthy
3035             issue(s) related, providing an appropriate warning code and
3036             warning message
3037    
3038        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3039    
# Line 3064  Internet-Draft        LinuxSampler Contr Line 3074  Internet-Draft        LinuxSampler Contr
3074           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3075           error message           error message
3076    
    Examples:  
   
3077    
3078    
3079  6.4.16.  Setting audio output channel  Schoenebeck              Expires March 14, 2009                [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol       September 2008
3082    
    The front-end can alter the audio output channel on a specific  
    sampler channel by sending the following command:  
3083    
3084       Examples:
3085    
3086    
3087    
3088  Schoenebeck              Expires April 17, 2008                [Page 55]  6.4.16.  Setting audio output channel
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
3089    
3090       The front-end can alter the audio output channel on a specific
3091       sampler channel by sending the following command:
3092    
3093        SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>        SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>
3094        <audio-in>        <audio-in>
# Line 3120  Internet-Draft        LinuxSampler Contr Line 3129  Internet-Draft        LinuxSampler Contr
3129        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3130    
3131     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
    the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)  
    command and <midi-device-id> is the numerical ID of the MIDI input  
    device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)  
    or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.  
   
    Possible Answers:  
   
3132    
3133    
3134    
3135    Schoenebeck              Expires March 14, 2009                [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol       September 2008
3138    
3139    
3140  Schoenebeck              Expires April 17, 2008                [Page 56]     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3141       command and <midi-device-id> is the numerical ID of the MIDI input
3142  Internet-Draft        LinuxSampler Control Protocol         October 2007     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3143       or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3144    
3145       Possible Answers:
3146    
3147        "OK" -        "OK" -
3148    
# Line 3178  Internet-Draft        LinuxSampler Contr Line 3185  Internet-Draft        LinuxSampler Contr
3185    
3186           if MIDI input type was set, but there are noteworthy issue(s)           if MIDI input type was set, but there are noteworthy issue(s)
3187           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
          message  
3188    
       "ERR:<error-code>:<error-message>" -  
3189    
          in case it failed, providing an appropriate error code and  
          error message  
3190    
3191    Schoenebeck              Expires March 14, 2009                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol       September 2008
3194    
3195    
3196             message
3197    
3198  Schoenebeck              Expires April 17, 2008                [Page 57]        "ERR:<error-code>:<error-message>" -
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
3199    
3200             in case it failed, providing an appropriate error code and
3201             error message
3202    
3203     Examples:     Examples:
3204    
# Line 3233  Internet-Draft        LinuxSampler Contr Line 3240  Internet-Draft        LinuxSampler Contr
3240     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3241     listen to by sending the following command:     listen to by sending the following command:
3242    
       SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>  
3243    
    Where <midi-input-chan> is the number of the new MIDI input channel  
    where <sampler-channel> should listen to or "ALL" to listen on all 16  
    MIDI channels.  
3244    
    Possible Answers:  
3245    
3246    
3247    Schoenebeck              Expires March 14, 2009                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol       September 2008
3250    
3251    
3252  Schoenebeck              Expires April 17, 2008                [Page 58]        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
3253    
3254       Where <midi-input-chan> is the number of the new MIDI input channel
3255       where <sampler-channel> should listen to or "ALL" to listen on all 16
3256       MIDI channels.
3257    
3258       Possible Answers:
3259    
3260        "OK" -        "OK" -
3261    
# Line 3288  Internet-Draft        LinuxSampler Contr Line 3296  Internet-Draft        LinuxSampler Contr
3296    
3297        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3298    
3299    
3300    
3301    
3302    
3303    Schoenebeck              Expires 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 3297  Internet-Draft        LinuxSampler Contr Line 3314  Internet-Draft        LinuxSampler Contr
3314           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3315           error message           error message
3316    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3317     Examples:     Examples:
3318    
3319    
# Line 3342  Internet-Draft        LinuxSampler Contr Line 3351  Internet-Draft        LinuxSampler Contr
3351    
3352    
3353    
3354    
3355    
3356    
3357    
3358    
3359    Schoenebeck              Expires 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 3354  Internet-Draft        LinuxSampler Contr Line 3373  Internet-Draft        LinuxSampler Contr
3373     (Section 6.4.4) command and <solo> should be replaced either by "1"     (Section 6.4.4) command and <solo> should be replaced either by "1"
3374     to solo the channel or "0" to unsolo the channel.     to solo the channel or "0" to unsolo the channel.
3375    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3376     Possible Answers:     Possible Answers:
3377    
3378        "OK" -        "OK" -
# Line 3396  Internet-Draft        LinuxSampler Contr Line 3408  Internet-Draft        LinuxSampler Contr
3408    
3409        "NONE" -        "NONE" -
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck              Expires 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 3409  Internet-Draft        LinuxSampler Contr Line 3430  Internet-Draft        LinuxSampler Contr
3430    
3431           You can assign a specific MIDI instrument map by replacing           You can assign a specific MIDI instrument map by replacing
3432           <map> with the respective numeric ID of the MIDI instrument map           <map> with the respective numeric ID of the MIDI instrument map
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3433           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3434           command.  Once that map will be deleted, the sampler channel           command.  Once that map will be deleted, the sampler channel
3435           would fall back to "NONE".           would fall back to "NONE".
# Line 3452  Internet-Draft        LinuxSampler Contr Line 3465  Internet-Draft        LinuxSampler Contr
3465     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3466     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3467     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3468    
3469    
3470    
3471    Schoenebeck              Expires 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     effect send entity.  The name does not have to be unique, but MUST be
3477     encapsulated into apostrophes and supports escape sequences as     encapsulated into apostrophes and supports escape sequences as
3478     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
# Line 3466  Internet-Draft        LinuxSampler Contr Line 3487  Internet-Draft        LinuxSampler Contr
3487     can alter the destination channels however with "SET FX_SEND     can alter the destination channels however with "SET FX_SEND
3488     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3489    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3490     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3491     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
3492     runtime performance, because for implementing channel effect sends,     runtime performance, because for implementing channel effect sends,
# Line 3506  Internet-Draft        LinuxSampler Contr Line 3520  Internet-Draft        LinuxSampler Contr
3520    
3521        S: "OK[1]"        S: "OK[1]"
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck              Expires 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 3522  Internet-Draft        LinuxSampler Contr Line 3545  Internet-Draft        LinuxSampler Contr
3545    
3546     Possible Answers:     Possible Answers:
3547    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3548        "OK" -        "OK" -
3549    
3550           on success           on success
# Line 3562  Internet-Draft        LinuxSampler Contr Line 3578  Internet-Draft        LinuxSampler Contr
3578    
3579     Example:     Example:
3580    
3581    
3582    
3583    Schoenebeck              Expires 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 3600  Internet-Draft        LinuxSampler Contr
3600     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3601     (Section 6.4.4) command.     (Section 6.4.4) command.
3602    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 64]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3603     Possible Answers:     Possible Answers:
3604    
3605        The sampler will answer by returning a comma separated list with        The sampler will answer by returning a comma separated list with
# Line 3618  Internet-Draft        LinuxSampler Contr Line 3633  Internet-Draft        LinuxSampler Contr
3633        The sampler will answer by sending a <CRLF> separated list.  Each        The sampler will answer by sending a <CRLF> separated list.  Each
3634        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
3635        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
3636    
3637    
3638    
3639    Schoenebeck              Expires 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 3633  Internet-Draft        LinuxSampler Contr Line 3656  Internet-Draft        LinuxSampler Contr
3656              a value between 0 and 127 reflecting the MIDI controller              a value between 0 and 127 reflecting the MIDI controller
3657              which is able to modify the effect send's send level              which is able to modify the effect send's send level
3658    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3659           LEVEL -           LEVEL -
3660    
3661              optionally dotted number reflecting the effect send's              optionally dotted number reflecting the effect send's
# Line 3673  Internet-Draft        LinuxSampler Contr Line 3688  Internet-Draft        LinuxSampler Contr
3688    
3689           "."           "."
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck              Expires 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 3690  Internet-Draft        LinuxSampler Contr Line 3714  Internet-Draft        LinuxSampler Contr
3714     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
3715     (Section 7.1)").     (Section 7.1)").
3716    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3717     Possible Answers:     Possible Answers:
3718    
3719        "OK" -        "OK" -
# Line 3728  Internet-Draft        LinuxSampler Contr Line 3745  Internet-Draft        LinuxSampler Contr
3745     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3746     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3747     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3748    
3749    
3750    
3751    Schoenebeck              Expires 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 3771  Internet-Draft        LinuxSampler Contr
3771    
3772     Possible Answers:     Possible Answers:
3773    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3774        "OK" -        "OK" -
3775    
3776           on success           on success
# Line 3783  Internet-Draft        LinuxSampler Contr Line 3801  Internet-Draft        LinuxSampler Contr
3801        ctrl>        ctrl>
3802    
3803     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3804    
3805    
3806    
3807    Schoenebeck              Expires 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 3802  Internet-Draft        LinuxSampler Contr Line 3828  Internet-Draft        LinuxSampler Contr
3828           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3829           message           message
3830    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3831        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3832    
3833           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3838  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857    
3858     Possible Answers:     Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck              Expires 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 3855  Internet-Draft        LinuxSampler Contr Line 3882  Internet-Draft        LinuxSampler Contr
3882    
3883     Example:     Example:
3884    
3885          C: "SET FX_SEND LEVEL 0 0 0.15"
3886    
3887          S: "OK"
3888    
3889    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  Schoenebeck              Expires April 17, 2008                [Page 69]  
3918    
3919    Schoenebeck              Expires March 14, 2009                [Page 70]
3920    
3921  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
3922    
3923    
3924        C: "SET FX_SEND LEVEL 0 0 0.15"     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"        S: "OK"
3940    
3941  6.4.34.  Resetting a sampler channel  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 3902  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 3912  Internet-Draft        LinuxSampler Contr Line 3989  Internet-Draft        LinuxSampler Contr
3989     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3990     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3991    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3992        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3993    
3994     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
# Line 3957  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 4045  Internet-Draft        LinuxSampler Contr
4045           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4046           message           message
4047    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4048        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4049    
4050           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 4014  Internet-Draft        LinuxSampler Contr Line 4082  Internet-Draft        LinuxSampler Contr
4082    
4083    
4084    
 6.5.4.  Close client connection  
4085    
    The client can close its network connection to LinuxSampler by  
    sending the following command:  
4086    
4087        QUIT  Schoenebeck              Expires March 14, 2009                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol       September 2008
4090    
    This is probably more interesting for manual telnet connections to  
    LinuxSampler than really useful for a front-end implementation.  
4091    
4092    
4093    
4094    6.5.4.  Close client connection
4095    
4096       The client can close its network connection to LinuxSampler by
4097       sending the following command:
4098    
4099  Schoenebeck              Expires April 17, 2008                [Page 72]        QUIT
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
4100    
4101       This is probably more interesting for manual telnet connections to
4102       LinuxSampler than really useful for a front-end implementation.
4103    
4104  6.6.  Global commands  6.6.  Global commands
4105    
# Line 4061  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 reset the whole sampler by sending the following     The front-end can ask for the current number of active disk streams
4135     command:     on the sampler by sending the following command:
4136    
4137        RESET        GET TOTAL_STREAM_COUNT
4138    
4139     Possible Answers:     Possible Answers:
4140    
       "OK" -  
4141    
          always  
4142    
4143     Examples:  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
4154       command:
4155    
4156          RESET
4157    
4158       Possible Answers:
4159    
4160          "OK" -
4161    
4162             always
4163    
4164       Examples:
4165    
 Schoenebeck              Expires April 17, 2008                [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
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 4116  Internet-Draft        LinuxSampler Contr Line 4192  Internet-Draft        LinuxSampler Contr
4192    
4193              version of the sampler              version of the sampler
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck              Expires March 14, 2009                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol       September 2008
4202    
4203    
4204           PROTOCOL_VERSION -           PROTOCOL_VERSION -
4205    
4206              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
# Line 4129  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 4138  Internet-Draft        LinuxSampler Contr Line 4223  Internet-Draft        LinuxSampler Contr
4223    
4224     Possible Answers:     Possible Answers:
4225    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4226        The sampler will always answer by returning the optional dotted        The sampler will always answer by returning the optional dotted
4227        floating point coefficient, reflecting the current global volume        floating point coefficient, reflecting the current global volume
4228        attenuation.        attenuation.
# Line 4153  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 4171  Internet-Draft        LinuxSampler Contr Line 4249  Internet-Draft        LinuxSampler Contr
4249    
4250           on success           on success
4251    
4252    
4253    
4254    
4255    Schoenebeck              Expires March 14, 2009                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol       September 2008
4258    
4259    
4260        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4261    
4262           if the global volume was set, but there are noteworthy issue(s)           if the global volume was set, but there are noteworthy issue(s)
# Line 4194  Internet-Draft        LinuxSampler Contr Line 4280  Internet-Draft        LinuxSampler Contr
4280     maps which define which instrument to load on which MIDI program     maps which define which instrument to load on which MIDI program
4281     change message.     change message.
4282    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4283     By default, that is when the sampler is launched, there is no map,     By default, that is when the sampler is launched, there is no map,
4284     thus the sampler will simply ignore all program change messages.  The     thus the sampler will simply ignore all program change messages.  The
4285     front-end has to explicitly create at least one map, add entries to     front-end has to explicitly create at least one map, add entries to
# Line 4224  Internet-Draft        LinuxSampler Contr Line 4303  Internet-Draft        LinuxSampler Contr
4303     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
4304     following command:     following command:
4305    
4306    
4307    
4308    
4309    
4310    
4311    Schoenebeck              Expires March 14, 2009                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol       September 2008
4314    
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
# Line 4248  Internet-Draft        LinuxSampler Contr Line 4337  Internet-Draft        LinuxSampler Contr
4337    
4338        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4339    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4340        S: "OK[0]"        S: "OK[0]"
4341    
4342        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
# Line 4280  Internet-Draft        LinuxSampler Contr Line 4360  Internet-Draft        LinuxSampler Contr
4360     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4361     following command:     following command:
4362    
4363    
4364    
4365    
4366    
4367    Schoenebeck              Expires March 14, 2009                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol       September 2008
4370    
4371    
4372        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4373    
4374     Possible Answers:     Possible Answers:
# Line 4302  Internet-Draft        LinuxSampler Contr Line 4391  Internet-Draft        LinuxSampler Contr
4391    
4392        S: "OK"        S: "OK"
4393    
   
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4394  6.7.3.  Get amount of existing MIDI instrument maps  6.7.3.  Get amount of existing MIDI instrument maps
4395    
4396     The front-end can retrieve the current amount of MIDI instrument maps     The front-end can retrieve the current amount of MIDI instrument maps
# Line 4337  Internet-Draft        LinuxSampler Contr Line 4415  Internet-Draft        LinuxSampler Contr
4415     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4416     following command:     following command:
4417    
4418    
4419    
4420    
4421    
4422    
4423    Schoenebeck              Expires March 14, 2009                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol       September 2008
4426    
4427    
4428        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4429    
4430     Possible Answers:     Possible Answers:
# Line 4361  Internet-Draft        LinuxSampler Contr Line 4449  Internet-Draft        LinuxSampler Contr
4449     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4450     (Section 6.7.4) command.     (Section 6.7.4) command.
4451    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4452     Possible Answers:     Possible Answers:
4453    
4454        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 4394  Internet-Draft        LinuxSampler Contr Line 4474  Internet-Draft        LinuxSampler Contr
4474    
4475     Example:     Example:
4476    
4477    
4478    
4479    Schoenebeck              Expires March 14, 2009                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol       September 2008
4482    
4483    
4484        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4485    
4486        S: "NAME: Standard Map"        S: "NAME: Standard Map"
# Line 4417  Internet-Draft        LinuxSampler Contr Line 4504  Internet-Draft        LinuxSampler Contr
4504    
4505     Possible Answers:     Possible Answers:
4506    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4507        "OK" -        "OK" -
4508    
4509           on success           on success
# Line 4450  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,
4532    
4533    
4534    
4535    Schoenebeck              Expires March 14, 2009                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol       September 2008
4538    
4539    
4540     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4541     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4542     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
# Line 4474  Internet-Draft        LinuxSampler Contr Line 4561  Internet-Draft        LinuxSampler Contr
4561           be freed from memory when not needed by any sampler channel           be freed from memory when not needed by any sampler channel
4562           anymore.           anymore.
4563    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4564        "ON_DEMAND_HOLD" -        "ON_DEMAND_HOLD" -
4565    
4566           The instrument will be loaded when needed, that is when           The instrument will be loaded when needed, that is when
# Line 4505  Internet-Draft        LinuxSampler Contr Line 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
4588    
4589    
4590    
4591    Schoenebeck              Expires March 14, 2009                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol       September 2008
4594    
4595    
4596           instrument does not exist in the InstrumentManager's list yet,           instrument does not exist in the InstrumentManager's list yet,
4597           otherwise if an entry already exists, it will simply stick with           otherwise if an entry already exists, it will simply stick with
4598           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
# Line 4529  Internet-Draft        LinuxSampler Contr Line 4617  Internet-Draft        LinuxSampler Contr
4617     "Character Set and Escape Sequences (Section 7.1)") for the mapping     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4618     entry, useful for frontends for displaying an appropriate name for     entry, useful for frontends for displaying an appropriate name for
4619     mapped instruments (using "GET MIDI_INSTRUMENT INFO"     mapped instruments (using "GET MIDI_INSTRUMENT INFO"
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4620     (Section 6.7.11)).     (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
# Line 4560  Internet-Draft        LinuxSampler Contr Line 4640  Internet-Draft        LinuxSampler Contr
4640    
4641           usually           usually
4642    
4643    
4644    
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>" -        "ERR:<error-code>:<error-message>" -
4653    
4654           when the given map or engine does not exist or a value is out           when the given map or engine does not exist or a value is out
# Line 4585  Internet-Draft        LinuxSampler Contr Line 4674  Internet-Draft        LinuxSampler Contr
4674        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4675        'Silent Piano'"        'Silent Piano'"
4676    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4677        S: "OK"        S: "OK"
4678    
4679        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
# Line 4614  Internet-Draft        LinuxSampler Contr Line 4695  Internet-Draft        LinuxSampler Contr
4695    
4696     Possible Answers:     Possible Answers:
4697    
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck              Expires March 14, 2009                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol       September 2008
4706    
4707    
4708        The sampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
4709        in the MIDI instrument map(s).        in the MIDI instrument map(s).
4710    
# Line 4639  Internet-Draft        LinuxSampler Contr Line 4730  Internet-Draft        LinuxSampler Contr
4730     The front-end can query a list of all currently existing entries of     The front-end can query a list of all currently existing entries of
4731     all MIDI instrument maps by sending the following command:     all MIDI instrument maps by sending the following command:
4732    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4733        LIST MIDI_INSTRUMENTS ALL        LIST MIDI_INSTRUMENTS ALL
4734    
4735     Possible Answers:     Possible Answers:
# Line 4672  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 4695  Internet-Draft        LinuxSampler Contr Line 4784  Internet-Draft        LinuxSampler Contr
4784    
4785        S: "OK"        S: "OK"
4786    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4787  6.7.11.  Get current settings of MIDI instrument map entry  6.7.11.  Get current settings of MIDI instrument map entry
4788    
4789     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
# Line 4730  Internet-Draft        LinuxSampler Contr Line 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
4812    
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           mapped instrument.  It can be set and changed with the "MAP
4821           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4822           be unique. (note that this character string may contain escape           be unique. (note that this character string may contain escape
# Line 4753  Internet-Draft        LinuxSampler Contr Line 4840  Internet-Draft        LinuxSampler Contr
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 (note that this character string may contain           cannot be changed (note that this character string may contain
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 85]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4843           escape sequences (Section 7.1)).           escape sequences (Section 7.1)).
4844    
4845        "LOAD_MODE" -        "LOAD_MODE" -
# Line 4786  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    
4868    
4869    
4870    
4871    Schoenebeck              Expires March 14, 2009                [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol       September 2008
4874    
4875    
4876           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
4877    
4878           "INSTRUMENT_NAME: Joe's Drumkit"           "INSTRUMENT_NAME: Joe's Drumkit"
# Line 4808  Internet-Draft        LinuxSampler Contr Line 4895  Internet-Draft        LinuxSampler Contr
4895     The front-end can clear all MIDI instrument maps, that is delete all     The front-end can clear all MIDI instrument maps, that is delete all
4896     entries of all maps by sending the following command:     entries of all maps by sending the following command:
4897    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4898        CLEAR MIDI_INSTRUMENTS ALL        CLEAR MIDI_INSTRUMENTS ALL
4899    
4900     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
# Line 4839  Internet-Draft        LinuxSampler Contr Line 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
# Line 4866  Internet-Draft        LinuxSampler Contr Line 4956  Internet-Draft        LinuxSampler Contr
4956    
4957     Possible Answers:     Possible Answers:
4958    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4959        "OK" -        "OK" -
4960    
4961           on success           on success
# Line 4894  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 4917  Internet-Draft        LinuxSampler Contr Line 5008  Internet-Draft        LinuxSampler Contr
5008    
5009        S: "OK"        S: "OK"
5010    
   
   
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 4952  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 4977  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 April 17, 2008                [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5069     Example:     Example:
5070    
5071        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
# Line 5008  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 5033  Internet-Draft        LinuxSampler Contr Line 5122  Internet-Draft        LinuxSampler Contr
5122    
5123     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5124    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5125     Example:     Example:
5126    
5127        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
# Line 5064  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 5087  Internet-Draft        LinuxSampler Contr Line 5176  Internet-Draft        LinuxSampler Contr
5176     The front-end can move a specific instrument directory by sending the     The front-end can move a specific instrument directory by sending the
5177     following command:     following command:
5178    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5179        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5180    
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
# Line 5122  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 5145  Internet-Draft        LinuxSampler Contr Line 5232  Internet-Draft        LinuxSampler Contr
5232           exists in the destination directory.  Error is also thrown when           exists in the destination directory.  Error is also thrown when
5233           trying to copy a directory to a subdirectory of itself.           trying to copy a directory to a subdirectory of itself.
5234    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5235     Example:     Example:
5236    
5237        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
# Line 5178  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 5201  Internet-Draft        LinuxSampler Contr Line 5288  Internet-Draft        LinuxSampler Contr
5288     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5289     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5290     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5291     form of "key1=val1 key2=val2 ...".  The following criterias are     form of "key1=val1 key2=val2 ...".  The following criterias are
5292     allowed:     allowed:
5293    
# Line 5234  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 5256  Internet-Draft        LinuxSampler Contr Line 5343  Internet-Draft        LinuxSampler Contr
5343    
5344        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5345    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5346           if the given directory does not exist.           if the given directory does not exist.
5347    
5348     Example:     Example:
# Line 5291  Internet-Draft        LinuxSampler Contr Line 5369  Internet-Draft        LinuxSampler Contr
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 5311  Internet-Draft        LinuxSampler Contr Line 5397  Internet-Draft        LinuxSampler Contr
5397           Only the instruments in the specified directory will be added,           Only the instruments in the specified directory will be added,
5398           the instruments in the subdirectories will not be processed.           the instruments in the subdirectories will not be processed.
5399    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 95]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5400        "FLAT" -        "FLAT" -
5401    
5402           All instruments will be processed, including those in the           All instruments will be processed, including those in the
# Line 5348  Internet-Draft        LinuxSampler Contr Line 5424  Internet-Draft        LinuxSampler Contr
5424    
5425        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5426    
5427    
5428    
5429    
5430    
5431    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    
5438     Examples:     Examples:
# Line 5369  Internet-Draft        LinuxSampler Contr Line 5454  Internet-Draft        LinuxSampler Contr
5454    
5455     Possible Answers:     Possible Answers:
5456    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 96]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5457        "OK" -        "OK" -
5458    
5459           if the instrument is removed successfully           if the instrument is removed successfully
# Line 5405  Internet-Draft        LinuxSampler Contr Line 5482  Internet-Draft        LinuxSampler Contr
5482    
5483     Possible Answers:     Possible Answers:
5484    
5485    
5486    
5487    Schoenebeck              Expires March 14, 2009                [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol       September 2008
5490    
5491    
5492        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5493    
5494        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5425  Internet-Draft        LinuxSampler Contr Line 5509  Internet-Draft        LinuxSampler Contr
5509        LIST DB_INSTRUMENTS [RECURSIVE] <dir>        LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5510    
5511     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5512     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
5513     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5514     specified directory, will be returned.     specified directory, will be returned.
# Line 5457  Internet-Draft        LinuxSampler Contr Line 5533  Internet-Draft        LinuxSampler Contr
5533        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5534        Steinway D','/Piano Collection/Lite/Free Piano'"        Steinway D','/Piano Collection/Lite/Free Piano'"
5535    
5536    
5537    
5538    
5539    
5540    
5541    
5542    
5543    Schoenebeck              Expires March 14, 2009                [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol       September 2008
5546    
5547    
5548  6.8.15.  Getting instrument information  6.8.15.  Getting instrument information
5549    
5550     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
# Line 5482  Internet-Draft        LinuxSampler Contr Line 5570  Internet-Draft        LinuxSampler Contr
5570              File name of the instrument.  Note that the character string              File name of the instrument.  Note that the character string
5571              may contain escape sequences (Section 7.1).              may contain escape sequences (Section 7.1).
5572    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 98]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5573           INSTRUMENT_NR -           INSTRUMENT_NR -
5574    
5575              Index of the instrument within the file.              Index of the instrument within the file.
# Line 5511  Internet-Draft        LinuxSampler Contr Line 5592  Internet-Draft        LinuxSampler Contr
5592              instruments database, represented in "YYYY-MM-DD HH:MM:SS"              instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5593              format              format
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck              Expires March 14, 2009               [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol       September 2008
5602    
5603    
5604           MODIFIED -           MODIFIED -
5605    
5606              The date and time of the last modification of the              The date and time of the last modification of the
# Line 5537  Internet-Draft        LinuxSampler Contr Line 5627  Internet-Draft        LinuxSampler Contr
5627              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5628              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5629    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 99]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
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.
# Line 5566  Internet-Draft        LinuxSampler Contr Line 5648  Internet-Draft        LinuxSampler Contr
5648    
5649           "FORMAT_VERSION: 2"           "FORMAT_VERSION: 2"
5650    
5651    
5652    
5653    
5654    
5655    Schoenebeck              Expires March 14, 2009               [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol       September 2008
5658    
5659    
5660           "SIZE: 2050871870"           "SIZE: 2050871870"
5661    
5662           "CREATED: 2007-02-05 10:23:12"           "CREATED: 2007-02-05 10:23:12"
# Line 5594  Internet-Draft        LinuxSampler Contr Line 5685  Internet-Draft        LinuxSampler Contr
5685     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
5686     is the new name for that instrument.     is the new name for that instrument.
5687    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5688     Possible Answers:     Possible Answers:
5689    
5690        "OK" -        "OK" -
# Line 5619  Internet-Draft        LinuxSampler Contr Line 5703  Internet-Draft        LinuxSampler Contr
5703    
5704        S: "OK"        S: "OK"
5705    
5706    
5707    
5708    
5709    
5710    
5711    Schoenebeck              Expires March 14, 2009               [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol       September 2008
5714    
5715    
5716  6.8.17.  Moving an instrument  6.8.17.  Moving an instrument
5717    
5718     The front-end can move a specific instrument to another directory by     The front-end can move a specific instrument to another directory by
# Line 5648  Internet-Draft        LinuxSampler Contr Line 5742  Internet-Draft        LinuxSampler Contr
5742    
5743        S: "OK"        S: "OK"
5744    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 101]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5745  6.8.18.  Copying instruments  6.8.18.  Copying instruments
5746    
5747     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 5675  Internet-Draft        LinuxSampler Contr Line 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 5704  Internet-Draft        LinuxSampler Contr Line 5798  Internet-Draft        LinuxSampler Contr
5798    
5799           on success           on success
5800    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5801        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5802    
5803           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5732  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 5762  Internet-Draft        LinuxSampler Contr Line 5855  Internet-Draft        LinuxSampler Contr
5855        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
5856        instruments created after <date-after>.        instruments created after <date-after>.
5857    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 103]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5858     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
5859    
5860        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 5788  Internet-Draft        LinuxSampler Contr Line 5874  Internet-Draft        LinuxSampler Contr
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 (encapsulated into        satisfies the supplied search string (encapsulated into
5886        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 5818  Internet-Draft        LinuxSampler Contr Line 5911  Internet-Draft        LinuxSampler Contr
5911        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
5912        families.        families.
5913    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 104]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5914     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5915     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
5916    
# Line 5843  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 5873  Internet-Draft        LinuxSampler Contr Line 5967  Internet-Draft        LinuxSampler Contr
5967    
5968           FILES_TOTAL -           FILES_TOTAL -
5969    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 105]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5970              The total number of files scheduled for scanning              The total number of files scheduled for scanning
5971    
5972           FILES_SCANNED -           FILES_SCANNED -
# Line 5900  Internet-Draft        LinuxSampler Contr Line 5986  Internet-Draft        LinuxSampler Contr
5986    
5987     The mentioned fields above don't have to be in particular order.     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:     Example:
5997    
5998        C: "GET DB_INSTRUMENTS_JOB INFO 2"        C: "GET DB_INSTRUMENTS_JOB INFO 2"
# Line 5928  Internet-Draft        LinuxSampler Contr Line 6021  Internet-Draft        LinuxSampler Contr
6021    
6022           on success           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  Schoenebeck              Expires April 17, 2008               [Page 106]     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         October 2007  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>" -        "ERR:<error-code>:<error-message>" -
6080    
6081           If the formatting of the instruments database failed.           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  6.9.  Editing Instruments
6092    
# Line 5950  Internet-Draft        LinuxSampler Contr Line 6097  Internet-Draft        LinuxSampler Contr
6097     directory.  The sampler will automatically try to load all plugin     directory.  The sampler will automatically try to load all plugin
6098     DLLs in that directory on startup and only on startup!     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     At the moment there is only one command for this feature set, but
6109     this will most probably change in future.     this will most probably change in future.
6110    
# Line 5984  Internet-Draft        LinuxSampler Contr Line 6139  Internet-Draft        LinuxSampler Contr
6139    
6140           when an appropriate instrument editor was launched           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  Schoenebeck              Expires April 17, 2008               [Page 107]     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         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
6162    
6163    
6164        "WRN:<warning-code>:<warning-message>" -        S: "OK"
6165    
6166           when an appropriate instrument editor was launched, but there  6.10.  Managing Files
6167           are noteworthy issues  
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>" -        "ERR:<error-code>:<error-message>" -
6194    
6195           when an appropriate instrument editor could not be launched           if the file could not be handled
6196    
6197     Examples:     Examples:
6198    
6199        C: "EDIT CHANNEL INSTRUMENT 0"        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    
6326    
6327    Schoenebeck              Expires March 14, 2009               [Page 113]
6328    
6329    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    
       S: "OK"  
6341    
6342    
6343    
# Line 6044  Internet-Draft        LinuxSampler Contr Line 6375  Internet-Draft        LinuxSampler Contr
6375    
6376    
6377    
6378  Schoenebeck              Expires April 17, 2008               [Page 108]  
6379    
6380    
6381    
6382    
6383    Schoenebeck              Expires March 14, 2009               [Page 114]
6384    
6385  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
6386    
6387    
6388  7.  Command Syntax  7.  Command Syntax
# Line 6100  Internet-Draft        LinuxSampler Contr Line 6436  Internet-Draft        LinuxSampler Contr
6436    
6437    
6438    
6439  Schoenebeck              Expires April 17, 2008               [Page 109]  Schoenebeck              Expires March 14, 2009               [Page 115]
6440    
6441  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
6442    
6443    
6444        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6131  Internet-Draft        LinuxSampler Contr Line 6467  Internet-Draft        LinuxSampler Contr
6467    
6468        / FORMAT SP format_instruction        / FORMAT SP format_instruction
6469    
6470          SEND SP send_instruction
6471    
6472        / RESET        / RESET
6473    
6474        / QUIT        / QUIT
# Line 6150  Internet-Draft        LinuxSampler Contr Line 6488  Internet-Draft        LinuxSampler Contr
6488        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP        / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6489        instrument_index        instrument_index
6490    
       / DB_INSTRUMENTS SP db_path SP filename  
   
6491    
6492    
6493    
6494    
6495  Schoenebeck              Expires April 17, 2008               [Page 110]  Schoenebeck              Expires March 14, 2009               [Page 116]
6496    
6497  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
6498    
6499    
6500          / DB_INSTRUMENTS SP db_path SP filename
6501    
6502        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6503    
6504        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
# Line 6179  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 6203  Internet-Draft        LinuxSampler Contr Line 6545  Internet-Draft        LinuxSampler Contr
6545    
6546        / DB_INSTRUMENT_DIRECTORY_INFO        / DB_INSTRUMENT_DIRECTORY_INFO
6547    
       / DB_INSTRUMENT_COUNT  
6548    
       / DB_INSTRUMENT_INFO  
6549    
       / DB_INSTRUMENTS_JOB_INFO  
6550    
6551    Schoenebeck              Expires March 14, 2009               [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol       September 2008
6554    
6555    
6556          / DB_INSTRUMENT_COUNT
6557    
6558  Schoenebeck              Expires April 17, 2008               [Page 111]        / DB_INSTRUMENT_INFO
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
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 6235  Internet-Draft        LinuxSampler Contr Line 6579  Internet-Draft        LinuxSampler Contr
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 6253  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 6265  Internet-Draft        LinuxSampler Contr Line 6621  Internet-Draft        LinuxSampler Contr
6621    
6622        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
6623    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 112]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6624        / MISCELLANEOUS        / MISCELLANEOUS
6625    
6626          / TOTAL_STREAM_COUNT
6627    
6628        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6629    
6630        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6306  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 db_path        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
# Line 6320  Internet-Draft        LinuxSampler Contr Line 6679  Internet-Draft        LinuxSampler Contr
6679    
6680        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
6681    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 113]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6682        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
6683    
6684        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
# Line 6362  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 6376  Internet-Draft        LinuxSampler Contr Line 6735  Internet-Draft        LinuxSampler Contr
6735    
6736        / SERVER SP INFO        / SERVER SP INFO
6737    
6738          / TOTAL_STREAM_COUNT
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 114]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
6739    
6740        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6741    
# Line 6417  Internet-Draft        LinuxSampler Contr Line 6769  Internet-Draft        LinuxSampler Contr
6769    
6770        / DB_INSTRUMENTS_JOB SP INFO SP number        / DB_INSTRUMENTS_JOB SP INFO SP number
6771    
6772    
6773    
6774    
6775    Schoenebeck              Expires March 14, 2009               [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol       September 2008
6778    
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 6432  Internet-Draft        LinuxSampler Contr Line 6796  Internet-Draft        LinuxSampler Contr
6796    
6797        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6798    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 115]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
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 6468  Internet-Draft        LinuxSampler Contr Line 6823  Internet-Draft        LinuxSampler Contr
6823    
6824        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6825    
6826          / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6827    
6828    
6829    
6830    
6831    Schoenebeck              Expires March 14, 2009               [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol       September 2008
6834    
6835    
6836        / ECHO SP boolean        / ECHO SP boolean
6837    
6838        / VOLUME SP volume_value        / VOLUME SP volume_value
# Line 6488  Internet-Draft        LinuxSampler Contr Line 6853  Internet-Draft        LinuxSampler Contr
6853    
6854     reset_instruction =     reset_instruction =
6855    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 116]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6856        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
6857    
6858     clear_instruction =     clear_instruction =
# Line 6516  Internet-Draft        LinuxSampler Contr Line 6872  Internet-Draft        LinuxSampler Contr
6872    
6873        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6874    
6875          / LOST SP DB_INSTRUMENT_FILES
6876    
6877     move_instruction =     move_instruction =
6878    
6879        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
# Line 6524  Internet-Draft        LinuxSampler Contr Line 6882  Internet-Draft        LinuxSampler Contr
6882    
6883     copy_instruction =     copy_instruction =
6884    
6885    
6886    
6887    Schoenebeck              Expires March 14, 2009               [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol       September 2008
6890    
6891    
6892        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6893    
6894        / DB_INSTRUMENT SP db_path SP db_path        / DB_INSTRUMENT SP db_path SP db_path
# Line 6544  Internet-Draft        LinuxSampler Contr Line 6909  Internet-Draft        LinuxSampler Contr
6909    
6910     set_chan_instruction =     set_chan_instruction =
6911    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 117]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6912        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6913    
6914        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
# Line 6580  Internet-Draft        LinuxSampler Contr Line 6936  Internet-Draft        LinuxSampler Contr
6936    
6937        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck              Expires March 14, 2009               [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol       September 2008
6946    
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
# Line 6600  Internet-Draft        LinuxSampler Contr Line 6965  Internet-Draft        LinuxSampler Contr
6965    
6966     key_val_list =     key_val_list =
6967    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 118]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6968        string '=' param_val_list        string '=' param_val_list
6969    
6970        / key_val_list SP string '=' param_val_list        / key_val_list SP string '=' param_val_list
# Line 6637  Internet-Draft        LinuxSampler Contr Line 6993  Internet-Draft        LinuxSampler Contr
6993    
6994        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
6995    
6996    
6997    
6998    
6999    Schoenebeck              Expires March 14, 2009               [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol       September 2008
7002    
7003    
7004        / MIDI_INSTRUMENT_MAPS        / MIDI_INSTRUMENT_MAPS
7005    
7006        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
# Line 6649  Internet-Draft        LinuxSampler Contr Line 7013  Internet-Draft        LinuxSampler Contr
7013    
7014        / DB_INSTRUMENTS SP db_path        / DB_INSTRUMENTS SP db_path
7015    
7016          / FILE SP INSTRUMENTS SP filename
7017    
7018       send_instruction =
7019    
7020          CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP
7021          number
7022    
7023     load_instr_args =     load_instr_args =
7024    
7025        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 6657  Internet-Draft        LinuxSampler Contr Line 7028  Internet-Draft        LinuxSampler Contr
7028    
7029     load_engine_args =     load_engine_args =
7030    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 119]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
7031        engine_name SP sampler_channel        engine_name SP sampler_channel
7032    
7033     instr_load_mode =     instr_load_mode =
# Line 6685  Internet-Draft        LinuxSampler Contr Line 7048  Internet-Draft        LinuxSampler Contr
7048    
7049     audio_output_type_name =     audio_output_type_name =
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck              Expires March 14, 2009               [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol       September 2008
7058    
7059    
7060        string        string
7061    
7062     midi_input_port_index =     midi_input_port_index =
# Line 6713  Internet-Draft        LinuxSampler Contr Line 7085  Internet-Draft        LinuxSampler Contr
7085    
7086        number        number
7087    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 120]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
7088     midi_ctrl =     midi_ctrl =
7089    
7090        number        number
# Line 6741  Internet-Draft        LinuxSampler Contr Line 7105  Internet-Draft        LinuxSampler Contr
7105    
7106     fx_send_id =     fx_send_id =
7107    
7108    
7109    
7110    
7111    Schoenebeck              Expires March 14, 2009               [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol       September 2008
7114    
7115    
7116        number        number
7117    
7118     engine_name =     engine_name =
# Line 6769  Internet-Draft        LinuxSampler Contr Line 7141  Internet-Draft        LinuxSampler Contr
7141    
7142     param_val_list =     param_val_list =
7143    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 121]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
7144        param_val        param_val
7145    
7146        / param_val_list','param_val        / param_val_list','param_val
# Line 6797  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        text_escaped        text_escaped
# Line 6821  Internet-Draft        LinuxSampler Contr Line 7193  Internet-Draft        LinuxSampler Contr
7193     certain, explicitly declared parts of the protocol.  The supported     certain, explicitly declared parts of the protocol.  The supported
7194     escape sequences are defined as follows:     escape sequences are defined as follows:
7195    
   
   
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 122]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
7196     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
7197     | ASCII Character        | Translated into (Name)                   |     | ASCII Character        | Translated into (Name)                   |
7198     | Sequence               |                                          |     | Sequence               |                                          |
# Line 6856  Internet-Draft        LinuxSampler Contr Line 7216  Internet-Draft        LinuxSampler Contr
7216     | \OOO                   | three digit octal ASCII code of the      |     | \OOO                   | three digit octal ASCII code of the      |
7217     |                        | character                                |     |                        | character                                |
7218     |                        |                                          |     |                        |                                          |
7219    
7220    
7221    
7222    
7223    Schoenebeck              Expires March 14, 2009               [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol       September 2008
7226    
7227    
7228     | \xHH                   | two digit hex ASCII code of the          |     | \xHH                   | two digit hex ASCII code of the          |
7229     |                        | character                                |     |                        | character                                |
7230     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 6880  Internet-Draft        LinuxSampler Contr Line 7249  Internet-Draft        LinuxSampler Contr
7249    
7250        "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)        "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
7251    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 123]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
7252        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
7253    
7254        "ADD DB_INSTRUMENTS" (Section 6.8.11)        "ADD DB_INSTRUMENTS" (Section 6.8.11)
# Line 6913  Internet-Draft        LinuxSampler Contr Line 7273  Internet-Draft        LinuxSampler Contr
7273    
7274        "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)        "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)        "SET DB_INSTRUMENT NAME" (Section 6.8.16)
7285    
7286        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)        "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
# Line 6929  Internet-Draft        LinuxSampler Contr Line 7297  Internet-Draft        LinuxSampler Contr
7297    
7298        "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)        "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     Note that the forward slash character ('/') has a special meaning in
7311     filename / path based arguments: it acts as separator of the nodes in     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     the path, thus if a directory- or filename includes a forward slash
# Line 6936  Internet-Draft        LinuxSampler Contr Line 7314  Internet-Draft        LinuxSampler Contr
7314     either with the respective hex escape sequence ("\x2f") or with the     either with the respective hex escape sequence ("\x2f") or with the
7315     respective octal escape sequence ("\057").     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     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    
 Schoenebeck              Expires April 17, 2008               [Page 124]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
7332    
7333    
    at least one of their text-based arguments (i.e. entity name,  
    description) and / or may contain escape sequences in at least one of  
    their text-based fields in their response:  
7334    
7335        "GET SERVER INFO" (Section 6.6.4)  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)        "GET ENGINE INFO" (Section 6.4.9)
7341    
# Line 6996  Internet-Draft        LinuxSampler Contr Line 7382  Internet-Draft        LinuxSampler Contr
7382    
7383    
7384    
7385  Schoenebeck              Expires April 17, 2008               [Page 125]  
7386    
7387    
7388    
7389    
7390    
7391    Schoenebeck              Expires March 14, 2009               [Page 132]
7392    
7393  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7394    
7395    
7396  8.  Events  8.  Events
# Line 7052  Internet-Draft        LinuxSampler Contr Line 7444  Internet-Draft        LinuxSampler Contr
7444    
7445    
7446    
7447  Schoenebeck              Expires April 17, 2008               [Page 126]  Schoenebeck              Expires March 14, 2009               [Page 133]
7448    
7449  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7450    
7451    
7452        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 7095  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 the following notification messages:     Server will start sending one of the the following notification
7498       messages:
7499    
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          "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  Schoenebeck              Expires April 17, 2008               [Page 127]     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         October 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 7119  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 7135  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 7152  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 April 17, 2008               [Page 128]        SUBSCRIBE CHANNEL_INFO
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 7178  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 7195  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 7211  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 April 17, 2008               [Page 129]  Schoenebeck              Expires March 14, 2009               [Page 137]
7672    
7673  Internet-Draft        LinuxSampler Control Protocol         October 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    
# Line 7234  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 7248  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 7267  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 April 17, 2008               [Page 130]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 7291  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 7311  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 7326  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 April 17, 2008               [Page 131]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 7356  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 7370  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 7382  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 April 17, 2008               [Page 132]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 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 7412  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 7429  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 7438  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
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 133]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
 8.22.  Database job status information changed  
7910    
7911     Client may want to be notified when the status of particular database     Client may want to be notified when the status of particular database
7912     instruments job is changed by issuing the following command:     instruments job is changed by issuing the following command:
# Line 7467  Internet-Draft        LinuxSampler Contr Line 7924  Internet-Draft        LinuxSampler Contr
7924     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
7925     empty notification message is sufficient here.     empty notification message is sufficient here.
7926    
7927  8.23.  Miscellaneous and debugging events  8.26.  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 7491  Internet-Draft        LinuxSampler Contr Line 7948  Internet-Draft        LinuxSampler Contr
7948    
7949    
7950    
7951    Schoenebeck              Expires March 14, 2009               [Page 142]
   
   
   
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 134]  
7952    
7953  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
7954    
7955    
7956  9.  Security Considerations  9.  Security Considerations
# Line 7556  Internet-Draft        LinuxSampler Contr Line 8004  Internet-Draft        LinuxSampler Contr
8004    
8005    
8006    
8007  Schoenebeck              Expires April 17, 2008               [Page 135]  Schoenebeck              Expires March 14, 2009               [Page 143]
8008    
8009  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
8010    
8011    
8012  10.  Acknowledgments  10.  Acknowledgments
# Line 7612  Internet-Draft        LinuxSampler Contr Line 8060  Internet-Draft        LinuxSampler Contr
8060    
8061    
8062    
8063  Schoenebeck              Expires April 17, 2008               [Page 136]  Schoenebeck              Expires March 14, 2009               [Page 144]
8064    
8065  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
8066    
8067    
8068  11.  References  11.  References
# Line 7668  Internet-Draft        LinuxSampler Contr Line 8116  Internet-Draft        LinuxSampler Contr
8116    
8117    
8118    
8119  Schoenebeck              Expires April 17, 2008               [Page 137]  Schoenebeck              Expires March 14, 2009               [Page 145]
8120    
8121  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol       September 2008
8122    
8123    
8124  Author's Address  Author's Address
# Line 7724  Author's Address Line 8172  Author's Address
8172    
8173    
8174    
8175  Schoenebeck              Expires April 17, 2008               [Page 138]  Schoenebeck              Expires March 14, 2009               [Page 146]
8176    
8177  Internet-Draft        LinuxSampler Control Protocol         October 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 7780  Acknowledgment Line 8228  Acknowledgment
8228    
8229    
8230    
8231  Schoenebeck              Expires April 17, 2008               [Page 139]  Schoenebeck              Expires March 14, 2009               [Page 147]
8232    
   

Legend:
Removed from v.1430  
changed lines
  Added in v.1773

  ViewVC Help
Powered by ViewVC