/[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 974 by schoenebeck, Fri Dec 15 21:46:48 2006 UTC revision 1201 by iliev, Thu May 24 14:22:39 2007 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: June 18, 2007                                 December 15, 2006  Expires: November 25, 2007                                  May 24, 2007
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
# 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 June 18, 2007.     This Internet-Draft will expire on November 25, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2006).     Copyright (C) The IETF Trust (2007).
41    
42    
43    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck               Expires June 18, 2007                 [Page 1]  Schoenebeck             Expires November 25, 2007               [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
58    
59    
60  Abstract  Abstract
# Line 68  Abstract Line 68  Abstract
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  5     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6
72     2.  Versioning of this specification . . . . . . . . . . . . . . .  6     2.  Versioning of this specification  . . . . . . . . . . . . . .   7
73     3.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  7     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8
74     4.  Focus of this protocol . . . . . . . . . . . . . . . . . . . .  8     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9
75     5.  Communication Overview . . . . . . . . . . . . . . . . . . . .  9     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10
76       5.1.  Request/response communication method  . . . . . . . . . .  9       5.1.  Request/response communication method . . . . . . . . . .  10
77         5.1.1.  Result format  . . . . . . . . . . . . . . . . . . . . 10         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11
78       5.2.  Subscribe/notify communication method  . . . . . . . . . . 12       5.2.  Subscribe/notify communication method . . . . . . . . . .  13
79     6.  Description for control commands . . . . . . . . . . . . . . . 14     6.  Description for control commands  . . . . . . . . . . . . . .  15
80       6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 14       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15
81       6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 14       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15
82         6.2.1.  Getting amount of available audio output drivers . . . 15         6.2.1.  Getting amount of available audio output drivers  . .  16
83         6.2.2.  Getting all available audio output drivers . . . . . . 15         6.2.2.  Getting all available audio output drivers  . . . . .  16
84         6.2.3.  Getting information about a specific audio output         6.2.3.  Getting information about a specific audio output
85                 driver . . . . . . . . . . . . . . . . . . . . . . . . 15                 driver  . . . . . . . . . . . . . . . . . . . . . . .  16
86         6.2.4.  Getting information about specific audio output         6.2.4.  Getting information about specific audio output
87                 driver parameter . . . . . . . . . . . . . . . . . . . 16                 driver parameter  . . . . . . . . . . . . . . . . . .  17
88         6.2.5.  Creating an audio output device  . . . . . . . . . . . 20         6.2.5.  Creating an audio output device . . . . . . . . . . .  21
89         6.2.6.  Destroying an audio output device  . . . . . . . . . . 21         6.2.6.  Destroying an audio output device . . . . . . . . . .  22
90         6.2.7.  Getting all created audio output device count  . . . . 22         6.2.7.  Getting all created audio output device count . . . .  23
91         6.2.8.  Getting all created audio output device list . . . . . 22         6.2.8.  Getting all created audio output device list  . . . .  23
92         6.2.9.  Getting current settings of an audio output device . . 22         6.2.9.  Getting current settings of an audio output device  .  23
93         6.2.10. Changing settings of audio output devices  . . . . . . 24         6.2.10. Changing settings of audio output devices . . . . . .  25
94         6.2.11. Getting information about an audio channel . . . . . . 25         6.2.11. Getting information about an audio channel  . . . . .  26
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter  . . . . . . . . . . . . . . . . . . . . . . 26                 parameter . . . . . . . . . . . . . . . . . . . . . .  27
97         6.2.13. Changing settings of audio output channels . . . . . . 28         6.2.13. Changing settings of audio output channels  . . . . .  29
98       6.3.  Configuring MIDI input drivers . . . . . . . . . . . . . . 29       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30
99         6.3.1.  Getting amount of available MIDI input drivers . . . . 30         6.3.1.  Getting amount of available MIDI input drivers  . . .  31
100         6.3.2.  Getting all available MIDI input drivers . . . . . . . 30         6.3.2.  Getting all available MIDI input drivers  . . . . . .  31
101         6.3.3.  Getting information about a specific MIDI input         6.3.3.  Getting information about a specific MIDI input
102                 driver . . . . . . . . . . . . . . . . . . . . . . . . 31                 driver  . . . . . . . . . . . . . . . . . . . . . . .  32
103         6.3.4.  Getting information about specific MIDI input         6.3.4.  Getting information about specific MIDI input
104                 driver parameter . . . . . . . . . . . . . . . . . . . 32                 driver parameter  . . . . . . . . . . . . . . . . . .  33
105         6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 34         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35
106         6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 35         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36
107         6.3.7.  Getting all created MIDI input device count  . . . . . 36         6.3.7.  Getting all created MIDI input device count . . . . .  37
108    
109    
110    
111  Schoenebeck               Expires June 18, 2007                 [Page 2]  Schoenebeck             Expires November 25, 2007               [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
114    
115    
116         6.3.8.  Getting all created MIDI input device list . . . . . . 36         6.3.8.  Getting all created MIDI input device list  . . . . .  37
117         6.3.9.  Getting current settings of a MIDI input device  . . . 37         6.3.9.  Getting current settings of a MIDI input device . . .  38
118         6.3.10. Changing settings of MIDI input devices  . . . . . . . 38         6.3.10. Changing settings of MIDI input devices . . . . . . .  39
119         6.3.11. Getting information about a MIDI port  . . . . . . . . 38         6.3.11. Getting information about a MIDI port . . . . . . . .  39
120         6.3.12. Getting information about specific MIDI port         6.3.12. Getting information about specific MIDI port
121                 parameter  . . . . . . . . . . . . . . . . . . . . . . 39                 parameter . . . . . . . . . . . . . . . . . . . . . .  40
122         6.3.13. Changing settings of MIDI input ports  . . . . . . . . 41         6.3.13. Changing settings of MIDI input ports . . . . . . . .  42
123       6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 42       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43
124         6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 42         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125         6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 43         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126         6.4.3.  Getting all created sampler channel count  . . . . . . 44         6.4.3.  Getting all created sampler channel count . . . . . .  45
127         6.4.4.  Getting all created sampler channel list . . . . . . . 44         6.4.4.  Getting all created sampler channel list  . . . . . .  45
128         6.4.5.  Adding a new sampler channel . . . . . . . . . . . . . 44         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  45
129         6.4.6.  Removing a sampler channel . . . . . . . . . . . . . . 45         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  46
130         6.4.7.  Getting amount of available engines  . . . . . . . . . 46         6.4.7.  Getting amount of available engines . . . . . . . . .  47
131         6.4.8.  Getting all available engines  . . . . . . . . . . . . 46         6.4.8.  Getting all available engines . . . . . . . . . . . .  47
132         6.4.9.  Getting information about an engine  . . . . . . . . . 47         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information  . . . . . . . . . 48         6.4.10. Getting sampler channel information . . . . . . . . .  49
134         6.4.11. Current number of active voices  . . . . . . . . . . . 51         6.4.11. Current number of active voices . . . . . . . . . . .  52
135         6.4.12. Current number of active disk streams  . . . . . . . . 51         6.4.12. Current number of active disk streams . . . . . . . .  52
136         6.4.13. Current fill state of disk stream buffers  . . . . . . 52         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device  . . . . . . . . . . . . . 53         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type  . . . . . . . . . . . . . . 53         6.4.15. Setting audio output type . . . . . . . . . . . . . .  54
139         6.4.16. Setting audio output channel . . . . . . . . . . . . . 54         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55
140         6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 55         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141         6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 56         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142         6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 56         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  57
143         6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144         6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 58         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145         6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  59
146         6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 59         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60
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  . . . . . . . . . . . . . . . . . . . . . . . 60                 channel . . . . . . . . . . . . . . . . . . . . . . .  61
149         6.4.25. Resetting a sampler channel  . . . . . . . . . . . . . 61         6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150       6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 61         6.4.26. Removing an effect send from a sampler channel  . . .  63
151         6.5.1.  Register front-end for receiving event messages  . . . 61         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
153           6.4.29. Getting effect send information . . . . . . . . . . .  65
154           6.4.30. Changing effect send's name . . . . . . . . . . . . .  66
155           6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156           6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157           6.4.33. Altering effect send's send level . . . . . . . . . .  68
158           6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  69
159         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70
160           6.5.1.  Register front-end for receiving event messages . . .  70
161         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
162                 messages . . . . . . . . . . . . . . . . . . . . . . . 62                 messages  . . . . . . . . . . . . . . . . . . . . . .  71
163         6.5.3.  Enable or disable echo of commands . . . . . . . . . . 63         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  71
        6.5.4.  Close client connection  . . . . . . . . . . . . . . . 63  
      6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 64  
        6.6.1.  Current number of active voices  . . . . . . . . . . . 64  
        6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 64  
        6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 64  
        6.6.4.  General sampler informations . . . . . . . . . . . . . 65  
      6.7.  MIDI Instrument Mapping  . . . . . . . . . . . . . . . . . 65  
        6.7.1.  Create a new MIDI instrument map . . . . . . . . . . . 66  
        6.7.2.  Delete one particular or all MIDI instrument maps  . . 67  
164    
165    
166    
167  Schoenebeck               Expires June 18, 2007                 [Page 3]  Schoenebeck             Expires November 25, 2007               [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
170    
171    
172         6.7.3.  Get amount of existing MIDI instrument maps  . . . . . 67         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
173         6.7.4.  Getting all created MIDI instrument maps . . . . . . . 68       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72
174         6.7.5.  Getting MIDI instrument map information  . . . . . . . 68         6.6.1.  Current number of active voices . . . . . . . . . . .  72
175         6.7.6.  Renaming a MIDI instrument map . . . . . . . . . . . . 69         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73
176         6.7.7.  Create or replace a MIDI instrument map entry  . . . . 69         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73
177         6.7.8.  Getting ammount of MIDI instrument map entries . . . . 72         6.6.4.  General sampler informations  . . . . . . . . . . . .  73
178           6.6.5.  Getting global volume attenuation . . . . . . . . . .  74
179           6.6.6.  Setting global volume attenuation . . . . . . . . . .  74
180         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75
181           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76
182           6.7.2.  Delete one particular or all MIDI instrument maps . .  76
183           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77
184           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  77
185           6.7.5.  Getting MIDI instrument map information . . . . . . .  78
186           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79
187           6.7.7.  Create or replace a MIDI instrument map entry . . . .  79
188           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82
189         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
190                 instrument map . . . . . . . . . . . . . . . . . . . . 73                 instrument map  . . . . . . . . . . . . . . . . . . .  83
191         6.7.10. Remove an entry from the MIDI instrument map . . . . . 73         6.7.10. Remove an entry from the MIDI instrument map  . . . .  83
192         6.7.11. Get current settings of MIDI instrument map entry  . . 74         6.7.11. Get current settings of MIDI instrument map entry . .  84
193         6.7.12. Clear MIDI instrument map  . . . . . . . . . . . . . . 76         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194     7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 77       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  86
195     8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86         6.8.1.  Creating a new instrument directory . . . . . . . . .  86
196       8.1.  Number of sampler channels changed . . . . . . . . . . . . 86         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87
197       8.2.  Number of active voices changed  . . . . . . . . . . . . . 86         6.8.3.  Getting amount of instrument directories  . . . . . .  88
198       8.3.  Number of active disk streams changed  . . . . . . . . . . 86         6.8.4.  Listing all directories in specific directory . . . .  88
199       8.4.  Disk stream buffer fill state changed  . . . . . . . . . . 87         6.8.5.  Getting instrument directory information  . . . . . .  89
200       8.5.  Channel information changed  . . . . . . . . . . . . . . . 87         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90
201       8.6.  Total number of active voices changed  . . . . . . . . . . 87         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  90
202       8.7.  Miscellaneous and debugging events . . . . . . . . . . . . 88         6.8.8.  Copying instrument directories  . . . . . . . . . . .  91
203     9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 89         6.8.9.  Changing the description of directory . . . . . . . .  92
204     10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 90         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  92
205     11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 91         6.8.11. Adding instruments to the instruments database  . . .  94
206     Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 92         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  95
207     Intellectual Property and Copyright Statements . . . . . . . . . . 93         6.8.13. Getting amount of instruments . . . . . . . . . . . .  96
208           6.8.14. Listing all instruments in specific directory . . . .  96
209           6.8.15. Getting instrument information  . . . . . . . . . . .  97
210           6.8.16. Renaming an instrument  . . . . . . . . . . . . . . .  99
211           6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 100
212           6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 100
213           6.8.19. Changing the description of instrument  . . . . . . . 101
214           6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 101
215           6.8.21. Getting job status information  . . . . . . . . . . . 104
216       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 106
217       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
218         8.1.  Number of audio output devices changed  . . . . . . . . . 120
219         8.2.  Audio output device's settings changed  . . . . . . . . . 120
220    
221    
222    
223    Schoenebeck             Expires November 25, 2007               [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol             May 2007
226    
227    
228         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 120
229         8.4.  MIDI input device's settings changed  . . . . . . . . . . 121
230         8.5.  Number of sampler channels changed  . . . . . . . . . . . 121
231         8.6.  Number of active voices changed . . . . . . . . . . . . . 121
232         8.7.  Number of active disk streams changed . . . . . . . . . . 122
233         8.8.  Disk stream buffer fill state changed . . . . . . . . . . 122
234         8.9.  Channel information changed . . . . . . . . . . . . . . . 122
235         8.10. Number of effect sends changed  . . . . . . . . . . . . . 123
236         8.11. Effect send information changed . . . . . . . . . . . . . 123
237         8.12. Total number of active voices changed . . . . . . . . . . 123
238         8.13. Number of MIDI instrument maps changed  . . . . . . . . . 124
239         8.14. MIDI instrument map information changed . . . . . . . . . 124
240         8.15. Number of MIDI instruments changed  . . . . . . . . . . . 124
241         8.16. MIDI instrument information changed . . . . . . . . . . . 125
242         8.17. Global settings changed . . . . . . . . . . . . . . . . . 125
243         8.18. Number of database instrument directories changed . . . . 126
244         8.19. Database instrument directory information changed . . . . 126
245         8.20. Number of database instruments changed  . . . . . . . . . 127
246         8.21. Database instrument information changed . . . . . . . . . 127
247         8.22. Database job status information changed . . . . . . . . . 128
248         8.23. Miscellaneous and debugging events  . . . . . . . . . . . 128
249       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 129
250       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 130
251       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 131
252       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 132
253       Intellectual Property and Copyright Statements  . . . . . . . . . 133
254    
255    
256    
# Line 220  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck               Expires June 18, 2007                 [Page 4]  Schoenebeck             Expires November 25, 2007               [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires June 18, 2007                 [Page 5]  Schoenebeck             Expires November 25, 2007               [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires June 18, 2007                 [Page 6]  Schoenebeck             Expires November 25, 2007               [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires June 18, 2007                 [Page 7]  Schoenebeck             Expires November 25, 2007               [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires June 18, 2007                 [Page 8]  Schoenebeck             Expires November 25, 2007               [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires June 18, 2007                 [Page 9]  Schoenebeck             Expires November 25, 2007              [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires June 18, 2007                [Page 10]  Schoenebeck             Expires November 25, 2007              [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires June 18, 2007                [Page 11]  Schoenebeck             Expires November 25, 2007              [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires June 18, 2007                [Page 12]  Schoenebeck             Expires November 25, 2007              [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 724  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck               Expires June 18, 2007                [Page 13]  Schoenebeck             Expires November 25, 2007              [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 780  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck               Expires June 18, 2007                [Page 14]  Schoenebeck             Expires November 25, 2007              [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires June 18, 2007                [Page 15]  Schoenebeck             Expires November 25, 2007              [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires June 18, 2007                [Page 16]  Schoenebeck             Expires November 25, 2007              [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires June 18, 2007                [Page 17]  Schoenebeck             Expires November 25, 2007              [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires June 18, 2007                [Page 18]  Schoenebeck             Expires November 25, 2007              [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires June 18, 2007                [Page 19]  Schoenebeck             Expires November 25, 2007              [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires June 18, 2007                [Page 20]  Schoenebeck             Expires November 25, 2007              [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires June 18, 2007                [Page 21]  Schoenebeck             Expires November 25, 2007              [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires June 18, 2007                [Page 22]  Schoenebeck             Expires November 25, 2007              [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck               Expires June 18, 2007                [Page 23]  Schoenebeck             Expires November 25, 2007              [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck               Expires June 18, 2007                [Page 24]  Schoenebeck             Expires November 25, 2007              [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck               Expires June 18, 2007                [Page 25]  Schoenebeck             Expires November 25, 2007              [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck               Expires June 18, 2007                [Page 26]  Schoenebeck             Expires November 25, 2007              [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires June 18, 2007                [Page 27]  Schoenebeck             Expires November 25, 2007              [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires June 18, 2007                [Page 28]  Schoenebeck             Expires November 25, 2007              [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck               Expires June 18, 2007                [Page 29]  Schoenebeck             Expires November 25, 2007              [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck               Expires June 18, 2007                [Page 30]  Schoenebeck             Expires November 25, 2007              [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck               Expires June 18, 2007                [Page 31]  Schoenebeck             Expires November 25, 2007              [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck               Expires June 18, 2007                [Page 32]  Schoenebeck             Expires November 25, 2007              [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck               Expires June 18, 2007                [Page 33]  Schoenebeck             Expires November 25, 2007              [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck               Expires June 18, 2007                [Page 34]  Schoenebeck             Expires November 25, 2007              [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 1956  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck               Expires June 18, 2007                [Page 35]  Schoenebeck             Expires November 25, 2007              [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck               Expires June 18, 2007                [Page 36]  Schoenebeck             Expires November 25, 2007              [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck               Expires June 18, 2007                [Page 37]  Schoenebeck             Expires November 25, 2007              [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck               Expires June 18, 2007                [Page 38]  Schoenebeck             Expires November 25, 2007              [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck               Expires June 18, 2007                [Page 39]  Schoenebeck             Expires November 25, 2007              [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck               Expires June 18, 2007                [Page 40]  Schoenebeck             Expires November 25, 2007              [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck               Expires June 18, 2007                [Page 41]  Schoenebeck             Expires November 25, 2007              [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2354    
2355    
2356           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck               Expires June 18, 2007                [Page 42]  Schoenebeck             Expires November 25, 2007              [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2410    
2411    
2412           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck               Expires June 18, 2007                [Page 43]  Schoenebeck             Expires November 25, 2007              [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2466    
2467    
2468     Example:     Example:
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck               Expires June 18, 2007                [Page 44]  Schoenebeck             Expires November 25, 2007              [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2522    
2523    
2524        ADD CHANNEL        ADD CHANNEL
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck               Expires June 18, 2007                [Page 45]  Schoenebeck             Expires November 25, 2007              [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2578    
2579    
2580        "OK" -        "OK" -
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires June 18, 2007                [Page 46]  Schoenebeck             Expires November 25, 2007              [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2634    
2635    
2636        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires June 18, 2007                [Page 47]  Schoenebeck             Expires November 25, 2007              [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2690    
2691    
2692           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires June 18, 2007                [Page 48]  Schoenebeck             Expires November 25, 2007              [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2746    
2747    
2748              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck               Expires June 18, 2007                [Page 49]  Schoenebeck             Expires November 25, 2007              [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2802    
2803    
2804           MUTE -           MUTE -
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855  Schoenebeck               Expires June 18, 2007                [Page 50]  Schoenebeck             Expires November 25, 2007              [Page 51]
2856    
2857  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2858    
2859    
2860           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
# Line 2852  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911  Schoenebeck               Expires June 18, 2007                [Page 51]  Schoenebeck             Expires November 25, 2007              [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2914    
2915    
2916        return "NA" for not available.        return "NA" for not available.
# Line 2908  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck               Expires June 18, 2007                [Page 52]  Schoenebeck             Expires November 25, 2007              [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
2970    
2971    
2972        S: ""        S: ""
# Line 2964  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck               Expires June 18, 2007                [Page 53]  Schoenebeck             Expires November 25, 2007              [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
3026    
3027    
3028     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
# Line 3020  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck               Expires June 18, 2007                [Page 54]  Schoenebeck             Expires November 25, 2007              [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
3082    
3083    
3084           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck               Expires June 18, 2007                [Page 55]  Schoenebeck             Expires November 25, 2007              [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
3138    
3139    
3140  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
# Line 3132  Internet-Draft        LinuxSampler Contr Line 3188  Internet-Draft        LinuxSampler Contr
3188    
3189    
3190    
3191  Schoenebeck               Expires June 18, 2007                [Page 56]  Schoenebeck             Expires November 25, 2007              [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
3194    
3195    
3196           on success           on success
# Line 3188  Internet-Draft        LinuxSampler Contr Line 3244  Internet-Draft        LinuxSampler Contr
3244    
3245    
3246    
3247  Schoenebeck               Expires June 18, 2007                [Page 57]  Schoenebeck             Expires November 25, 2007              [Page 58]
3248    
3249  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
3250    
3251    
3252    
# Line 3244  Internet-Draft        LinuxSampler Contr Line 3300  Internet-Draft        LinuxSampler Contr
3300    
3301    
3302    
3303  Schoenebeck               Expires June 18, 2007                [Page 58]  Schoenebeck             Expires November 25, 2007              [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
3306    
3307    
3308        "OK" -        "OK" -
# Line 3300  Internet-Draft        LinuxSampler Contr Line 3356  Internet-Draft        LinuxSampler Contr
3356    
3357    
3358    
3359  Schoenebeck               Expires June 18, 2007                [Page 59]  Schoenebeck             Expires November 25, 2007              [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
3362    
3363    
3364     Examples:     Examples:
# Line 3356  Internet-Draft        LinuxSampler Contr Line 3412  Internet-Draft        LinuxSampler Contr
3412    
3413    
3414    
3415  Schoenebeck               Expires June 18, 2007                [Page 60]  Schoenebeck             Expires November 25, 2007              [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol             May 2007
3418    
3419    
3420       Examples:
3421    
3422    
3423    
3424    6.4.25.  Adding an effect send to a sampler channel
3425    
3426       The front-end can create an additional effect send on a specific
3427       sampler channel by sending the following command:
3428    
3429          CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3430    
3431       Where <sampler-channel> is the respective sampler channel number as
3432       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3433       (Section 6.4.4) command, that is the sampler channel on which the
3434       effect send should be created on, <midi-ctrl> is a number between
3435       0..127 defining the MIDI controller which can alter the effect send
3436       level and <name> is an optional argument defining a name for the
3437       effect send entity.  The name does not have to be unique.
3438    
3439       By default, that is as initial routing, the effect send's audio
3440       channels are automatically routed to the last audio channels of the
3441       sampler channel's audio output device, that way you can i.e. first
3442       increase the amount of audio channels on the audio output device for
3443       having dedicated effect send output channels and when "CREATE
3444       FX_SEND" is called, those channels will automatically be picked.  You
3445       can alter the destination channels however with "SET FX_SEND
3446       AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3447    
3448       Note: Create effect sends on a sampler channel only when needed,
3449       because having effect sends on a sampler channel will decrease
3450       runtime performance, because for implementing channel effect sends,
3451       separate (sampler channel local) audio buffers are needed to render
3452       and mix the voices and route the audio signal afterwards to the
3453       master outputs and effect send outputs (along with their respective
3454       effect send levels).  A sampler channel without effect sends however
3455       can mix its voices directly into the audio output devices's audio
3456       buffers and is thus faster.
3457    
3458       Possible Answers:
3459    
3460          "OK[<fx-send-id>]" -
3461    
3462             in case a new effect send could be added to the sampler
3463             channel, where <fx-send-id> reflects the unique ID of the newly
3464             created effect send entity
3465    
3466    
3467    
3468    
3469    
3470    
3471    Schoenebeck             Expires November 25, 2007              [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol             May 2007
3474    
3475    
3476          "ERR:<error-code>:<error-message>" -
3477    
3478             when a new effect send could not be added, i.e. due to invalid
3479             parameters
3480    
3481       Examples:
3482    
3483          C: "CREATE FX_SEND 0 91 'Reverb Send'"
3484    
3485          S: "OK[0]"
3486    
3487          C: "CREATE FX_SEND 0 93"
3488    
3489          S: "OK[1]"
3490    
3491    6.4.26.  Removing an effect send from a sampler channel
3492    
3493       The front-end can remove an existing effect send on a specific
3494       sampler channel by sending the following command:
3495    
3496          DESTROY FX_SEND <sampler-channel> <fx-send-id>
3497    
3498       Where <sampler-channel> is the respective sampler channel number as
3499       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3500       (Section 6.4.4) command, that is the sampler channel from which the
3501       effect send should be removed from and <fx-send-id> is the respective
3502       effect send number as returned by the "CREATE FX_SEND"
3503       (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3504    
3505       Possible Answers:
3506    
3507          "OK" -
3508    
3509             on success
3510    
3511          "ERR:<error-code>:<error-message>" -
3512    
3513             in case it failed, providing an appropriate error code and
3514             error message
3515    
3516       Example:
3517    
3518          C: "DESTROY FX_SEND 0 0"
3519    
3520          S: "OK"
3521    
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck             Expires November 25, 2007              [Page 63]
3528    
3529  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
3530    
3531    
3532    6.4.27.  Getting amount of effect sends on a sampler channel
3533    
3534       The front-end can ask for the amount of effect sends on a specific
3535       sampler channel by sending the following command:
3536    
3537          GET FX_SENDS <sampler-channel>
3538    
3539       Where <sampler-channel> is the respective sampler channel number as
3540       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3541       (Section 6.4.4) command.
3542    
3543       Possible Answers:
3544    
3545          The sampler will answer by returning the number of effect sends on
3546          the given sampler channel.
3547    
3548       Example:
3549    
3550          C: "GET FX_SENDS 0"
3551    
3552          S: "2"
3553    
3554    6.4.28.  Listing all effect sends on a sampler channel
3555    
3556       The front-end can ask for a list of effect sends on a specific
3557       sampler channel by sending the following command:
3558    
3559          LIST FX_SENDS <sampler-channel>
3560    
3561       Where <sampler-channel> is the respective sampler channel number as
3562       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3563       (Section 6.4.4) command.
3564    
3565       Possible Answers:
3566    
3567          The sampler will answer by returning a comma separated list with
3568          all effect sends' numerical IDs on the given sampler channel.
3569    
3570     Examples:     Examples:
3571    
3572          C: "LIST FX_SENDS 0"
3573    
3574          S: "0,1"
3575    
3576          C: "LIST FX_SENDS 1"
3577    
3578          S: ""
3579    
3580    
3581    
3582    
3583    Schoenebeck             Expires November 25, 2007              [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol             May 2007
3586    
3587    
3588    6.4.29.  Getting effect send information
3589    
3590       The front-end can ask for the current settings of an effect send
3591       entity by sending the following command:
3592    
3593          GET FX_SEND INFO <sampler-channel> <fx-send-id>
3594    
3595       Where <sampler-channel> is the sampler channel number as returned by
3596       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3597       command and <fx-send-id> reflects the numerical ID of the effect send
3598       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3599       FX_SENDS" (Section 6.4.28) command.
3600    
3601       Possible Answers:
3602    
3603          The sampler will answer by sending a <CRLF> separated list.  Each
3604          answer line begins with the settings category name followed by a
3605          colon and then a space character <SP> and finally the info
3606          character string to that setting category.  At the moment the
3607          following categories are defined:
3608    
3609    
3610    
3611             NAME -
3612    
3613                name of the effect send entity
3614    
3615             MIDI_CONTROLLER -
3616    
3617                a value between 0 and 127 reflecting the MIDI controller
3618                which is able to modify the effect send's send level
3619    
3620             LEVEL -
3621    
3622                optionally dotted number reflecting the effect send's
3623                current send level (where a value < 1.0 means attenuation
3624                and a value > 1.0 means amplification)
3625    
3626             AUDIO_OUTPUT_ROUTING -
3627    
3628                comma separated list which reflects to which audio channel
3629                of the selected audio output device each effect send output
3630                channel is routed to, e.g. "0,3" would mean the effect
3631                send's output channel 0 is routed to channel 0 of the audio
3632                output device and the effect send's output channel 1 is
3633                routed to the channel 3 of the audio output device (see "SET
3634                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3635    
3636    
3637    
3638    
3639    Schoenebeck             Expires November 25, 2007              [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol             May 2007
3642    
3643    
3644       The mentioned fields above don't have to be in particular order.
3645    
3646       Example:
3647    
3648          C: "GET FX_SEND INFO 0 0"
3649    
3650          S: "NAME: Reverb Send"
3651    
3652             "MIDI_CONTROLLER: 91"
3653    
3654             "LEVEL: 0.3"
3655    
3656             "AUDIO_OUTPUT_ROUTING: 2,3"
3657    
3658             "."
3659    
3660    6.4.30.  Changing effect send's name
3661    
3662       The front-end can alter the current name of an effect send entity by
3663       sending the following command:
3664    
3665          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3666    
3667       Where <sampler-chan> is the sampler channel number as returned by the
3668       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3669       command, <fx-send-id> reflects the numerical ID of the effect send
3670       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3671       FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3672       effect send entity, which does not have to be unique.
3673    
3674       Possible Answers:
3675    
3676          "OK" -
3677    
3678  6.4.25.  Resetting a sampler channel           on success
3679    
3680          "ERR:<error-code>:<error-message>" -
3681    
3682             in case it failed, providing an appropriate error code and
3683             error message
3684    
3685       Example:
3686    
3687          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3688    
3689          S: "OK"
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck             Expires November 25, 2007              [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol             May 2007
3698    
3699    
3700    6.4.31.  Altering effect send's audio routing
3701    
3702       The front-end can alter the destination of an effect send's audio
3703       channel on a specific sampler channel by sending the following
3704       command:
3705    
3706          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3707          <audio-src> <audio-dst>
3708    
3709       Where <sampler-chan> is the sampler channel number as returned by the
3710       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3711       command, <fx-send-id> reflects the numerical ID of the effect send
3712       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3713       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3714       of the effect send's audio channel which should be rerouted and
3715       <audio-dst> is the numerical ID of the audio channel of the selected
3716       audio output device where <audio-src> should be routed to.
3717    
3718       Note that effect sends can only route audio to the same audio output
3719       device as assigned to the effect send's sampler channel.  Also note
3720       that an effect send entity does always have exactly as much audio
3721       channels as its sampler channel.  So if the sampler channel is
3722       stereo, the effect send does have two audio channels as well.  Also
3723       keep in mind that the amount of audio channels on a sampler channel
3724       might be dependant not only to the deployed sampler engine on the
3725       sampler channel, but also dependant to the instrument currently
3726       loaded.  However you can (effectively) turn an i.e. stereo effect
3727       send into a mono one by simply altering its audio routing
3728       appropriately.
3729    
3730       Possible Answers:
3731    
3732          "OK" -
3733    
3734             on success
3735    
3736          "WRN:<warning-code>:<warning-message>" -
3737    
3738             if audio output channel was set, but there are noteworthy
3739             issue(s) related, providing an appropriate warning code and
3740             warning message
3741    
3742          "ERR:<error-code>:<error-message>" -
3743    
3744             in case it failed, providing an appropriate error code and
3745             error message
3746    
3747       Example:
3748    
3749    
3750    
3751    Schoenebeck             Expires November 25, 2007              [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol             May 2007
3754    
3755    
3756          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3757    
3758          S: "OK"
3759    
3760    6.4.32.  Altering effect send's MIDI controller
3761    
3762       The front-end can alter the MIDI controller of an effect send entity
3763       by sending the following command:
3764    
3765          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3766          ctrl>
3767    
3768       Where <sampler-chan> is the sampler channel number as returned by the
3769       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3770       command, <fx-send-id> reflects the numerical ID of the effect send
3771       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3772       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3773       controller which shall be able to modify the effect send's send
3774       level.
3775    
3776       Possible Answers:
3777    
3778          "OK" -
3779    
3780             on success
3781    
3782          "WRN:<warning-code>:<warning-message>" -
3783    
3784             if MIDI controller was set, but there are noteworthy issue(s)
3785             related, providing an appropriate warning code and warning
3786             message
3787    
3788          "ERR:<error-code>:<error-message>" -
3789    
3790             in case it failed, providing an appropriate error code and
3791             error message
3792    
3793       Example:
3794    
3795          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3796    
3797          S: "OK"
3798    
3799    6.4.33.  Altering effect send's send level
3800    
3801       The front-end can alter the current send level of an effect send
3802       entity by sending the following command:
3803    
3804    
3805    
3806    
3807    Schoenebeck             Expires November 25, 2007              [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol             May 2007
3810    
3811    
3812          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3813    
3814       Where <sampler-chan> is the sampler channel number as returned by the
3815       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3816       command, <fx-send-id> reflects the numerical ID of the effect send
3817       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3818       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3819       dotted positive number (a value smaller than 1.0 means attenuation,
3820       whereas a value greater than 1.0 means amplification) reflecting the
3821       new send level.
3822    
3823       Possible Answers:
3824    
3825          "OK" -
3826    
3827             on success
3828    
3829          "WRN:<warning-code>:<warning-message>" -
3830    
3831             if new send level was set, but there are noteworthy issue(s)
3832             related, providing an appropriate warning code and warning
3833             message
3834    
3835          "ERR:<error-code>:<error-message>" -
3836    
3837             in case it failed, providing an appropriate error code and
3838             error message
3839    
3840       Example:
3841    
3842          C: "SET FX_SEND LEVEL 0 0 0.15"
3843    
3844          S: "OK"
3845    
3846    6.4.34.  Resetting a sampler channel
3847    
3848     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3849     following command:     following command:
# Line 3379  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857    
3858     Possible Answers:     Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck             Expires November 25, 2007              [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol             May 2007
3866    
3867    
3868        "OK" -        "OK" -
3869    
3870           on success           on success
# Line 3408  Internet-Draft        LinuxSampler Contr Line 3894  Internet-Draft        LinuxSampler Contr
3894     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3895     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3896    
   
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3897        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3898    
3899     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 3434  Internet-Draft        LinuxSampler Contr Line 3911  Internet-Draft        LinuxSampler Contr
3911           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3912           message           message
3913    
3914    
3915    
3916    
3917    
3918    
3919    Schoenebeck             Expires November 25, 2007              [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol             May 2007
3922    
3923    
3924        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3925    
3926           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3465  Internet-Draft        LinuxSampler Contr Line 3952  Internet-Draft        LinuxSampler Contr
3952           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3953           message           message
3954    
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
3955        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3956    
3957           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3490  Internet-Draft        LinuxSampler Contr Line 3969  Internet-Draft        LinuxSampler Contr
3969        SET ECHO <value>        SET ECHO <value>
3970    
3971     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
3972    
3973    
3974    
3975    Schoenebeck             Expires November 25, 2007              [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol             May 2007
3978    
3979    
3980     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
3981     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
3982     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 3520  Internet-Draft        LinuxSampler Contr Line 4007  Internet-Draft        LinuxSampler Contr
4007     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4008     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4009    
   
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4010  6.6.  Global commands  6.6.  Global commands
4011    
4012     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
# Line 3545  Internet-Draft        LinuxSampler Contr Line 4023  Internet-Draft        LinuxSampler Contr
4023        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4024        voices on the sampler.        voices on the sampler.
4025    
4026    
4027    
4028    
4029    
4030    
4031    Schoenebeck             Expires November 25, 2007              [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol             May 2007
4034    
4035    
4036  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
4037    
4038     The front-end can ask for the maximum number of active voices by     The front-end can ask for the maximum number of active voices by
# Line 3574  Internet-Draft        LinuxSampler Contr Line 4062  Internet-Draft        LinuxSampler Contr
4062    
4063    
4064    
   
   
   
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 64]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4065  6.6.4.  General sampler informations  6.6.4.  General sampler informations
4066    
4067     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
# Line 3604  Internet-Draft        LinuxSampler Contr Line 4081  Internet-Draft        LinuxSampler Contr
4081    
4082           DESCRIPTION -           DESCRIPTION -
4083    
4084    
4085    
4086    
4087    Schoenebeck             Expires November 25, 2007              [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol             May 2007
4090    
4091    
4092              arbitrary textual description about the sampler              arbitrary textual description about the sampler
4093    
4094           VERSION -           VERSION -
# Line 3615  Internet-Draft        LinuxSampler Contr Line 4100  Internet-Draft        LinuxSampler Contr
4100              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
4101              (see Section 2 for details)              (see Section 2 for details)
4102    
4103             INSTRUMENTS_DB_SUPPORT -
4104    
4105                either yes or no, specifies whether the sampler is build
4106                with instruments database support.
4107    
4108     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4109     Other fields might be added in future.     Other fields might be added in future.
4110    
4111    6.6.5.  Getting global volume attenuation
4112    
4113       The client can ask for the current global sampler-wide volume
4114       attenuation by sending the following command:
4115    
4116          GET VOLUME
4117    
4118       Possible Answers:
4119    
4120          The sampler will always answer by returning the optional dotted
4121          floating point coefficient, reflecting the current global volume
4122          attenuation.
4123    
4124       Note: it is up to the respective sampler engine whether to obey that
4125       global volume parameter or not, but in general all engines SHOULD use
4126       this parameter.
4127    
4128    6.6.6.  Setting global volume attenuation
4129    
4130       The client can alter the current global sampler-wide volume
4131       attenuation by sending the following command:
4132    
4133          SET VOLUME <volume>
4134    
4135       Where <volume> should be replaced by the optional dotted floating
4136       point value, reflecting the new global volume parameter.  This value
4137       might usually be in the range between 0.0 and 1.0, that is for
4138       attenuating the overall volume.
4139    
4140    
4141    
4142    
4143    Schoenebeck             Expires November 25, 2007              [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol             May 2007
4146    
4147    
4148       Possible Answers:
4149    
4150          "OK" -
4151    
4152             on success
4153    
4154          "WRN:<warning-code>:<warning-message>" -
4155    
4156             if the global volume was set, but there are noteworthy issue(s)
4157             related, providing an appropriate warning code and warning
4158             message
4159    
4160          "ERR:<error-code>:<error-message>" -
4161    
4162             in case it failed, providing an appropriate error code and
4163             error message
4164    
4165  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4166    
4167     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 3633  Internet-Draft        LinuxSampler Contr Line 4177  Internet-Draft        LinuxSampler Contr
4177     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,
4178     thus the sampler will simply ignore all program change messages.  The     thus the sampler will simply ignore all program change messages.  The
4179     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
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4180     the map and tell the respective sampler channel(s) which MIDI     the map and tell the respective sampler channel(s) which MIDI
4181     instrument map to use, so the sampler knows how to react on a given     instrument map to use, so the sampler knows how to react on a given
4182     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
# Line 3656  Internet-Draft        LinuxSampler Contr Line 4192  Internet-Draft        LinuxSampler Contr
4192     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4193     current MIDI instrument map.     current MIDI instrument map.
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck             Expires November 25, 2007              [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol             May 2007
4202    
4203    
4204  6.7.1.  Create a new MIDI instrument map  6.7.1.  Create a new MIDI instrument map
4205    
4206     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
# Line 3688  Internet-Draft        LinuxSampler Contr Line 4233  Internet-Draft        LinuxSampler Contr
4233    
4234        S: "OK[1]"        S: "OK[1]"
4235    
   
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4236        C: "ADD MIDI_INSTRUMENT_MAP"        C: "ADD MIDI_INSTRUMENT_MAP"
4237    
4238        S: "OK[5]"        S: "OK[5]"
# Line 3714  Internet-Draft        LinuxSampler Contr Line 4250  Internet-Draft        LinuxSampler Contr
4250     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4251     following command:     following command:
4252    
4253    
4254    
4255    Schoenebeck             Expires November 25, 2007              [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol             May 2007
4258    
4259    
4260        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4261    
4262     Possible Answers:     Possible Answers:
# Line 3745  Internet-Draft        LinuxSampler Contr Line 4288  Internet-Draft        LinuxSampler Contr
4288    
4289     Possible Answers:     Possible Answers:
4290    
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4291        The sampler will answer by returning the current number of MIDI        The sampler will answer by returning the current number of MIDI
4292        instrument maps.        instrument maps.
4293    
# Line 3768  Internet-Draft        LinuxSampler Contr Line 4303  Internet-Draft        LinuxSampler Contr
4303     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4304     following command:     following command:
4305    
4306    
4307    
4308    
4309    
4310    
4311    Schoenebeck             Expires November 25, 2007              [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol             May 2007
4314    
4315    
4316        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4317    
4318     Possible Answers:     Possible Answers:
# Line 3802  Internet-Draft        LinuxSampler Contr Line 4347  Internet-Draft        LinuxSampler Contr
4347    
4348    
4349    
4350             NAME -
4351    
4352                custom name of the given map, which does not have to be
4353                unique
4354    
4355  Schoenebeck               Expires June 18, 2007                [Page 68]           DEFAULT -
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4356    
4357                either true or false, defines whether this map is the
4358                default map
4359    
4360       The mentioned fields above don't have to be in particular order.
4361    
4362       Example:
4363    
          NAME -  
4364    
             custom name of the given map, which does not have to be  
             unique  
4365    
    The mentioned fields above don't have to be in particular order.  
4366    
4367     Example:  Schoenebeck             Expires November 25, 2007              [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol             May 2007
4370    
4371    
4372        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4373    
4374        S: "NAME: Standard Map"        S: "NAME: Standard Map"
4375    
4376             "DEFAULT: true"
4377    
4378           "."           "."
4379    
4380  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
# Line 3857  Internet-Draft        LinuxSampler Contr Line 4408  Internet-Draft        LinuxSampler Contr
4408     The front-end can create a new or replace an existing entry in a     The front-end can create a new or replace an existing entry in a
4409     sampler's MIDI instrument map by sending the following command:     sampler's MIDI instrument map by sending the following command:
4410    
4411          MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4412          <engine_name> <filename> <instrument_index> <volume_value>
4413          [<instr_load_mode>] [<name>]
 Schoenebeck               Expires June 18, 2007                [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
       MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>  
       <filename> <instrument_index> <volume_value> [<instr_load_mode>]  
       [<name>]  
4414    
4415     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
4416     integer value between 0..16383 reflecting the MIDI bank select index,     integer value between 0..16383 reflecting the MIDI bank select index,
4417     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4418     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4419     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4420    
4421    
4422    
4423    Schoenebeck             Expires November 25, 2007              [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol             May 2007
4426    
4427    
4428     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
4429     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes),
4430     <instrument_index> the index (integer value) of the instrument within     <instrument_index> the index (integer value) of the instrument within
# Line 3905  Internet-Draft        LinuxSampler Contr Line 4456  Internet-Draft        LinuxSampler Contr
4456    
4457        "PERSISTENT" -        "PERSISTENT" -
4458    
4459           The instrument will immediately be loaded into memory in the           The instrument will immediately be loaded into memory when this
4460           background when this mapping command is sent and the instrument           mapping command is sent and the instrument is kept all the
4461           is kept all the time.  Instruments with this mode are only           time.  Instruments with this mode are only freed when the
4462           freed when the sampler is reset or all mapping entries with           sampler is reset or all mapping entries with this mode (and
4463           this mode (and respective instrument) are explicitly changed to           respective instrument) are explicitly changed to "ON_DEMAND"
4464           "ON_DEMAND" and no sampler channel is using the instrument           and no sampler channel is using the instrument anymore.
          anymore.  
   
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
4465    
4466        not supplied -        not supplied -
4467    
# Line 3931  Internet-Draft        LinuxSampler Contr Line 4473  Internet-Draft        LinuxSampler Contr
4473           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
4474           that is it will not change the mode.           that is it will not change the mode.
4475    
4476    
4477    
4478    
4479    Schoenebeck             Expires November 25, 2007              [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol             May 2007
4482    
4483    
4484     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
4485     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
4486     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
# Line 3950  Internet-Draft        LinuxSampler Contr Line 4500  Internet-Draft        LinuxSampler Contr
4500     displaying an appropriate name for mapped instruments (using "GET     displaying an appropriate name for mapped instruments (using "GET
4501     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4502    
4503     The "MAP MIDI_INSTRUMENT" command will immediately return, thus it     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4504     will not block when an instrument is to be loaded due to a     completely established in the sampler.  The OPTIONAL "NON_MODAL"
4505     "PERSISTENT" type entry as instruments are loaded in the background.     argument however causes the respective "MAP MIDI_INSTRUMENT" command
4506     As a consequence this command may not necessarily return an error     to return immediately, that is to let the sampler establish the
4507     i.e. when the given instrument file does not exist or may turn out to     mapping in the background.  So this argument might be especially
4508     be corrupt.     useful for mappings with a "PERSISTENT" type, because these have to
4509       load the respective instruments immediately and might thus block for
4510       a very long time.  It is recommended however to use the OPTIONAL
4511       "NON_MODAL" argument only if really necessary, because it has the
4512       following drawbacks: as "NON_MODAL" instructions return immediately,
4513       they may not necessarily return an error i.e. when the given
4514       instrument file turns out to be corrupt, beside that subsequent
4515       commands in a LSCP instruction sequence might fail, because mandatory
4516       mappings are not yet completed.
4517    
4518     Possible Answers:     Possible Answers:
4519    
# Line 3972  Internet-Draft        LinuxSampler Contr Line 4530  Internet-Draft        LinuxSampler Contr
4530    
4531    
4532    
4533  Schoenebeck               Expires June 18, 2007                [Page 71]  
4534    
4535    Schoenebeck             Expires November 25, 2007              [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
4538    
4539    
4540        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
# Line 3997  Internet-Draft        LinuxSampler Contr Line 4557  Internet-Draft        LinuxSampler Contr
4557    
4558        S: "OK"        S: "OK"
4559    
4560        C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4561        PERSISTENT 'Foo Drumkit'"        foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4562    
4563        S: "OK"        S: "OK"
4564    
# Line 4028  Internet-Draft        LinuxSampler Contr Line 4588  Internet-Draft        LinuxSampler Contr
4588    
4589    
4590    
4591  Schoenebeck               Expires June 18, 2007                [Page 72]  Schoenebeck             Expires November 25, 2007              [Page 82]
4592    
4593  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
4594    
4595    
4596        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
# Line 4084  Internet-Draft        LinuxSampler Contr Line 4644  Internet-Draft        LinuxSampler Contr
4644    
4645    
4646    
4647  Schoenebeck               Expires June 18, 2007                [Page 73]  Schoenebeck             Expires November 25, 2007              [Page 83]
4648    
4649  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
4650    
4651    
4652        "OK" -        "OK" -
# Line 4140  Internet-Draft        LinuxSampler Contr Line 4700  Internet-Draft        LinuxSampler Contr
4700    
4701    
4702    
4703  Schoenebeck               Expires June 18, 2007                [Page 74]  Schoenebeck             Expires November 25, 2007              [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
4706    
4707    
4708        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
# Line 4196  Internet-Draft        LinuxSampler Contr Line 4756  Internet-Draft        LinuxSampler Contr
4756    
4757    
4758    
4759  Schoenebeck               Expires June 18, 2007                [Page 75]  Schoenebeck             Expires November 25, 2007              [Page 85]
4760    
4761  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
4762    
4763    
4764  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
# Line 4235  Internet-Draft        LinuxSampler Contr Line 4795  Internet-Draft        LinuxSampler Contr
4795    
4796        S: "OK"        S: "OK"
4797    
4798    6.8.  Managing Instruments Database
4799    
4800       The following commands describe how to use and manage the instruments
4801       database.
4802    
4803    6.8.1.  Creating a new instrument directory
4804    
4805       The front-end can add a new instrument directory to the instruments
4806       database by sending the following command:
4807    
4808          ADD DB_INSTRUMENT_DIRECTORY <dir>
4809    
4810       Where <dir> is the absolute path name of the directory to be created
4811       (encapsulated into apostrophes).
4812    
4813    
4814    
4815    Schoenebeck             Expires November 25, 2007              [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol             May 2007
4818    
4819    
4820       Possible Answers:
4821    
4822          "OK" -
4823    
4824             on success
4825    
4826          "ERR:<error-code>:<error-message>" -
4827    
4828             when the directory could not be created, which can happen if
4829             the directory already exists or the name contains not allowed
4830             symbols
4831    
4832       Examples:
4833    
4834          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
4835    
4836          S: "OK"
4837    
4838    6.8.2.  Deleting an instrument directory
4839    
4840       The front-end can delete a particular instrument directory from the
4841       instruments database by sending the following command:
4842    
4843          REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4844    
4845       Where <dir> is the absolute path name of the directory to delete.
4846       The optional FORCE argument can be used to force the deletion of a
4847       non-empty directory and all its content.
4848    
4849       Possible Answers:
4850    
4851          "OK" -
4852    
4853             if the directory is deleted successfully
4854    
4855          "ERR:<error-code>:<error-message>" -
4856    
4857             if the given directory does not exist, or if trying to delete a
4858             non-empty directory, without using the FORCE argument.
4859    
4860       Examples:
4861    
4862          C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
4863    
4864          S: "OK"
4865    
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck             Expires November 25, 2007              [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol             May 2007
4874    
4875    
4876    6.8.3.  Getting amount of instrument directories
4877    
4878       The front-end can retrieve the current amount of directories in a
4879       specific directory by sending the following command:
4880    
4881          GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4882    
4883       Where <dir> should be replaced by the absolute path name of the
4884       directory.  If RECURSIVE is specified, the number of all directories,
4885       including those located in subdirectories of the specified directory,
4886       will be returned.
4887    
4888       Possible Answers:
4889    
4890          The current number of instrument directories in the specified
4891          directory.
4892    
4893          "ERR:<error-code>:<error-message>" -
4894    
4895             if the given directory does not exist.
4896    
4897       Example:
4898    
4899          C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4900    
4901          S: "2"
4902    
4903    6.8.4.  Listing all directories in specific directory
4904    
4905       The front-end can retrieve the current list of directories in
4906       specific directory by sending the following command:
4907    
4908          LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4909    
4910       Where <dir> should be replaced by the absolute path name of the
4911       directory.  If RECURSIVE is specified, the absolute path names of all
4912       directories, including those located in subdirectories of the
4913       specified directory, will be returned.
4914    
4915       Possible Answers:
4916    
4917          A comma separated list of all instrument directories (encapsulated
4918          into apostrophes) in the specified directory.
4919    
4920          "ERR:<error-code>:<error-message>" -
4921    
4922             if the given directory does not exist.
4923    
4924    
4925    
4926    
4927    Schoenebeck             Expires November 25, 2007              [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol             May 2007
4930    
4931    
4932       Example:
4933    
4934          C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
4935    
4936          S: "'Piano Collection','Percussion Collection'"
4937    
4938          C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
4939    
4940          S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
4941          Collection/Acoustic/New','/Percussion Collection'"
4942    
4943    6.8.5.  Getting instrument directory information
4944    
4945       The front-end can ask for the current settings of an instrument
4946       directory by sending the following command:
4947    
4948          GET DB_INSTRUMENT_DIRECTORY INFO <dir>
4949    
4950       Where <dir> should be replaced by the absolute path name of the
4951       directory the front-end is interested in.
4952    
4953       Possible Answers:
4954    
4955          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4956          answer line begins with the settings category name followed by a
4957          colon and then a space character <SP> and finally the info
4958          character string to that setting category.  At the moment the
4959          following categories are defined:
4960    
4961    
4962    
4963             DESCRIPTION -
4964    
4965                A brief description of the directory content
4966    
4967             CREATED -
4968    
4969                The creation date and time of the directory, represented in
4970                "YYYY-MM-DD HH:MM:SS" format
4971    
4972             MODIFIED -
4973    
4974                The date and time of the last modification of the directory,
4975                represented in "YYYY-MM-DD HH:MM:SS" format
4976    
4977       The mentioned fields above don't have to be in particular order.
4978    
4979       Example:
4980    
4981    
4982    
4983    Schoenebeck             Expires November 25, 2007              [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol             May 2007
4986    
4987    
4988          C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
4989    
4990          S: "DESCRIPTION: Piano collection of instruments in GigaSampler
4991          format."
4992    
4993             "CREATED: 2007-02-05 10:23:12"
4994    
4995             "MODIFIED: 2007-04-07 12:50:21"
4996    
4997             "."
4998    
4999    6.8.6.  Renaming an instrument directory
5000    
5001       The front-end can alter the name of a specific instrument directory
5002       by sending the following command:
5003    
5004          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5005    
5006       Where <dir> is the absolute path name of the directory and <name> is
5007       the new name for that directory.
5008    
5009       Possible Answers:
5010    
5011          "OK" -
5012    
5013             on success
5014    
5015          "ERR:<error-code>:<error-message>" -
5016    
5017             in case the given directory does not exists, or if a directory
5018             with name equal to the new name already exists.
5019    
5020       Example:
5021    
5022          C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5023          'Acoustic'"
5024    
5025          S: "OK"
5026    
5027    6.8.7.  Moving an instrument directory
5028    
5029       The front-end can move a specific instrument directory by sending the
5030       following command:
5031    
5032          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5033    
5034       Where <dir> is the absolute path name of the directory to move and
5035       <dst> is the location where the directory will be moved to.
5036    
5037    
5038    
5039    Schoenebeck             Expires November 25, 2007              [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol             May 2007
5042    
5043    
5044       Possible Answers:
5045    
5046          "OK" -
5047    
5048             on success
5049    
5050          "ERR:<error-code>:<error-message>" -
5051    
5052             in case a given directory does not exists, or if a directory
5053             with name equal to the name of the specified directory already
5054             exists in the destination directory.  Error is also thrown when
5055             trying to move a directory to a subdirectory of itself.
5056    
5057       Example:
5058    
5059          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5060          Acoustic'"
5061    
5062          S: "OK"
5063    
5064    6.8.8.  Copying instrument directories
5065    
5066       The front-end can copy a specific instrument directory by sending the
5067       following command:
5068    
5069          COPY DB_INSTRUMENT_DIRECTORY <dir> <dst>
5070    
5071       Where <dir> is the absolute path name of the directory to copy and
5072       <dst> is the location where the directory will be copied to.
5073    
5074       Possible Answers:
5075    
5076          "OK" -
5077    
5078             on success
5079    
5080          "ERR:<error-code>:<error-message>" -
5081    
5082             in case a given directory does not exists, or if a directory
5083             with name equal to the name of the specified directory already
5084             exists in the destination directory.  Error is also thrown when
5085             trying to copy a directory to a subdirectory of itself.
5086    
5087       Example:
5088    
5089          C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5090          '/Acoustic/Pianos'"
5091    
5092    
5093    
5094    
5095    Schoenebeck             Expires November 25, 2007              [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol             May 2007
5098    
5099    
5100          S: "OK"
5101    
5102    6.8.9.  Changing the description of directory
5103    
5104       The front-end can alter the description of a specific instrument
5105       directory by sending the following command:
5106    
5107          SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5108    
5109       Where <dir> is the absolute path name of the directory and <desc> is
5110       the new description for the directory.
5111    
5112       Possible Answers:
5113    
5114          "OK" -
5115    
5116             on success
5117    
5118          "ERR:<error-code>:<error-message>" -
5119    
5120             in case the given directory does not exists.
5121    
5122       Example:
5123    
5124          C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5125          collection of piano instruments in various format.'"
5126    
5127          S: "OK"
5128    
5129    6.8.10.  Finding directories
5130    
5131       The front-end can search for directories in specific directory by
5132       sending the following command:
5133    
5134          FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-
5135          list>
5136    
5137       Where <dir> should be replaced by the absolute path name of the
5138       directory to search in.  If NON_RECURSIVE is specified, the
5139       directories located in subdirectories of the specified directory will
5140       not be searched. <criteria-list> is a list of search criterias in
5141       form of "key1=val1 key2=val2 ...".  The following criterias are
5142       allowed:
5143    
5144       NAME='<search-string>'
5145    
5146          Restricts the search to directories, which names satisfy the
5147          supplied search string.
5148    
5149    
5150    
5151    Schoenebeck             Expires November 25, 2007              [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol             May 2007
5154    
5155    
5156       CREATED='[<date-after>]..[<date-before>]'
5157    
5158          Restricts the search to directories, which creation date satisfies
5159          the specified period, where <date-after> and <date-before> are in
5160          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5161          search is restricted to directories created before <date-before>.
5162          If <date-before> is omitted, the search is restricted to
5163          directories created after <date-after>.
5164    
5165       MODIFIED='[<date-after>]..[<date-before>]'
5166    
5167          Restricts the search to directories, which date of last
5168          modification satisfies the specified period, where <date-after>
5169          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5170          after> is omitted the search is restricted to directories, which
5171          are last modified before <date-before>.  If <date-before> is
5172          omitted, the search is restricted to directories, which are last
5173          modified after <date-after>.
5174    
5175       DESCRIPTION='<search-string>'
5176    
5177          Restricts the search to directories with description that
5178          satisfies the supplied search string.
5179    
5180       Where <search-string> is either a regular expression, or a word list
5181       separated with spaces for OR search and with '+' for AND search.
5182    
5183       Possible Answers:
5184    
5185          A comma separated list with the absolute path names (encapsulated
5186          into apostrophes) of all directories in the specified directory
5187          that satisfy the supplied search criterias.
5188    
5189          "ERR:<error-code>:<error-message>" -
5190    
5191             if the given directory does not exist.
5192    
5193       Example:
5194    
5195          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5196    
5197          S: "'/Piano Collection'"
5198    
5199          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5200          30:13'"
5201    
5202          S: "'/Piano Collection','/Percussions'"
5203    
5204    
5205    
5206    
5207    Schoenebeck             Expires November 25, 2007              [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol             May 2007
5210    
5211    
5212    6.8.11.  Adding instruments to the instruments database
5213    
5214       The front-end can add one or more instruments to the instruments
5215       database by sending the following command:
5216    
5217          ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>
5218          [<instr_index>]
5219    
5220       Where <db_dir> is the absolute path name of a directory (encapsulated
5221       into apostrophes) in the instruments database in which only the new
5222       instruments (that are not already in the database) will be added,
5223       <file_path> is the absolute path name of a file or directory in the
5224       file system (encapsulated into apostrophes).  In case an instrument
5225       file is supplied, only the instruments in the specified file will be
5226       added to the instruments database.  If the optional <instr_index>
5227       (the index of the instrument within the given file) is supplied too,
5228       then only the specified instrument will be added.  In case a
5229       directory is supplied, the instruments in that directory will be
5230       added.  The OPTIONAL <mode> argument is only applied when a directory
5231       is provided as <file_path> and specifies how the scanning will be
5232       done and has exactly the following possibilities:
5233    
5234          "RECURSIVE" -
5235    
5236             All instruments will be processed, including those in the
5237             subdirectories, and the respective subdirectory tree structure
5238             will be recreated in the instruments database
5239    
5240          "NON_RECURSIVE" -
5241    
5242             Only the instruments in the specified directory will be added,
5243             the instruments in the subdirectories will not be processed.
5244    
5245          "FLAT" -
5246    
5247             All instruments will be processed, including those in the
5248             subdirectories, but the respective subdirectory structure will
5249             not be recreated in the instruments database.  All instruments
5250             will be added directly in the specified database directory.
5251    
5252       The difference between regular and NON_MODAL versions of the command
5253       is that the regular command returns when the scanning is finished
5254       while NON_MODAL version returns immediately and a background process
5255       is launched.  The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5256       command can be used to monitor the scanning progress.
5257    
5258       Possible Answers:
5259    
5260    
5261    
5262    
5263    Schoenebeck             Expires November 25, 2007              [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol             May 2007
5266    
5267    
5268          "OK" -
5269    
5270             on success when NON_MODAL is not supplied
5271    
5272          "OK[<job-id>]" -
5273    
5274             on success when NON_MODAL is supplied, where <job-id> is a
5275             numerical ID used to obtain status information about the job
5276             progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5277    
5278          "ERR:<error-code>:<error-message>" -
5279    
5280             if an invalid path is specified.
5281    
5282       Examples:
5283    
5284          C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5285          Bosendorfer 290.gig' 0"
5286    
5287          S: "OK"
5288    
5289    6.8.12.  Removing an instrument
5290    
5291       The front-end can remove a particular instrument from the instruments
5292       database by sending the following command:
5293    
5294          REMOVE DB_INSTRUMENT <instr_path>
5295    
5296       Where <instr_path> is the absolute path name (in the instruments
5297       database) of the instrument to remove.
5298    
5299       Possible Answers:
5300    
5301          "OK" -
5302    
5303             if the instrument is removed successfully
5304    
5305          "ERR:<error-code>:<error-message>" -
5306    
5307             if the given path does not exist or is a directory.
5308    
5309       Examples:
5310    
5311          C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
5312    
5313          S: "OK"
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck             Expires November 25, 2007              [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol             May 2007
5322    
5323    
5324    6.8.13.  Getting amount of instruments
5325    
5326       The front-end can retrieve the current amount of instruments in a
5327       specific directory by sending the following command:
5328    
5329          GET DB_INSTRUMENTS [RECURSIVE] <dir>
5330    
5331       Where <dir> should be replaced by the absolute path name of the
5332       directory.  If RECURSIVE is specified, the number of all instruments,
5333       including those located in subdirectories of the specified directory,
5334       will be returned.
5335    
5336       Possible Answers:
5337    
5338          The current number of instruments in the specified directory.
5339    
5340          "ERR:<error-code>:<error-message>" -
5341    
5342             if the given directory does not exist.
5343    
5344       Example:
5345    
5346          C: "GET DB_INSTRUMENTS '/Piano Collection'"
5347    
5348          S: "2"
5349    
5350    6.8.14.  Listing all instruments in specific directory
5351    
5352       The front-end can retrieve the current list of instruments in
5353       specific directory by sending the following command:
5354    
5355          LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5356    
5357       Where <dir> should be replaced by the absolute path name of the
5358       directory.  If RECURSIVE is specified, the absolute path names of all
5359       instruments, including those located in subdirectories of the
5360       specified directory, will be returned.
5361    
5362       Possible Answers:
5363    
5364          A comma separated list of all instruments (encapsulated into
5365          apostrophes) in the specified directory.
5366    
5367          "ERR:<error-code>:<error-message>" -
5368    
5369             if the given directory does not exist.
5370    
5371       Example:
5372    
5373    
5374    
5375    Schoenebeck             Expires November 25, 2007              [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol             May 2007
5378    
5379    
5380          C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5381    
5382          S: "'Bosendorfer 290','Steinway D'"
5383    
5384          C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
5385    
5386          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5387          Steinway D','/Piano Collection/Lite/Free Piano'"
5388    
5389    6.8.15.  Getting instrument information
5390    
5391       The front-end can ask for the current settings of an instrument by
5392       sending the following command:
5393    
5394          GET DB_INSTRUMENT INFO <instr_path>
5395    
5396       Where <instr_path> should be replaced by the absolute path name of
5397       the instrument the front-end is interested in.
5398    
5399       Possible Answers:
5400    
5401          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5402          answer line begins with the settings category name followed by a
5403          colon and then a space character <SP> and finally the info
5404          character string to that setting category.  At the moment the
5405          following categories are defined:
5406    
5407    
5408    
5409             INSTRUMENT_FILE -
5410    
5411                File name of the instrument.
5412    
5413             INSTRUMENT_NR -
5414    
5415                Index of the instrument within the file.
5416    
5417             FORMAT_FAMILY -
5418    
5419                The format family of the instrument.
5420    
5421             FORMAT_VERSION -
5422    
5423                The format version of the instrument.
5424    
5425             SIZE -
5426    
5427    
5428    
5429    
5430    
5431    Schoenebeck             Expires November 25, 2007              [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol             May 2007
5434    
5435    
5436                The size of the instrument in bytes.
5437    
5438             CREATED -
5439    
5440                The date and time when the instrument is added in the
5441                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5442                format
5443    
5444             MODIFIED -
5445    
5446                The date and time of the last modification of the
5447                instrument's database settings, represented in "YYYY-MM-DD
5448                HH:MM:SS" format
5449    
5450             DESCRIPTION -
5451    
5452                A brief description of the instrument
5453    
5454             IS_DRUM -
5455    
5456                either true or false, determines whether the instrument is a
5457                drumkit or a chromatic instrument
5458    
5459             PRODUCT -
5460    
5461                The product title of the instrument
5462    
5463             ARTISTS -
5464    
5465                Lists the artist names
5466    
5467             KEYWORDS -
5468    
5469                Provides a list of keywords that refer to the instrument.
5470                Keywords are separated with semicolon and blank.
5471    
5472       The mentioned fields above don't have to be in particular order.
5473    
5474       Example:
5475    
5476          C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
5477    
5478          S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
5479    
5480             "INSTRUMENT_NR: 0"
5481    
5482             "FORMAT_FAMILY: GIG"
5483    
5484    
5485    
5486    
5487    Schoenebeck             Expires November 25, 2007              [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol             May 2007
5490    
5491    
5492             "FORMAT_VERSION: 2"
5493    
5494             "SIZE: 2050871870"
5495    
5496             "CREATED: 2007-02-05 10:23:12"
5497    
5498             "MODIFIED: 2007-04-07 12:50:21"
5499    
5500             "DESCRIPTION: "
5501    
5502             "IS_DRUM: false"
5503    
5504             "PRODUCT: GRANDIOSO Bosendorfer 290"
5505    
5506             "ARTISTS: Post Musical Instruments"
5507    
5508             "KEYWORDS: Bosendorfer"
5509    
5510             "."
5511    
5512    6.8.16.  Renaming an instrument
5513    
5514       The front-end can alter the name of a specific instrument by sending
5515       the following command:
5516    
5517          SET DB_INSTRUMENT NAME <instr> <name>
5518    
5519       Where <instr> is the absolute path name of the instrument and <name>
5520       is the new name for that instrument.
5521    
5522       Possible Answers:
5523    
5524          "OK" -
5525    
5526             on success
5527    
5528          "ERR:<error-code>:<error-message>" -
5529    
5530             in case the given instrument does not exists, or if an
5531             instrument with name equal to the new name already exists.
5532    
5533       Example:
5534    
5535          C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
5536          'Bosendorfer 290'"
5537    
5538          S: "OK"
5539    
5540    
5541    
5542    
5543    Schoenebeck             Expires November 25, 2007              [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol             May 2007
5546    
5547    
5548    6.8.17.  Moving an instrument
5549    
5550       The front-end can move a specific instrument to another directory by
5551       sending the following command:
5552    
5553          MOVE DB_INSTRUMENT <instr> <dst>
5554    
5555       Where <instr> is the absolute path name of the instrument to move and
5556       <dst> is the directory where the instrument will be moved to.
5557    
5558       Possible Answers:
5559    
5560          "OK" -
5561    
5562             on success
5563    
5564          "ERR:<error-code>:<error-message>" -
5565    
5566             in case the given instrument does not exists, or if an
5567             instrument with name equal to the name of the specified
5568             instrument already exists in the destination directory.
5569    
5570       Example:
5571    
5572          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
5573          Collection/Acoustic'"
5574    
5575          S: "OK"
5576    
5577    6.8.18.  Copying instruments
5578    
5579       The front-end can copy a specific instrument to another directory by
5580       sending the following command:
5581    
5582          COPY DB_INSTRUMENT <instr> <dst>
5583    
5584       Where <instr> is the absolute path name of the instrument to copy and
5585       <dst> is the directory where the instrument will be copied to.
5586    
5587       Possible Answers:
5588    
5589          "OK" -
5590    
5591             on success
5592    
5593          "ERR:<error-code>:<error-message>" -
5594    
5595    
5596    
5597    
5598    
5599  Schoenebeck               Expires June 18, 2007                [Page 76]  Schoenebeck             Expires November 25, 2007             [Page 100]
5600    
5601  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
5602    
5603    
5604             in case the given instrument does not exists, or if an
5605             instrument with name equal to the name of the specified
5606             instrument already exists in the destination directory.
5607    
5608       Example:
5609    
5610          C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
5611          '/Acoustic/Pianos/'"
5612    
5613          S: "OK"
5614    
5615    6.8.19.  Changing the description of instrument
5616    
5617       The front-end can alter the description of a specific instrument by
5618       sending the following command:
5619    
5620          SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5621    
5622       Where <instr> is the absolute path name of the instrument and <desc>
5623       is the new description for the instrument.
5624    
5625       Possible Answers:
5626    
5627          "OK" -
5628    
5629             on success
5630    
5631          "ERR:<error-code>:<error-message>" -
5632    
5633             in case the given instrument does not exists.
5634    
5635       Example:
5636    
5637          C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
5638          Bosendorfer 290' 'No comment :)'"
5639    
5640          S: "OK"
5641    
5642    6.8.20.  Finding instruments
5643    
5644       The front-end can search for instruments in specific directory by
5645       sending the following command:
5646    
5647          FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5648    
5649       Where <dir> should be replaced by the absolute path name of the
5650       directory to search in.  If NON_RECURSIVE is specified, the
5651       directories located in subdirectories of the specified directory will
5652    
5653    
5654    
5655    Schoenebeck             Expires November 25, 2007             [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol             May 2007
5658    
5659    
5660       not be searched. <criteria-list> is a list of search criterias in
5661       form of "key1=val1 key2=val2 ...".  The following criterias are
5662       allowed:
5663    
5664       NAME='<search-string>'
5665    
5666          Restricts the search to instruments, which names satisfy the
5667          supplied search string.
5668    
5669       SIZE=[<min>]..[<max>]
5670    
5671          Restricts the search to instruments, which size is in the
5672          specified range.  If <min> is omitted, the search results are
5673          restricted to instruments with size less then or equal to <max>.
5674          If <max> is omitted, the search is restricted to instruments with
5675          size greater then or equal to <min>.
5676    
5677       CREATED='[<date-after>]..[<date-before>]'
5678    
5679          Restricts the search to instruments, which creation date satisfies
5680          the specified period, where <date-after> and <date-before> are in
5681          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5682          search is restricted to instruments created before <date-before>.
5683          If <date-before> is omitted, the search is restricted to
5684          instruments created after <date-after>.
5685    
5686       MODIFIED='[<date-after>]..[<date-before>]'
5687    
5688          Restricts the search to instruments, which date of last
5689          modification satisfies the specified period, where <date-after>
5690          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5691          after> is omitted the search is restricted to instruments, which
5692          are last modified before <date-before>.  If <date-before> is
5693          omitted, the search is restricted to instruments, which are last
5694          modified after <date-after>.
5695    
5696       DESCRIPTION='<search-string>'
5697    
5698          Restricts the search to instruments with description that
5699          satisfies the supplied search string.
5700    
5701       PRODUCT='<search-string>'
5702    
5703          Restricts the search to instruments with product info that
5704          satisfies the supplied search string.
5705    
5706       ARTISTS='<search-string>'
5707    
5708    
5709    
5710    
5711    Schoenebeck             Expires November 25, 2007             [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol             May 2007
5714    
5715    
5716          Restricts the search to instruments with artists info that
5717          satisfies the supplied search string.
5718    
5719       KEYWORDS='<search-string>'
5720    
5721          Restricts the search to instruments with keyword list that
5722          satisfies the supplied search string.
5723    
5724       IS_DRUM=true | false
5725    
5726          Either true or false.  Restricts the search to drum kits or
5727          chromatic instruments.
5728    
5729       FORMAT_FAMILIES='<format-list>'
5730    
5731          Restricts the search to instruments of the supplied format
5732          families, where <format-list> is a comma separated list of format
5733          families.
5734    
5735       Where <search-string> is either a regular expression, or a word list
5736       separated with spaces for OR search and with '+' for AND search.
5737    
5738       Possible Answers:
5739    
5740          A comma separated list with the absolute path names (encapsulated
5741          into apostrophes) of all instruments in the specified directory
5742          that satisfy the supplied search criterias.
5743    
5744          "ERR:<error-code>:<error-message>" -
5745    
5746             if the given directory does not exist.
5747    
5748       Example:
5749    
5750          C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5751          290'"
5752    
5753          S: "'/Piano Collection/Bosendorfer 290'"
5754    
5755          C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
5756          09:30:13..'"
5757    
5758          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5759          Steinway D'"
5760    
5761    
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck             Expires November 25, 2007             [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol             May 2007
5770    
5771    
5772    6.8.21.  Getting job status information
5773    
5774       The front-end can ask for the current status of a particular database
5775       instruments job by sending the following command:
5776    
5777          GET DB_INSTRUMENTS_JOB INFO <job-id>
5778    
5779       Where <job-id> should be replaced by the numerical ID of the job the
5780       front-end is interested in.
5781    
5782       Possible Answers:
5783    
5784          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5785          answer line begins with the settings category name followed by a
5786          colon and then a space character <SP> and finally the info
5787          character string to that setting category.  At the moment the
5788          following categories are defined:
5789    
5790    
5791    
5792             FILES_TOTAL -
5793    
5794                The total number of files scheduled for scanning
5795    
5796             FILES_SCANNED -
5797    
5798                The current number of scanned files
5799    
5800             SCANNING -
5801    
5802                The absolute path name of the file which is currently being
5803                scanned
5804    
5805             STATUS -
5806    
5807                An integer value between 0 and 100 indicating the scanning
5808                progress percentage of the file which is currently being
5809                scanned
5810    
5811       The mentioned fields above don't have to be in particular order.
5812    
5813       Example:
5814    
5815          C: "GET DB_INSTRUMENTS_JOB INFO 2"
5816    
5817          S: "FILES_TOTAL: 12"
5818    
5819    
5820    
5821    
5822    
5823    Schoenebeck             Expires November 25, 2007             [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol             May 2007
5826    
5827    
5828             "FILES_SCANNED: 7"
5829    
5830             "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
5831    
5832             "STATUS: 42"
5833    
5834             "."
5835    
5836    
5837    
5838    
5839    
5840    
5841    
5842    
5843    
5844    
5845    
5846    
5847    
5848    
5849    
5850    
5851    
5852    
5853    
5854    
5855    
5856    
5857    
5858    
5859    
5860    
5861    
5862    
5863    
5864    
5865    
5866    
5867    
5868    
5869    
5870    
5871    
5872    
5873    
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck             Expires November 25, 2007             [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol             May 2007
5882    
5883    
5884  7.  Command Syntax  7.  Command Syntax
# Line 4308  Internet-Draft        LinuxSampler Contr Line 5932  Internet-Draft        LinuxSampler Contr
5932    
5933    
5934    
5935  Schoenebeck               Expires June 18, 2007                [Page 77]  Schoenebeck             Expires November 25, 2007             [Page 106]
5936    
5937  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
5938    
5939    
5940        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4325  Internet-Draft        LinuxSampler Contr Line 5949  Internet-Draft        LinuxSampler Contr
5949    
5950        / UNSUBSCRIBE SP unsubscribe_event        / UNSUBSCRIBE SP unsubscribe_event
5951    
       / SELECT SP text  
   
5952        / RESET SP reset_instruction        / RESET SP reset_instruction
5953    
5954        / CLEAR SP clear_instruction        / CLEAR SP clear_instruction
5955    
5956          / FIND SP find_instruction
5957    
5958          / MOVE SP move_instruction
5959    
5960          / COPY SP copy_instruction
5961    
5962        / RESET        / RESET
5963    
5964        / QUIT        / QUIT
# Line 4339  Internet-Draft        LinuxSampler Contr Line 5967  Internet-Draft        LinuxSampler Contr
5967    
5968        CHANNEL        CHANNEL
5969    
5970          / DB_INSTRUMENT_DIRECTORY SP pathname
5971    
5972          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname
5973    
5974          / DB_INSTRUMENTS SP scan_mode SP pathname SP pathname
5975    
5976          / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname
5977    
5978          / DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP
5979          instrument_index
5980    
5981          / DB_INSTRUMENTS SP pathname SP pathname
5982    
5983          / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5984    
5985        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck             Expires November 25, 2007             [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol             May 2007
5994    
5995    
5996        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
5997    
5998     subscribe_event =     subscribe_event =
5999    
6000        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
6001    
6002          / AUDIO_OUTPUT_DEVICE_INFO
6003    
6004          / MIDI_INPUT_DEVICE_COUNT
6005    
6006          / MIDI_INPUT_DEVICE_INFO
6007    
6008          / CHANNEL_COUNT
6009    
6010        / VOICE_COUNT        / VOICE_COUNT
6011    
# Line 4355  Internet-Draft        LinuxSampler Contr Line 6015  Internet-Draft        LinuxSampler Contr
6015    
6016        / CHANNEL_INFO        / CHANNEL_INFO
6017    
6018          / FX_SEND_COUNT
6019    
6020          / FX_SEND_INFO
6021    
6022          / MIDI_INSTRUMENT_MAP_COUNT
6023    
6024          / MIDI_INSTRUMENT_MAP_INFO
6025    
6026          / MIDI_INSTRUMENT_COUNT
6027    
6028          / MIDI_INSTRUMENT_INFO
6029    
6030          / DB_INSTRUMENT_DIRECTORY_COUNT
6031    
6032          / DB_INSTRUMENT_DIRECTORY_INFO
6033    
6034          / DB_INSTRUMENT_COUNT
6035    
6036          / DB_INSTRUMENT_INFO
6037    
6038          / DB_INSTRUMENTS_JOB_INFO
6039    
6040        / MISCELLANEOUS        / MISCELLANEOUS
6041    
6042        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6043    
    unsubscribe_event =  
   
6044    
6045    
6046    
6047  Schoenebeck               Expires June 18, 2007                [Page 78]  Schoenebeck             Expires November 25, 2007             [Page 108]
6048    
6049  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
6050    
6051    
6052          / GLOBAL_INFO
6053    
6054       unsubscribe_event =
6055    
6056          AUDIO_OUTPUT_DEVICE_COUNT
6057    
6058          / AUDIO_OUTPUT_DEVICE_INFO
6059    
6060        CHANNEL_COUNT        / MIDI_INPUT_DEVICE_COUNT
6061    
6062          / MIDI_INPUT_DEVICE_INFO
6063    
6064          / CHANNEL_COUNT
6065    
6066        / VOICE_COUNT        / VOICE_COUNT
6067    
# Line 4379  Internet-Draft        LinuxSampler Contr Line 6071  Internet-Draft        LinuxSampler Contr
6071    
6072        / CHANNEL_INFO        / CHANNEL_INFO
6073    
6074          / FX_SEND_COUNT
6075    
6076          / FX_SEND_INFO
6077    
6078          / MIDI_INSTRUMENT_MAP_COUNT
6079    
6080          / MIDI_INSTRUMENT_MAP_INFO
6081    
6082          / MIDI_INSTRUMENT_COUNT
6083    
6084          / MIDI_INSTRUMENT_INFO
6085    
6086          / DB_INSTRUMENT_DIRECTORY_COUNT
6087    
6088          / DB_INSTRUMENT_DIRECTORY_INFO
6089    
6090          / DB_INSTRUMENT_COUNT
6091    
6092          / DB_INSTRUMENT_INFO
6093    
6094          / DB_INSTRUMENTS_JOB_INFO
6095    
6096        / MISCELLANEOUS        / MISCELLANEOUS
6097    
6098        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6099    
6100    
6101    
6102    
6103    Schoenebeck             Expires November 25, 2007             [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol             May 2007
6106    
6107    
6108          / GLOBAL_INFO
6109    
6110     map_instruction =     map_instruction =
6111    
6112        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
6113        engine_name SP filename SP instrument_index SP volume_value        engine_name SP filename SP instrument_index SP volume_value
6114    
6115        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6116        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
6117        instr_load_mode        instr_load_mode
6118    
6119        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6120        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
6121        entry_name        entry_name
6122    
6123        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6124        engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
6125        instr_load_mode SP entry_name        instr_load_mode SP entry_name
6126    
6127     unmap_instruction =     unmap_instruction =
# Line 4412  Internet-Draft        LinuxSampler Contr Line 6136  Internet-Draft        LinuxSampler Contr
6136    
6137        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6138    
6139          / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
6140    
6141          / DB_INSTRUMENT_DIRECTORY SP pathname
6142    
6143          / DB_INSTRUMENT SP pathname
6144    
6145     get_instruction =     get_instruction =
6146    
6147        AVAILABLE_ENGINES        AVAILABLE_ENGINES
6148    
6149          / AVAILABLE_MIDI_INPUT_DRIVERS
6150    
6151          / MIDI_INPUT_DRIVER SP INFO SP string
6152    
6153          / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6154    
6155    
 Schoenebeck               Expires June 18, 2007                [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
6156    
6157    
       / AVAILABLE_MIDI_INPUT_DRIVERS  
6158    
6159        / MIDI_INPUT_DRIVER SP INFO SP string  Schoenebeck             Expires November 25, 2007             [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol             May 2007
6162    
       / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string  
6163    
6164        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6165        key_val_list        key_val_list
# Line 4472  Internet-Draft        LinuxSampler Contr Line 6202  Internet-Draft        LinuxSampler Contr
6202    
6203        / ENGINE SP INFO SP engine_name        / ENGINE SP INFO SP engine_name
6204    
6205          / SERVER SP INFO
6206    
6207          / TOTAL_VOICE_COUNT
6208    
6209          / TOTAL_VOICE_COUNT_MAX
6210    
6211    
 Schoenebeck               Expires June 18, 2007                [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
6212    
6213    
       / SERVER SP INFO  
6214    
6215        / TOTAL_VOICE_COUNT  Schoenebeck             Expires November 25, 2007             [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol             May 2007
6218    
       / TOTAL_VOICE_COUNT_MAX  
6219    
6220        / MIDI_INSTRUMENTS SP midi_map        / MIDI_INSTRUMENTS SP midi_map
6221    
# Line 4497  Internet-Draft        LinuxSampler Contr Line 6227  Internet-Draft        LinuxSampler Contr
6227    
6228        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6229    
6230          / FX_SENDS SP sampler_channel
6231    
6232          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6233    
6234          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6235    
6236          / DB_INSTRUMENT_DIRECTORIES SP pathname
6237    
6238          / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
6239    
6240          / DB_INSTRUMENTS SP RECURSIVE SP pathname
6241    
6242          / DB_INSTRUMENTS SP pathname
6243    
6244          / DB_INSTRUMENT SP INFO SP pathname
6245    
6246          / DB_INSTRUMENTS_JOB SP INFO SP number
6247    
6248          / VOLUME
6249    
6250     set_instruction =     set_instruction =
6251    
6252        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
# Line 4515  Internet-Draft        LinuxSampler Contr Line 6265  Internet-Draft        LinuxSampler Contr
6265    
6266        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6267    
6268    
6269    
6270    
6271    Schoenebeck             Expires November 25, 2007             [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol             May 2007
6274    
6275    
6276          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6277    
6278          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
6279          SP audio_channel_index SP audio_channel_index
6280    
6281          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
6282          midi_ctrl
6283    
6284          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6285          volume_value
6286    
6287          / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
6288    
6289          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
6290    
6291          / DB_INSTRUMENT SP NAME SP pathname SP dirname
6292    
6293          / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
6294    
6295        / ECHO SP boolean        / ECHO SP boolean
6296    
6297          / VOLUME SP volume_value
6298    
6299     create_instruction =     create_instruction =
6300    
6301        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 4527  Internet-Draft        LinuxSampler Contr Line 6306  Internet-Draft        LinuxSampler Contr
6306    
6307        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
6308    
6309          / FX_SEND SP sampler_channel SP midi_ctrl
6310    
6311          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6312    
6313     reset_instruction =     reset_instruction =
6314    
6315          CHANNEL SP sampler_channel
6316    
6317       clear_instruction =
6318    
6319          MIDI_INSTRUMENTS SP midi_map
6320    
6321          / MIDI_INSTRUMENTS SP ALL
6322    
6323  Schoenebeck               Expires June 18, 2007                [Page 81]     find_instruction =
6324    
6325    
6326    
6327    Schoenebeck             Expires November 25, 2007             [Page 113]
6328    
6329  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
6330    
6331    
6332        CHANNEL SP sampler_channel        DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
6333    
6334     clear_instruction =        / DB_INSTRUMENTS SP pathname SP query_val_list
6335    
6336        MIDI_INSTRUMENTS SP midi_map        / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP
6337          query_val_list
6338    
6339        / MIDI_INSTRUMENTS SP ALL        / DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
6340    
6341       move_instruction =
6342    
6343          DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6344    
6345          / DB_INSTRUMENT SP pathname SP pathname
6346    
6347       copy_instruction =
6348    
6349          DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6350    
6351          / DB_INSTRUMENT SP pathname SP pathname
6352    
6353     destroy_instruction =     destroy_instruction =
6354    
# Line 4551  Internet-Draft        LinuxSampler Contr Line 6356  Internet-Draft        LinuxSampler Contr
6356    
6357        / MIDI_INPUT_DEVICE SP number        / MIDI_INPUT_DEVICE SP number
6358    
6359          / FX_SEND SP sampler_channel SP fx_send_id
6360    
6361     load_instruction =     load_instruction =
6362    
6363        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
# Line 4569  Internet-Draft        LinuxSampler Contr Line 6376  Internet-Draft        LinuxSampler Contr
6376        / MIDI_INPUT SP sampler_channel SP device_index SP        / MIDI_INPUT SP sampler_channel SP device_index SP
6377        midi_input_port_index SP midi_input_channel_index        midi_input_port_index SP midi_input_channel_index
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck             Expires November 25, 2007             [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol             May 2007
6386    
6387    
6388        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
6389    
6390        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
# Line 4584  Internet-Draft        LinuxSampler Contr Line 6400  Internet-Draft        LinuxSampler Contr
6400    
6401        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
6402    
   
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
6403        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map        / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6404    
6405        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6406    
6407        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6408    
6409       modal_arg =
6410    
6411          /* epsilon (empty argument) */
6412    
6413          / NON_MODAL SP
6414    
6415     key_val_list =     key_val_list =
6416    
6417        string '=' param_val_list        string '=' param_val_list
# Line 4619  Internet-Draft        LinuxSampler Contr Line 6432  Internet-Draft        LinuxSampler Contr
6432    
6433        / CHANNELS        / CHANNELS
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck             Expires November 25, 2007             [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol             May 2007
6442    
6443    
6444        / AVAILABLE_ENGINES        / AVAILABLE_ENGINES
6445    
6446        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
# Line 4631  Internet-Draft        LinuxSampler Contr Line 6453  Internet-Draft        LinuxSampler Contr
6453    
6454        / MIDI_INSTRUMENT_MAPS        / MIDI_INSTRUMENT_MAPS
6455    
6456     load_instr_args =        / FX_SENDS SP sampler_channel
6457    
6458        filename SP instrument_index SP sampler_channel        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6459    
6460        / NON_MODAL SP filename SP instrument_index SP sampler_channel        / DB_INSTRUMENT_DIRECTORIES SP pathname
6461    
6462     load_engine_args =        / DB_INSTRUMENTS SP RECURSIVE SP pathname
6463    
6464        engine_name SP sampler_channel        / DB_INSTRUMENTS SP pathname
6465    
6466       load_instr_args =
6467    
6468          filename SP instrument_index SP sampler_channel
6469    
6470          / NON_MODAL SP filename SP instrument_index SP sampler_channel
6471    
6472  Schoenebeck               Expires June 18, 2007                [Page 83]     load_engine_args =
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
6473    
6474          engine_name SP sampler_channel
6475    
6476     instr_load_mode =     instr_load_mode =
6477    
# Line 4665  Internet-Draft        LinuxSampler Contr Line 6489  Internet-Draft        LinuxSampler Contr
6489    
6490        number        number
6491    
6492    
6493    
6494    
6495    Schoenebeck             Expires November 25, 2007             [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol             May 2007
6498    
6499    
6500     audio_output_type_name =     audio_output_type_name =
6501    
6502        string        string
# Line 4695  Internet-Draft        LinuxSampler Contr Line 6527  Internet-Draft        LinuxSampler Contr
6527    
6528        number        number
6529    
6530     volume_value =     midi_ctrl =
   
   
   
6531    
6532  Schoenebeck               Expires June 18, 2007                [Page 84]        number
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
6533    
6534       volume_value =
6535    
6536        dotnum        dotnum
6537    
# Line 4717  Internet-Draft        LinuxSampler Contr Line 6545  Internet-Draft        LinuxSampler Contr
6545    
6546        number        number
6547    
6548    
6549    
6550    
6551    Schoenebeck             Expires November 25, 2007             [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol             May 2007
6554    
6555    
6556       fx_send_id =
6557    
6558          number
6559    
6560     engine_name =     engine_name =
6561    
6562        string        string
6563    
6564       pathname =
6565    
6566          stringval
6567    
6568       dirname =
6569    
6570          stringval
6571    
6572     filename =     filename =
6573    
6574        stringval        stringval
# Line 4733  Internet-Draft        LinuxSampler Contr Line 6581  Internet-Draft        LinuxSampler Contr
6581    
6582        stringval        stringval
6583    
6584       fx_send_name =
6585    
6586          stringval
6587    
6588     param_val_list =     param_val_list =
6589    
6590        param_val        param_val
# Line 4752  Internet-Draft        LinuxSampler Contr Line 6604  Internet-Draft        LinuxSampler Contr
6604    
6605    
6606    
6607    Schoenebeck             Expires November 25, 2007             [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol             May 2007
6610    
6611    
6612       query_val_list =
6613    
6614          string '=' query_val
6615    
6616          / query_val_list SP string '=' query_val
6617    
6618       query_val =
6619    
6620          string
6621    
6622          / stringval
6623    
6624       scan_mode =
6625    
6626          RECURSIVE
6627    
6628          / NON_RECURSIVE
6629    
6630          / FLAT
6631    
6632    
6633    
6634    
6635    
6636    
6637    
6638    
6639    
6640    
6641    
6642    
6643    
6644    
6645    
6646    
6647    
6648    
6649    
6650    
6651    
6652    
6653    
6654    
6655    
6656    
6657    
6658  Schoenebeck               Expires June 18, 2007                [Page 85]  
6659    
6660    
6661    
6662    
6663    Schoenebeck             Expires November 25, 2007             [Page 119]
6664    
6665  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
6666    
6667    
6668  8.  Events  8.  Events
# Line 4766  Internet-Draft        LinuxSampler Contr Line 6670  Internet-Draft        LinuxSampler Contr
6670     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
6671     LinuxSampler.     LinuxSampler.
6672    
6673  8.1.  Number of sampler channels changed  8.1.  Number of audio output devices changed
6674    
6675       Client may want to be notified when the total number of audio output
6676       devices on the back-end changes by issuing the following command:
6677    
6678          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
6679    
6680       Server will start sending the following notification messages:
6681    
6682          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
6683    
6684       where <devices> will be replaced by the new number of audio output
6685       devices.
6686    
6687    8.2.  Audio output device's settings changed
6688    
6689       Client may want to be notified when changes were made to audio output
6690       devices on the back-end by issuing the following command:
6691    
6692          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
6693    
6694       Server will start sending the following notification messages:
6695    
6696          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
6697    
6698       where <device-id> will be replaced by the numerical ID of the audio
6699       output device, which settings has been changed.  The front-end will
6700       have to send the respective command to actually get the audio output
6701       device info.  Because these messages will be triggered by LSCP
6702       commands issued by other clients rather than real time events
6703       happening on the server, it is believed that an empty notification
6704       message is sufficient here.
6705    
6706    8.3.  Number of MIDI input devices changed
6707    
6708       Client may want to be notified when the total number of MIDI input
6709       devices on the back-end changes by issuing the following command:
6710    
6711          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
6712    
6713       Server will start sending the following notification messages:
6714    
6715    
6716    
6717    
6718    
6719    Schoenebeck             Expires November 25, 2007             [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol             May 2007
6722    
6723    
6724          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
6725    
6726       where <devices> will be replaced by the new number of MIDI input
6727       devices.
6728    
6729    8.4.  MIDI input device's settings changed
6730    
6731       Client may want to be notified when changes were made to MIDI input
6732       devices on the back-end by issuing the following command:
6733    
6734          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
6735    
6736       Server will start sending the following notification messages:
6737    
6738          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
6739    
6740       where <device-id> will be replaced by the numerical ID of the MIDI
6741       input device, which settings has been changed.  The front-end will
6742       have to send the respective command to actually get the MIDI input
6743       device info.  Because these messages will be triggered by LSCP
6744       commands issued by other clients rather than real time events
6745       happening on the server, it is believed that an empty notification
6746       message is sufficient here.
6747    
6748    8.5.  Number of sampler channels changed
6749    
6750     Client may want to be notified when the total number of channels on     Client may want to be notified when the total number of channels on
6751     the back-end changes by issuing the following command:     the back-end changes by issuing the following command:
# Line 4780  Internet-Draft        LinuxSampler Contr Line 6759  Internet-Draft        LinuxSampler Contr
6759     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
6760     channels.     channels.
6761    
6762  8.2.  Number of active voices changed  8.6.  Number of active voices changed
6763    
6764     Client may want to be notified when the number of voices on the back-     Client may want to be notified when the number of voices on the back-
6765     end changes by issuing the following command:     end changes by issuing the following command:
# Line 4789  Internet-Draft        LinuxSampler Contr Line 6768  Internet-Draft        LinuxSampler Contr
6768    
6769     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6770    
6771        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>  
6772    
6773    
6774    
6775    Schoenebeck             Expires November 25, 2007             [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol             May 2007
6778    
6779    
6780          "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
6781    
6782     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6783     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
6784     voices on that channel.     voices on that channel.
6785    
6786  8.3.  Number of active disk streams changed  8.7.  Number of active disk streams changed
6787    
6788     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
6789     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 4809  Internet-Draft        LinuxSampler Contr Line 6797  Internet-Draft        LinuxSampler Contr
6797    
6798     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6799     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
6800     active disk streams on that channel.     active disk streams on that channel.
6801    
6802  8.4.  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
6803    
6804     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
6805     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 4836  Internet-Draft        LinuxSampler Contr Line 6816  Internet-Draft        LinuxSampler Contr
6816     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
6817     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
6818    
6819  8.5.  Channel information changed  8.9.  Channel information changed
6820    
6821     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
6822     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
# Line 4845  Internet-Draft        LinuxSampler Contr Line 6825  Internet-Draft        LinuxSampler Contr
6825    
6826     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6827    
6828    
6829    
6830    
6831    Schoenebeck             Expires November 25, 2007             [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol             May 2007
6834    
6835    
6836        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
6837    
6838     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
# Line 4854  Internet-Draft        LinuxSampler Contr Line 6842  Internet-Draft        LinuxSampler Contr
6842     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
6843     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
6844    
6845  8.6.  Total number of active voices changed  8.10.  Number of effect sends changed
6846    
6847       Client may want to be notified when the number of effect sends on a
6848       particular sampler channel is changed by issuing the following
6849       command:
6850    
6851          SUBSCRIBE FX_SEND_COUNT
6852    
6853       Server will start sending the following notification messages:
6854    
6855          "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
6856    
6857       where <channel-id> will be replaced by the numerical ID of the
6858       sampler channel, on which the effect sends number is changed and <fx-
6859       sends> will be replaced by the new number of effect sends on that
6860       channel.
6861    
6862    8.11.  Effect send information changed
6863    
6864       Client may want to be notified when changes were made to effect sends
6865       on a a particular sampler channel by issuing the following command:
6866    
6867          SUBSCRIBE FX_SEND_INFO
6868    
6869       Server will start sending the following notification messages:
6870    
6871          "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
6872    
6873       where <channel-id> will be replaced by the numerical ID of the
6874       sampler channel, on which an effect send entity is changed and <fx-
6875       send-id> will be replaced by the numerical ID of the changed effect
6876       send.
6877    
6878    8.12.  Total number of active voices changed
6879    
6880     Client may want to be notified when the total number of voices on the     Client may want to be notified when the total number of voices on the
6881     back-end changes by issuing the following command:     back-end changes by issuing the following command:
6882    
6883    
6884    
6885    
6886    
6887    Schoenebeck             Expires November 25, 2007             [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol             May 2007
6890    
6891    
6892        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
6893    
6894     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6895    
6896          "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
6897    
6898       where <voices> will be replaced by the new number of all currently
6899       active voices.
6900    
6901    8.13.  Number of MIDI instrument maps changed
6902    
6903       Client may want to be notified when the number of MIDI instrument
6904       maps on the back-end changes by issuing the following command:
6905    
6906          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
6907    
6908       Server will start sending the following notification messages:
6909    
6910          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
6911    
6912       where <maps> will be replaced by the new number of MIDI instrument
6913       maps.
6914    
6915    8.14.  MIDI instrument map information changed
6916    
6917       Client may want to be notified when changes were made to MIDI
6918       instrument maps on the back-end by issuing the following command:
6919    
6920          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
6921    
6922       Server will start sending the following notification messages:
6923    
6924          "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
6925    
6926  Schoenebeck               Expires June 18, 2007                [Page 87]     where <map-id> will be replaced by the numerical ID of the MIDI
6927       instrument map, for which information changes occurred.  The front-
6928       end will have to send the respective command to actually get the MIDI
6929       instrument map info.  Because these messages will be triggered by
6930       LSCP commands issued by other clients rather than real time events
6931       happening on the server, it is believed that an empty notification
6932       message is sufficient here.
6933    
6934    8.15.  Number of MIDI instruments changed
6935    
6936       Client may want to be notified when the number of MIDI instrument
6937       maps on the back-end changes by issuing the following command:
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck             Expires November 25, 2007             [Page 124]
6944    
6945  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
6946    
6947    
6948        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        SUBSCRIBE MIDI_INSTRUMENT_COUNT
6949    
6950     where <voices> will be replaced by the new number of all currently     Server will start sending the following notification messages:
    active voices.  
6951    
6952  8.7.  Miscellaneous and debugging events        "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
6953    
6954     Client may want to be notified of miscellaneous and debugging events     where <map-id> is the numerical ID of the MIDI instrument map, in
6955     occurring at the server by issuing the following command:     which the nuber of instruments has changed and <instruments> will be
6956       replaced by the new number of MIDI instruments in the specified map.
6957    
6958        SUBSCRIBE MISCELLANEOUS  8.16.  MIDI instrument information changed
6959    
6960       Client may want to be notified when changes were made to MIDI
6961       instruments on the back-end by issuing the following command:
6962    
6963          SUBSCRIBE MIDI_INSTRUMENT_INFO
6964    
6965     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6966    
6967        "NOTIFY:MISCELLANEOUS:<string>"        "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
6968    
6969     where <string> will be replaced by whatever data server wants to send     where <map-id> will be replaced by the numerical ID of the MIDI
6970     to the client.  Client MAY display this data to the user AS IS to     instrument map, in which a MIDI instrument is changed. <bank> and
6971     facilitate debugging.     <program> specifies the location of the changed MIDI instrument in
6972       the map.  The front-end will have to send the respective command to
6973       actually get the MIDI instrument info.  Because these messages will
6974       be triggered by LSCP commands issued by other clients rather than
6975       real time events happening on the server, it is believed that an
6976       empty notification message is sufficient here.
6977    
6978    8.17.  Global settings changed
6979    
6980       Client may want to be notified when changes to the global settings of
6981       the sampler were made by issuing the following command:
6982    
6983          SUBSCRIBE GLOBAL_INFO
6984    
6985       Server will start sending the following types of notification
6986       messages:
6987    
6988          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
6989          volume of the sampler is changed, where <volume> will be replaced
6990          by the optional dotted floating point value, reflecting the new
6991          global volume parameter.
6992    
6993    
6994    
# Line 4902  Internet-Draft        LinuxSampler Contr Line 6996  Internet-Draft        LinuxSampler Contr
6996    
6997    
6998    
6999    Schoenebeck             Expires November 25, 2007             [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol             May 2007
7002    
7003    
7004    8.18.  Number of database instrument directories changed
7005    
7006       Client may want to be notified when the number of instrument
7007       directories in a particular directory in the instruments database is
7008       changed by issuing the following command:
7009    
7010          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
7011    
7012       Server will start sending the following notification messages:
7013    
7014          "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
7015    
7016       where <dir-path> will be replaced by the absolute path name of the
7017       directory in the instruments database, in which the number of
7018       directories is changed.
7019    
7020       Note that when a non-empty directory is removed, this event is not
7021       sent for the subdirectories in that directory.
7022    
7023    8.19.  Database instrument directory information changed
7024    
7025       Client may want to be notified when changes were made to directories
7026       in the instruments database by issuing the following command:
7027    
7028          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
7029    
7030       Server will start sending the following notification messages:
7031    
7032          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
7033    
7034       where <dir-path> will be replaced by the absolute path name of the
7035       directory, for which information changes occurred.  The front-end
7036       will have to send the respective command to actually get the updated
7037       directory info.  Because these messages will be triggered by LSCP
7038       commands issued by other clients rather than real time events
7039       happening on the server, it is believed that an empty notification
7040       message is sufficient here.
7041    
7042          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
7043          name>"
7044    
7045       where <old-dir-path> is the old absolute path name of the directory
7046       (encapsulated into apostrophes), which name is changes and <new-name>
7047       is the new name of the directory, encapsulated into apostrophes.
7048    
7049    
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck             Expires November 25, 2007             [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol             May 2007
7058    
7059    
7060    8.20.  Number of database instruments changed
7061    
7062       Client may want to be notified when the number of instruments in a
7063       particular directory in the instruments database is changed by
7064       issuing the following command:
7065    
7066          SUBSCRIBE DB_INSTRUMENT_COUNT
7067    
7068       Server will start sending the following notification messages:
7069    
7070          "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
7071    
7072       where <dir-path> will be replaced by the absolute path name of the
7073       directory in the instruments database, in which the number of
7074       instruments is changed.
7075    
7076       Note that when a non-empty directory is removed, this event is not
7077       sent for the instruments in that directory.
7078    
7079    8.21.  Database instrument information changed
7080    
7081       Client may want to be notified when changes were made to instruments
7082       in the instruments database by issuing the following command:
7083    
7084          SUBSCRIBE DB_INSTRUMENT_INFO
7085    
7086       Server will start sending the following notification messages:
7087    
7088          "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
7089    
7090       where <instr-path> will be replaced by the absolute path name of the
7091       instrument, which settings are changed.  The front-end will have to
7092       send the respective command to actually get the updated directory
7093       info.  Because these messages will be triggered by LSCP commands
7094       issued by other clients rather than real time events happening on the
7095       server, it is believed that an empty notification message is
7096       sufficient here.
7097    
7098          "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
7099    
7100       where <old-instr-path> is the old absolute path name of the
7101       instrument (encapsulated into apostrophes), which name is changes and
7102       <new-name> is the new name of the instrument, encapsulated into
7103       apostrophes.
7104    
7105    
7106    
7107    
7108    
7109    
7110    
7111    Schoenebeck             Expires November 25, 2007             [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol             May 2007
7114    
7115    
7116    8.22.  Database job status information changed
7117    
7118       Client may want to be notified when the status of particular database
7119       instruments job is changed by issuing the following command:
7120    
7121          SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
7122    
7123       Server will start sending the following notification messages:
7124    
7125          "NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"
7126    
7127       where <job-id> will be replaced by the numerical ID of the job, which
7128       status is changed.  The front-end will have to send the respective
7129       command to actually get the status info.  Because these messages will
7130       be triggered by LSCP commands issued by other clients rather than
7131       real time events happening on the server, it is believed that an
7132       empty notification message is sufficient here.
7133    
7134    8.23.  Miscellaneous and debugging events
7135    
7136       Client may want to be notified of miscellaneous and debugging events
7137       occurring at the server by issuing the following command:
7138    
7139          SUBSCRIBE MISCELLANEOUS
7140    
7141       Server will start sending the following notification messages:
7142    
7143          "NOTIFY:MISCELLANEOUS:<string>"
7144    
7145       where <string> will be replaced by whatever data server wants to send
7146       to the client.  Client MAY display this data to the user AS IS to
7147       facilitate debugging.
7148    
7149    
7150    
# Line 4924  Internet-Draft        LinuxSampler Contr Line 7164  Internet-Draft        LinuxSampler Contr
7164    
7165    
7166    
7167  Schoenebeck               Expires June 18, 2007                [Page 88]  Schoenebeck             Expires November 25, 2007             [Page 128]
7168    
7169  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
7170    
7171    
7172  9.  Security Considerations  9.  Security Considerations
# Line 4980  Internet-Draft        LinuxSampler Contr Line 7220  Internet-Draft        LinuxSampler Contr
7220    
7221    
7222    
7223  Schoenebeck               Expires June 18, 2007                [Page 89]  Schoenebeck             Expires November 25, 2007             [Page 129]
7224    
7225  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
7226    
7227    
7228  10.  Acknowledgments  10.  Acknowledgments
# Line 5036  Internet-Draft        LinuxSampler Contr Line 7276  Internet-Draft        LinuxSampler Contr
7276    
7277    
7278    
7279  Schoenebeck               Expires June 18, 2007                [Page 90]  Schoenebeck             Expires November 25, 2007             [Page 130]
7280    
7281  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
7282    
7283    
7284  11.  References  11.  References
# Line 5092  Internet-Draft        LinuxSampler Contr Line 7332  Internet-Draft        LinuxSampler Contr
7332    
7333    
7334    
7335  Schoenebeck               Expires June 18, 2007                [Page 91]  Schoenebeck             Expires November 25, 2007             [Page 131]
7336    
7337  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
7338    
7339    
7340  Author's Address  Author's Address
# Line 5148  Author's Address Line 7388  Author's Address
7388    
7389    
7390    
7391  Schoenebeck               Expires June 18, 2007                [Page 92]  Schoenebeck             Expires November 25, 2007             [Page 132]
7392    
7393  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol             May 2007
7394    
7395    
7396  Full Copyright Statement  Full Copyright Statement
7397    
7398     Copyright (C) The Internet Society (2006).     Copyright (C) The IETF Trust (2007).
7399    
7400     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
7401     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 5163  Full Copyright Statement Line 7403  Full Copyright Statement
7403    
7404     This document and the information contained herein are provided on an     This document and the information contained herein are provided on an
7405     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
7406     OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET     OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
7407     ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,     THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
7408     INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE     OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
7409     INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED     THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
7410     WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.     WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
7411    
7412    
# Line 5204  Acknowledgment Line 7444  Acknowledgment
7444    
7445    
7446    
7447  Schoenebeck               Expires June 18, 2007                [Page 93]  Schoenebeck             Expires November 25, 2007             [Page 133]
7448    
Legend:
Removed from v.974  
changed lines
  Added in v.1201
  ViewVC Help
Powered by ViewVC