/[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 1006 by schoenebeck, Fri Dec 29 20:27:15 2006 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: July 2, 2007                                  December 29, 2006
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 July 2, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck               Expires June 18, 2007                 [Page 1]  Schoenebeck               Expires July 2, 2007                  [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
58    
# Line 68  Abstract Line 68  Abstract
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  5     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5
72     2.  Versioning of this specification . . . . . . . . . . . . . . .  6     2.  Versioning of this specification  . . . . . . . . . . . . . .   6
73     3.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  7     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7
74     4.  Focus of this protocol . . . . . . . . . . . . . . . . . . . .  8     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8
75     5.  Communication Overview . . . . . . . . . . . . . . . . . . . .  9     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9
76       5.1.  Request/response communication method  . . . . . . . . . .  9       5.1.  Request/response communication method . . . . . . . . . .   9
77         5.1.1.  Result format  . . . . . . . . . . . . . . . . . . . . 10         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10
78       5.2.  Subscribe/notify communication method  . . . . . . . . . . 12       5.2.  Subscribe/notify communication method . . . . . . . . . .  12
79     6.  Description for control commands . . . . . . . . . . . . . . . 14     6.  Description for control commands  . . . . . . . . . . . . . .  14
80       6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 14       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14
81       6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 14       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14
82         6.2.1.  Getting amount of available audio output drivers . . . 15         6.2.1.  Getting amount of available audio output drivers  . .  15
83         6.2.2.  Getting all available audio output drivers . . . . . . 15         6.2.2.  Getting all available audio output drivers  . . . . .  15
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  . . . . . . . . . . . . . . . . . . . . . . .  15
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  . . . . . . . . . . . . . . . . . .  16
88         6.2.5.  Creating an audio output device  . . . . . . . . . . . 20         6.2.5.  Creating an audio output device . . . . . . . . . . .  20
89         6.2.6.  Destroying an audio output device  . . . . . . . . . . 21         6.2.6.  Destroying an audio output device . . . . . . . . . .  21
90         6.2.7.  Getting all created audio output device count  . . . . 22         6.2.7.  Getting all created audio output device count . . . .  22
91         6.2.8.  Getting all created audio output device list . . . . . 22         6.2.8.  Getting all created audio output device list  . . . .  22
92         6.2.9.  Getting current settings of an audio output device . . 22         6.2.9.  Getting current settings of an audio output device  .  22
93         6.2.10. Changing settings of audio output devices  . . . . . . 24         6.2.10. Changing settings of audio output devices . . . . . .  24
94         6.2.11. Getting information about an audio channel . . . . . . 25         6.2.11. Getting information about an audio channel  . . . . .  25
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter  . . . . . . . . . . . . . . . . . . . . . . 26                 parameter . . . . . . . . . . . . . . . . . . . . . .  26
97         6.2.13. Changing settings of audio output channels . . . . . . 28         6.2.13. Changing settings of audio output channels  . . . . .  28
98       6.3.  Configuring MIDI input drivers . . . . . . . . . . . . . . 29       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29
99         6.3.1.  Getting amount of available MIDI input drivers . . . . 30         6.3.1.  Getting amount of available MIDI input drivers  . . .  30
100         6.3.2.  Getting all available MIDI input drivers . . . . . . . 30         6.3.2.  Getting all available MIDI input drivers  . . . . . .  30
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  . . . . . . . . . . . . . . . . . . . . . . .  31
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  . . . . . . . . . . . . . . . . . .  32
105         6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 34         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34
106         6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 35         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35
107         6.3.7.  Getting all created MIDI input device count  . . . . . 36         6.3.7.  Getting all created MIDI input device count . . . . .  36
108    
109    
110    
111  Schoenebeck               Expires June 18, 2007                 [Page 2]  Schoenebeck               Expires July 2, 2007                  [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
114    
115    
116         6.3.8.  Getting all created MIDI input device list . . . . . . 36         6.3.8.  Getting all created MIDI input device list  . . . . .  36
117         6.3.9.  Getting current settings of a MIDI input device  . . . 37         6.3.9.  Getting current settings of a MIDI input device . . .  37
118         6.3.10. Changing settings of MIDI input devices  . . . . . . . 38         6.3.10. Changing settings of MIDI input devices . . . . . . .  38
119         6.3.11. Getting information about a MIDI port  . . . . . . . . 38         6.3.11. Getting information about a MIDI port . . . . . . . .  38
120         6.3.12. Getting information about specific MIDI port         6.3.12. Getting information about specific MIDI port
121                 parameter  . . . . . . . . . . . . . . . . . . . . . . 39                 parameter . . . . . . . . . . . . . . . . . . . . . .  39
122         6.3.13. Changing settings of MIDI input ports  . . . . . . . . 41         6.3.13. Changing settings of MIDI input ports . . . . . . . .  41
123       6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 42       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42
124         6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 42         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42
125         6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 43         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43
126         6.4.3.  Getting all created sampler channel count  . . . . . . 44         6.4.3.  Getting all created sampler channel count . . . . . .  44
127         6.4.4.  Getting all created sampler channel list . . . . . . . 44         6.4.4.  Getting all created sampler channel list  . . . . . .  44
128         6.4.5.  Adding a new sampler channel . . . . . . . . . . . . . 44         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44
129         6.4.6.  Removing a sampler channel . . . . . . . . . . . . . . 45         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45
130         6.4.7.  Getting amount of available engines  . . . . . . . . . 46         6.4.7.  Getting amount of available engines . . . . . . . . .  46
131         6.4.8.  Getting all available engines  . . . . . . . . . . . . 46         6.4.8.  Getting all available engines . . . . . . . . . . . .  46
132         6.4.9.  Getting information about an engine  . . . . . . . . . 47         6.4.9.  Getting information about an engine . . . . . . . . .  47
133         6.4.10. Getting sampler channel information  . . . . . . . . . 48         6.4.10. Getting sampler channel information . . . . . . . . .  48
134         6.4.11. Current number of active voices  . . . . . . . . . . . 51         6.4.11. Current number of active voices . . . . . . . . . . .  51
135         6.4.12. Current number of active disk streams  . . . . . . . . 51         6.4.12. Current number of active disk streams . . . . . . . .  51
136         6.4.13. Current fill state of disk stream buffers  . . . . . . 52         6.4.13. Current fill state of disk stream buffers . . . . . .  52
137         6.4.14. Setting audio output device  . . . . . . . . . . . . . 53         6.4.14. Setting audio output device . . . . . . . . . . . . .  53
138         6.4.15. Setting audio output type  . . . . . . . . . . . . . . 53         6.4.15. Setting audio output type . . . . . . . . . . . . . .  53
139         6.4.16. Setting audio output channel . . . . . . . . . . . . . 54         6.4.16. Setting audio output channel  . . . . . . . . . . . .  54
140         6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 55         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  55
141         6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 56         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  56
142         6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 56         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56
143         6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57
144         6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 58         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58
145         6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58
146         6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 59         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59
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 . . . . . . . . . . . . . . . . . . . . . . .  60
149         6.4.25. Resetting a sampler channel  . . . . . . . . . . . . . 61         6.4.25. Adding an effect send to a sampler channel  . . . . .  61
150       6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 61         6.4.26. Removing an effect send from a sampler channel  . . .  62
151         6.5.1.  Register front-end for receiving event messages  . . . 61         6.4.27. Getting amount of effect sends on a sampler channel .  63
152           6.4.28. Listing all effect sends on a sampler channel . . . .  63
153           6.4.29. Getting effect send information . . . . . . . . . . .  64
154           6.4.30. Altering effect send's audio routing  . . . . . . . .  65
155           6.4.31. Resetting a sampler channel . . . . . . . . . . . . .  66
156         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  66
157           6.5.1.  Register front-end for receiving event messages . . .  66
158         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
159                 messages . . . . . . . . . . . . . . . . . . . . . . . 62                 messages  . . . . . . . . . . . . . . . . . . . . . .  67
160         6.5.3.  Enable or disable echo of commands . . . . . . . . . . 63         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  68
161         6.5.4.  Close client connection  . . . . . . . . . . . . . . . 63         6.5.4.  Close client connection . . . . . . . . . . . . . . .  68
162       6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 64       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  69
163         6.6.1.  Current number of active voices  . . . . . . . . . . . 64         6.6.1.  Current number of active voices . . . . . . . . . . .  69
        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 July 2, 2007                  [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
170    
171    
172         6.7.3.  Get amount of existing MIDI instrument maps  . . . . . 67         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  69
173         6.7.4.  Getting all created MIDI instrument maps . . . . . . . 68         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  69
174         6.7.5.  Getting MIDI instrument map information  . . . . . . . 68         6.6.4.  General sampler informations  . . . . . . . . . . . .  70
175         6.7.6.  Renaming a MIDI instrument map . . . . . . . . . . . . 69         6.6.5.  Getting global volume attenuation . . . . . . . . . .  70
176         6.7.7.  Create or replace a MIDI instrument map entry  . . . . 69         6.6.6.  Setting global volume attenuation . . . . . . . . . .  71
177         6.7.8.  Getting ammount of MIDI instrument map entries . . . . 72       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  71
178           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  72
179           6.7.2.  Delete one particular or all MIDI instrument maps . .  73
180           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  73
181           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  74
182           6.7.5.  Getting MIDI instrument map information . . . . . . .  74
183           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  75
184           6.7.7.  Create or replace a MIDI instrument map entry . . . .  75
185           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  78
186         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
187                 instrument map . . . . . . . . . . . . . . . . . . . . 73                 instrument map  . . . . . . . . . . . . . . . . . . .  79
188         6.7.10. Remove an entry from the MIDI instrument map . . . . . 73         6.7.10. Remove an entry from the MIDI instrument map  . . . .  79
189         6.7.11. Get current settings of MIDI instrument map entry  . . 74         6.7.11. Get current settings of MIDI instrument map entry . .  80
190         6.7.12. Clear MIDI instrument map  . . . . . . . . . . . . . . 76         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  82
191     7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 77     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  83
192     8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  94
193       8.1.  Number of sampler channels changed . . . . . . . . . . . . 86       8.1.  Number of audio output devices changed  . . . . . . . . .  94
194       8.2.  Number of active voices changed  . . . . . . . . . . . . . 86       8.2.  Audio output device's settings changed  . . . . . . . . .  94
195       8.3.  Number of active disk streams changed  . . . . . . . . . . 86       8.3.  Number of MIDI input devices changed  . . . . . . . . . .  94
196       8.4.  Disk stream buffer fill state changed  . . . . . . . . . . 87       8.4.  MIDI input device's settings changed  . . . . . . . . . .  95
197       8.5.  Channel information changed  . . . . . . . . . . . . . . . 87       8.5.  Number of sampler channels changed  . . . . . . . . . . .  95
198       8.6.  Total number of active voices changed  . . . . . . . . . . 87       8.6.  Number of active voices changed . . . . . . . . . . . . .  95
199       8.7.  Miscellaneous and debugging events . . . . . . . . . . . . 88       8.7.  Number of active disk streams changed . . . . . . . . . .  96
200     9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 89       8.8.  Disk stream buffer fill state changed . . . . . . . . . .  96
201     10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 90       8.9.  Channel information changed . . . . . . . . . . . . . . .  96
202     11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 91       8.10. Total number of active voices changed . . . . . . . . . .  97
203     Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 92       8.11. Number of MIDI instrument maps changed  . . . . . . . . .  97
204     Intellectual Property and Copyright Statements . . . . . . . . . . 93       8.12. MIDI instrument map information changed . . . . . . . . .  97
205         8.13. Number of MIDI instruments changed  . . . . . . . . . . .  98
206         8.14. MIDI instrument information changed . . . . . . . . . . .  98
207         8.15. Miscellaneous and debugging events  . . . . . . . . . . .  99
208       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 100
209       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 101
210       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 102
211       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 103
212       Intellectual Property and Copyright Statements  . . . . . . . . . 104
213    
214    
215    
# Line 204  Internet-Draft        LinuxSampler Contr Line 220  Internet-Draft        LinuxSampler Contr
220    
221    
222    
223    Schoenebeck               Expires July 2, 2007                  [Page 4]
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 Schoenebeck               Expires June 18, 2007                 [Page 4]  
224    
225  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
226    
# Line 276  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck               Expires June 18, 2007                 [Page 5]  Schoenebeck               Expires July 2, 2007                  [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
282    
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires June 18, 2007                 [Page 6]  Schoenebeck               Expires July 2, 2007                  [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
338    
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires June 18, 2007                 [Page 7]  Schoenebeck               Expires July 2, 2007                  [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
394    
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires June 18, 2007                 [Page 8]  Schoenebeck               Expires July 2, 2007                  [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
450    
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires June 18, 2007                 [Page 9]  Schoenebeck               Expires July 2, 2007                  [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
506    
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires June 18, 2007                [Page 10]  Schoenebeck               Expires July 2, 2007                 [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
562    
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires June 18, 2007                [Page 11]  Schoenebeck               Expires July 2, 2007                 [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
618    
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires June 18, 2007                [Page 12]  Schoenebeck               Expires July 2, 2007                 [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
674    
# Line 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires June 18, 2007                [Page 13]  Schoenebeck               Expires July 2, 2007                 [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
730    
# Line 780  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck               Expires June 18, 2007                [Page 14]  Schoenebeck               Expires July 2, 2007                 [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
786    
# Line 836  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck               Expires June 18, 2007                [Page 15]  Schoenebeck               Expires July 2, 2007                 [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
842    
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires June 18, 2007                [Page 16]  Schoenebeck               Expires July 2, 2007                 [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
898    
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires June 18, 2007                [Page 17]  Schoenebeck               Expires July 2, 2007                 [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
954    
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires June 18, 2007                [Page 18]  Schoenebeck               Expires July 2, 2007                 [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1010    
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires June 18, 2007                [Page 19]  Schoenebeck               Expires July 2, 2007                 [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1066    
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires June 18, 2007                [Page 20]  Schoenebeck               Expires July 2, 2007                 [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1122    
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires June 18, 2007                [Page 21]  Schoenebeck               Expires July 2, 2007                 [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1178    
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires June 18, 2007                [Page 22]  Schoenebeck               Expires July 2, 2007                 [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1234    
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires June 18, 2007                [Page 23]  Schoenebeck               Expires July 2, 2007                 [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1290    
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck               Expires June 18, 2007                [Page 24]  Schoenebeck               Expires July 2, 2007                 [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1346    
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck               Expires June 18, 2007                [Page 25]  Schoenebeck               Expires July 2, 2007                 [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1402    
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck               Expires June 18, 2007                [Page 26]  Schoenebeck               Expires July 2, 2007                 [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1458    
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck               Expires June 18, 2007                [Page 27]  Schoenebeck               Expires July 2, 2007                 [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1514    
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires June 18, 2007                [Page 28]  Schoenebeck               Expires July 2, 2007                 [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1570    
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires June 18, 2007                [Page 29]  Schoenebeck               Expires July 2, 2007                 [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1626    
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck               Expires June 18, 2007                [Page 30]  Schoenebeck               Expires July 2, 2007                 [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1682    
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck               Expires June 18, 2007                [Page 31]  Schoenebeck               Expires July 2, 2007                 [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1738    
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck               Expires June 18, 2007                [Page 32]  Schoenebeck               Expires July 2, 2007                 [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1794    
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck               Expires June 18, 2007                [Page 33]  Schoenebeck               Expires July 2, 2007                 [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1850    
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck               Expires June 18, 2007                [Page 34]  Schoenebeck               Expires July 2, 2007                 [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1906    
# Line 1956  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck               Expires June 18, 2007                [Page 35]  Schoenebeck               Expires July 2, 2007                 [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1962    
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck               Expires June 18, 2007                [Page 36]  Schoenebeck               Expires July 2, 2007                 [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2018    
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck               Expires June 18, 2007                [Page 37]  Schoenebeck               Expires July 2, 2007                 [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2074    
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck               Expires June 18, 2007                [Page 38]  Schoenebeck               Expires July 2, 2007                 [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2130    
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck               Expires June 18, 2007                [Page 39]  Schoenebeck               Expires July 2, 2007                 [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2186    
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck               Expires June 18, 2007                [Page 40]  Schoenebeck               Expires July 2, 2007                 [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2242    
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck               Expires June 18, 2007                [Page 41]  Schoenebeck               Expires July 2, 2007                 [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2298    
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck               Expires June 18, 2007                [Page 42]  Schoenebeck               Expires July 2, 2007                 [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2354    
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck               Expires June 18, 2007                [Page 43]  Schoenebeck               Expires July 2, 2007                 [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2410    
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck               Expires June 18, 2007                [Page 44]  Schoenebeck               Expires July 2, 2007                 [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2466    
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck               Expires June 18, 2007                [Page 45]  Schoenebeck               Expires July 2, 2007                 [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2522    
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck               Expires June 18, 2007                [Page 46]  Schoenebeck               Expires July 2, 2007                 [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2578    
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires June 18, 2007                [Page 47]  Schoenebeck               Expires July 2, 2007                 [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2634    
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires June 18, 2007                [Page 48]  Schoenebeck               Expires July 2, 2007                 [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2690    
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires June 18, 2007                [Page 49]  Schoenebeck               Expires July 2, 2007                 [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2746    
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck               Expires June 18, 2007                [Page 50]  Schoenebeck               Expires July 2, 2007                 [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2802    
# Line 2852  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855  Schoenebeck               Expires June 18, 2007                [Page 51]  Schoenebeck               Expires July 2, 2007                 [Page 51]
2856    
2857  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2858    
# Line 2908  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911  Schoenebeck               Expires June 18, 2007                [Page 52]  Schoenebeck               Expires July 2, 2007                 [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2914    
# Line 2964  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck               Expires June 18, 2007                [Page 53]  Schoenebeck               Expires July 2, 2007                 [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2970    
# Line 3020  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck               Expires June 18, 2007                [Page 54]  Schoenebeck               Expires July 2, 2007                 [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3026    
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck               Expires June 18, 2007                [Page 55]  Schoenebeck               Expires July 2, 2007                 [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3082    
# Line 3132  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck               Expires June 18, 2007                [Page 56]  Schoenebeck               Expires July 2, 2007                 [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3138    
# Line 3188  Internet-Draft        LinuxSampler Contr Line 3188  Internet-Draft        LinuxSampler Contr
3188    
3189    
3190    
3191  Schoenebeck               Expires June 18, 2007                [Page 57]  Schoenebeck               Expires July 2, 2007                 [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3194    
# Line 3244  Internet-Draft        LinuxSampler Contr Line 3244  Internet-Draft        LinuxSampler Contr
3244    
3245    
3246    
3247  Schoenebeck               Expires June 18, 2007                [Page 58]  Schoenebeck               Expires July 2, 2007                 [Page 58]
3248    
3249  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3250    
# Line 3300  Internet-Draft        LinuxSampler Contr Line 3300  Internet-Draft        LinuxSampler Contr
3300    
3301    
3302    
3303  Schoenebeck               Expires June 18, 2007                [Page 59]  Schoenebeck               Expires July 2, 2007                 [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3306    
# Line 3356  Internet-Draft        LinuxSampler Contr Line 3356  Internet-Draft        LinuxSampler Contr
3356    
3357    
3358    
3359  Schoenebeck               Expires June 18, 2007                [Page 60]  Schoenebeck               Expires July 2, 2007                 [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3362    
# Line 3365  Internet-Draft        LinuxSampler Contr Line 3365  Internet-Draft        LinuxSampler Contr
3365    
3366    
3367    
3368  6.4.25.  Resetting a sampler channel  6.4.25.  Adding an effect send to a sampler channel
3369    
3370       The front-end can create an additional effect send on a specific
3371       sampler channel by sending the following command:
3372    
3373          CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3374    
3375       Where <sampler-channel> is the respective sampler channel number as
3376       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3377       (Section 6.4.4) command, that is the sampler channel on which the
3378       effect send should be created on, <midi-ctrl> is a number between
3379       0..127 defining the MIDI controller which can alter the effect send
3380       level and <name> is an optional argument defining a name for the
3381       effect send entity.  The name does not have to be unique.
3382    
3383       By default, that is as initial routing, the effect send's audio
3384       channels are automatically routed to the last audio channels of the
3385       sampler channel's audio output device, that way you can i.e. first
3386       increase the amount of audio channels on the audio output device for
3387       having dedicated effect send output channels and when "CREATE
3388       FX_SEND" is called, those channels will automatically be picked.  You
3389       can alter the destination channels however with "SET FX_SEND
3390       AUDIO_OUTPUT_CHANNEL" (Section 6.4.30).
3391    
3392       Note: Create effect sends on a sampler channel only when needed,
3393       because having effect sends on a sampler channel will decrease
3394       runtime performance, because for implementing channel effect sends,
3395       separate (sampler channel local) audio buffers are needed to render
3396       and mix the voices and route the audio signal afterwards to the
3397       master outputs and effect send outputs (along with their respective
3398       effect send levels).  A sampler channel without effect sends however
3399       can mix its voices directly into the audio output devices's audio
3400       buffers and is thus faster.
3401    
3402       Possible Answers:
3403    
3404          "OK[<fx-send-id>]" -
3405    
3406             in case a new effect send could be added to the sampler
3407             channel, where <fx-send-id> reflects the unique ID of the newly
3408             created effect send entity
3409    
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires July 2, 2007                 [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol        December 2006
3418    
3419    
3420          "ERR:<error-code>:<error-message>" -
3421    
3422             when a new effect send could not be added, i.e. due to invalid
3423             parameters
3424    
3425       Examples:
3426    
3427          C: "CREATE FX_SEND 0 91 'Reverb Send'"
3428    
3429          S: "OK[0]"
3430    
3431          C: "CREATE FX_SEND 0 93"
3432    
3433          S: "OK[1]"
3434    
3435    6.4.26.  Removing an effect send from a sampler channel
3436    
3437       The front-end can remove an existing effect send on a specific
3438       sampler channel by sending the following command:
3439    
3440          DESTROY FX_SEND <sampler-channel> <fx-send-id>
3441    
3442       Where <sampler-channel> is the respective sampler channel number as
3443       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3444       (Section 6.4.4) command, that is the sampler channel from which the
3445       effect send should be removed from and <fx-send-id> is the respective
3446       effect send number as returned by the "CREATE FX_SEND"
3447       (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3448    
3449       Possible Answers:
3450    
3451          "OK" -
3452    
3453             on success
3454    
3455          "ERR:<error-code>:<error-message>" -
3456    
3457             in case it failed, providing an appropriate error code and
3458             error message
3459    
3460       Example:
3461    
3462          C: "DESTROY FX_SEND 0 0"
3463    
3464          S: "OK"
3465    
3466    
3467    
3468    
3469    
3470    
3471    Schoenebeck               Expires July 2, 2007                 [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol        December 2006
3474    
3475    
3476    6.4.27.  Getting amount of effect sends on a sampler channel
3477    
3478       The front-end can ask for the amount of effect sends on a specific
3479       sampler channel by sending the following command:
3480    
3481          GET FX_SENDS <sampler-channel>
3482    
3483       Where <sampler-channel> is the respective sampler channel number as
3484       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3485       (Section 6.4.4) command.
3486    
3487       Possible Answers:
3488    
3489          The sampler will answer by returning the number of effect sends on
3490          the given sampler channel.
3491    
3492       Example:
3493    
3494          C: "GET FX_SENDS 0"
3495    
3496          S: "2"
3497    
3498    6.4.28.  Listing all effect sends on a sampler channel
3499    
3500       The front-end can ask for a list of effect sends on a specific
3501       sampler channel by sending the following command:
3502    
3503          LIST FX_SENDS <sampler-channel>
3504    
3505       Where <sampler-channel> is the respective sampler channel number as
3506       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3507       (Section 6.4.4) command.
3508    
3509       Possible Answers:
3510    
3511          The sampler will answer by returning a comma separated list with
3512          all effect sends' numerical IDs on the given sampler channel.
3513    
3514       Examples:
3515    
3516          C: "LIST FX_SENDS 0"
3517    
3518          S: "0,1"
3519    
3520          C: "LIST FX_SENDS 1"
3521    
3522          S: ""
3523    
3524    
3525    
3526    
3527    Schoenebeck               Expires July 2, 2007                 [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol        December 2006
3530    
3531    
3532    6.4.29.  Getting effect send information
3533    
3534       The front-end can ask for the current settings of an effect send
3535       entity by sending the following command:
3536    
3537          GET FX_SEND INFO <sampler-channel> <fx-send-id>
3538    
3539       Where <sampler-channel> is the sampler channel number as returned by
3540       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3541       command and <fx-send-id> reflects the numerical ID of the effect send
3542       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3543       FX_SENDS" (Section 6.4.28) command.
3544    
3545       Possible Answers:
3546    
3547          The sampler will answer by sending a <CRLF> separated list.  Each
3548          answer line begins with the settings category name followed by a
3549          colon and then a space character <SP> and finally the info
3550          character string to that setting category.  At the moment the
3551          following categories are defined:
3552    
3553    
3554    
3555             NAME -
3556    
3557                name of the effect send entity
3558    
3559             AUDIO_OUTPUT_ROUTING -
3560    
3561                comma separated list which reflects to which audio channel
3562                of the selected audio output device each effect send output
3563                channel is routed to, e.g. "0,3" would mean the effect
3564                send's output channel 0 is routed to channel 0 of the audio
3565                output device and the effect send's output channel 1 is
3566                routed to the channel 3 of the audio output device (see "SET
3567                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)
3568    
3569       The mentioned fields above don't have to be in particular order.
3570    
3571       Example:
3572    
3573          C: "GET FX_SEND INFO 0 0"
3574    
3575          S: "NAME: Reverb Send"
3576    
3577             "AUDIO_OUTPUT_ROUTING: 2,3"
3578    
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires July 2, 2007                 [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol        December 2006
3586    
3587    
3588             "."
3589    
3590    6.4.30.  Altering effect send's audio routing
3591    
3592       The front-end can alter the destination of an effect send's audio
3593       channel on a specific sampler channel by sending the following
3594       command:
3595    
3596          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3597          <audio-src> <audio-dst>
3598    
3599       Where <sampler-chan> is the sampler channel number as returned by the
3600       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3601       command, <fx-send-id> reflects the numerical ID of the effect send
3602       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3603       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3604       of the effect send's audio channel which should be rerouted and
3605       <audio-dst> is the numerical ID of the audio channel of the selected
3606       audio output device where <audio-src> should be routed to.
3607    
3608       Note that effect sends can only route audio to the same audio output
3609       device as assigned to the effect send's sampler channel.  Also note
3610       that an effect send entity does always have exactly as much audio
3611       channels as its sampler channel.  So if the sampler channel is
3612       stereo, the effect send does have two audio channels as well.  Also
3613       keep in mind that the amount of audio channels on a sampler channel
3614       might be dependant not only to the deployed sampler engine on the
3615       sampler channel, but also dependant to the instrument currently
3616       loaded.  However you can (effectively) turn an i.e. stereo effect
3617       send into a mono one by simply altering its audio routing
3618       appropriately.
3619    
3620       Possible Answers:
3621    
3622          "OK" -
3623    
3624             on success
3625    
3626          "WRN:<warning-code>:<warning-message>" -
3627    
3628             if audio output channel was set, but there are noteworthy
3629             issue(s) related, providing an appropriate warning code and
3630             warning message
3631    
3632          "ERR:<error-code>:<error-message>" -
3633    
3634             in case it failed, providing an appropriate error code and
3635             error message
3636    
3637    
3638    
3639    Schoenebeck               Expires July 2, 2007                 [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol        December 2006
3642    
3643    
3644       Example:
3645    
3646          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3647    
3648          S: "OK"
3649    
3650    6.4.31.  Resetting a sampler channel
3651    
3652     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3653     following command:     following command:
# Line 3410  Internet-Draft        LinuxSampler Contr Line 3692  Internet-Draft        LinuxSampler Contr
3692    
3693    
3694    
3695    Schoenebeck               Expires July 2, 2007                 [Page 66]
   
 Schoenebeck               Expires June 18, 2007                [Page 61]  
3696    
3697  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3698    
# Line 3468  Internet-Draft        LinuxSampler Contr Line 3748  Internet-Draft        LinuxSampler Contr
3748    
3749    
3750    
3751  Schoenebeck               Expires June 18, 2007                [Page 62]  Schoenebeck               Expires July 2, 2007                 [Page 67]
3752    
3753  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3754    
# Line 3524  Internet-Draft        LinuxSampler Contr Line 3804  Internet-Draft        LinuxSampler Contr
3804    
3805    
3806    
3807  Schoenebeck               Expires June 18, 2007                [Page 63]  Schoenebeck               Expires July 2, 2007                 [Page 68]
3808    
3809  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3810    
# Line 3580  Internet-Draft        LinuxSampler Contr Line 3860  Internet-Draft        LinuxSampler Contr
3860    
3861    
3862    
3863  Schoenebeck               Expires June 18, 2007                [Page 64]  Schoenebeck               Expires July 2, 2007                 [Page 69]
3864    
3865  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3866    
# Line 3618  Internet-Draft        LinuxSampler Contr Line 3898  Internet-Draft        LinuxSampler Contr
3898     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3899     Other fields might be added in future.     Other fields might be added in future.
3900    
3901    6.6.5.  Getting global volume attenuation
3902    
3903       The client can ask for the current global sampler-wide volume
3904       attenuation by sending the following command:
3905    
3906          GET VOLUME
3907    
3908       Possible Answers:
3909    
3910          The sampler will always answer by returning the optional dotted
3911          floating point coefficient, reflecting the current global volume
3912          attenuation.
3913    
3914       Note: it is up to the respective sampler engine whether to obey that
3915       global volume parameter or not, but in general all engines SHOULD use
3916    
3917    
3918    
3919    Schoenebeck               Expires July 2, 2007                 [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol        December 2006
3922    
3923    
3924       this parameter.
3925    
3926    6.6.6.  Setting global volume attenuation
3927    
3928       The client can alter the current global sampler-wide volume
3929       attenuation by sending the following command:
3930    
3931          SET VOLUME <volume>
3932    
3933       Where <volume> should be replaced by the optional dotted floating
3934       point value, reflecting the new global volume parameter.  This value
3935       might usually be in the range between 0.0 and 1.0, that is for
3936       attenuating the overall volume.
3937    
3938       Possible Answers:
3939    
3940          "OK" -
3941    
3942             on success
3943    
3944          "WRN:<warning-code>:<warning-message>" -
3945    
3946             if the global volume was set, but there are noteworthy issue(s)
3947             related, providing an appropriate warning code and warning
3948             message
3949    
3950          "ERR:<error-code>:<error-message>" -
3951    
3952             in case it failed, providing an appropriate error code and
3953             error message
3954    
3955  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
3956    
3957     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 3967  Internet-Draft        LinuxSampler Contr
3967     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,
3968     thus the sampler will simply ignore all program change messages.  The     thus the sampler will simply ignore all program change messages.  The
3969     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
3970       the map and tell the respective sampler channel(s) which MIDI
3971       instrument map to use, so the sampler knows how to react on a given
3972    
3973    
3974    
3975  Schoenebeck               Expires June 18, 2007                [Page 65]  Schoenebeck               Expires July 2, 2007                 [Page 71]
3976    
3977  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3978    
3979    
    the map and tell the respective sampler channel(s) which MIDI  
    instrument map to use, so the sampler knows how to react on a given  
3980     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
3981     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
3982     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
# Line 3688  Internet-Draft        LinuxSampler Contr Line 4022  Internet-Draft        LinuxSampler Contr
4022    
4023        S: "OK[1]"        S: "OK[1]"
4024    
4025          C: "ADD MIDI_INSTRUMENT_MAP"
4026    
4027    
4028    
4029    
4030    
4031  Schoenebeck               Expires June 18, 2007                [Page 66]  Schoenebeck               Expires July 2, 2007                 [Page 72]
4032    
4033  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4034    
4035    
       C: "ADD MIDI_INSTRUMENT_MAP"  
   
4036        S: "OK[5]"        S: "OK[5]"
4037    
4038  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
# Line 3748  Internet-Draft        LinuxSampler Contr Line 4082  Internet-Draft        LinuxSampler Contr
4082    
4083    
4084    
4085  Schoenebeck               Expires June 18, 2007                [Page 67]  
4086    
4087    Schoenebeck               Expires July 2, 2007                 [Page 73]
4088    
4089  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4090    
# Line 3804  Internet-Draft        LinuxSampler Contr Line 4140  Internet-Draft        LinuxSampler Contr
4140    
4141    
4142    
4143  Schoenebeck               Expires June 18, 2007                [Page 68]  Schoenebeck               Expires July 2, 2007                 [Page 74]
4144    
4145  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4146    
# Line 3860  Internet-Draft        LinuxSampler Contr Line 4196  Internet-Draft        LinuxSampler Contr
4196    
4197    
4198    
4199  Schoenebeck               Expires June 18, 2007                [Page 69]  Schoenebeck               Expires July 2, 2007                 [Page 75]
4200    
4201  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4202    
# Line 3916  Internet-Draft        LinuxSampler Contr Line 4252  Internet-Draft        LinuxSampler Contr
4252    
4253    
4254    
4255  Schoenebeck               Expires June 18, 2007                [Page 70]  Schoenebeck               Expires July 2, 2007                 [Page 76]
4256    
4257  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4258    
# Line 3972  Internet-Draft        LinuxSampler Contr Line 4308  Internet-Draft        LinuxSampler Contr
4308    
4309    
4310    
4311  Schoenebeck               Expires June 18, 2007                [Page 71]  Schoenebeck               Expires July 2, 2007                 [Page 77]
4312    
4313  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4314    
# Line 4028  Internet-Draft        LinuxSampler Contr Line 4364  Internet-Draft        LinuxSampler Contr
4364    
4365    
4366    
4367  Schoenebeck               Expires June 18, 2007                [Page 72]  Schoenebeck               Expires July 2, 2007                 [Page 78]
4368    
4369  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4370    
# Line 4084  Internet-Draft        LinuxSampler Contr Line 4420  Internet-Draft        LinuxSampler Contr
4420    
4421    
4422    
4423  Schoenebeck               Expires June 18, 2007                [Page 73]  Schoenebeck               Expires July 2, 2007                 [Page 79]
4424    
4425  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4426    
# Line 4140  Internet-Draft        LinuxSampler Contr Line 4476  Internet-Draft        LinuxSampler Contr
4476    
4477    
4478    
4479  Schoenebeck               Expires June 18, 2007                [Page 74]  Schoenebeck               Expires July 2, 2007                 [Page 80]
4480    
4481  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4482    
# Line 4196  Internet-Draft        LinuxSampler Contr Line 4532  Internet-Draft        LinuxSampler Contr
4532    
4533    
4534    
4535  Schoenebeck               Expires June 18, 2007                [Page 75]  Schoenebeck               Expires July 2, 2007                 [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4538    
# Line 4252  Internet-Draft        LinuxSampler Contr Line 4588  Internet-Draft        LinuxSampler Contr
4588    
4589    
4590    
4591  Schoenebeck               Expires June 18, 2007                [Page 76]  Schoenebeck               Expires July 2, 2007                 [Page 82]
4592    
4593  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4594    
# Line 4308  Internet-Draft        LinuxSampler Contr Line 4644  Internet-Draft        LinuxSampler Contr
4644    
4645    
4646    
4647  Schoenebeck               Expires June 18, 2007                [Page 77]  Schoenebeck               Expires July 2, 2007                 [Page 83]
4648    
4649  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4650    
# Line 4345  Internet-Draft        LinuxSampler Contr Line 4681  Internet-Draft        LinuxSampler Contr
4681    
4682     subscribe_event =     subscribe_event =
4683    
4684        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4685    
4686          / AUDIO_OUTPUT_DEVICE_INFO
4687    
4688          / MIDI_INPUT_DEVICE_COUNT
4689    
4690          / MIDI_INPUT_DEVICE_INFO
4691    
4692          / CHANNEL_COUNT
4693    
4694        / VOICE_COUNT        / VOICE_COUNT
4695    
# Line 4353  Internet-Draft        LinuxSampler Contr Line 4697  Internet-Draft        LinuxSampler Contr
4697    
4698        / BUFFER_FILL        / BUFFER_FILL
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires July 2, 2007                 [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol        December 2006
4706    
4707    
4708        / CHANNEL_INFO        / CHANNEL_INFO
4709    
4710          / MIDI_INSTRUMENT_MAP_COUNT
4711    
4712          / MIDI_INSTRUMENT_MAP_INFO
4713    
4714          / MIDI_INSTRUMENT_COUNT
4715    
4716          / MIDI_INSTRUMENT_INFO
4717    
4718        / MISCELLANEOUS        / MISCELLANEOUS
4719    
4720        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4721    
4722     unsubscribe_event =     unsubscribe_event =
4723    
4724          AUDIO_OUTPUT_DEVICE_COUNT
4725    
4726          / AUDIO_OUTPUT_DEVICE_INFO
4727    
4728          / MIDI_INPUT_DEVICE_COUNT
4729    
4730  Schoenebeck               Expires June 18, 2007                [Page 78]        / MIDI_INPUT_DEVICE_INFO
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4731    
4732          / CHANNEL_COUNT
       CHANNEL_COUNT  
4733    
4734        / VOICE_COUNT        / VOICE_COUNT
4735    
# Line 4379  Internet-Draft        LinuxSampler Contr Line 4739  Internet-Draft        LinuxSampler Contr
4739    
4740        / CHANNEL_INFO        / CHANNEL_INFO
4741    
4742          / MIDI_INSTRUMENT_MAP_COUNT
4743    
4744          / MIDI_INSTRUMENT_MAP_INFO
4745    
4746          / MIDI_INSTRUMENT_COUNT
4747    
4748          / MIDI_INSTRUMENT_INFO
4749    
4750        / MISCELLANEOUS        / MISCELLANEOUS
4751    
4752        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4753    
4754     map_instruction =     map_instruction =
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires July 2, 2007                 [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol        December 2006
4762    
4763    
4764        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4765        engine_name SP filename SP instrument_index SP volume_value        engine_name SP filename SP instrument_index SP volume_value
4766    
# Line 4416  Internet-Draft        LinuxSampler Contr Line 4792  Internet-Draft        LinuxSampler Contr
4792    
4793        AVAILABLE_ENGINES        AVAILABLE_ENGINES
4794    
   
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4795        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
4796    
4797        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
# Line 4443  Internet-Draft        LinuxSampler Contr Line 4810  Internet-Draft        LinuxSampler Contr
4810        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
4811        key_val_list        key_val_list
4812    
4813    
4814    
4815    Schoenebeck               Expires July 2, 2007                 [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol        December 2006
4818    
4819    
4820        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
4821    
4822        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 4472  Internet-Draft        LinuxSampler Contr Line 4846  Internet-Draft        LinuxSampler Contr
4846    
4847        / ENGINE SP INFO SP engine_name        / ENGINE SP INFO SP engine_name
4848    
   
   
   
   
 Schoenebeck               Expires June 18, 2007                [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
4849        / SERVER SP INFO        / SERVER SP INFO
4850    
4851        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
# Line 4497  Internet-Draft        LinuxSampler Contr Line 4862  Internet-Draft        LinuxSampler Contr
4862    
4863        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
4864    
4865          / FX_SENDS SP sampler_channel
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires July 2, 2007                 [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol        December 2006
4874    
4875    
4876          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
4877    
4878          / VOLUME
4879    
4880     set_instruction =     set_instruction =
4881    
4882        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
# Line 4515  Internet-Draft        LinuxSampler Contr Line 4895  Internet-Draft        LinuxSampler Contr
4895    
4896        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
4897    
4898          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
4899          SP audio_channel_index SP audio_channel_index
4900    
4901        / ECHO SP boolean        / ECHO SP boolean
4902    
4903          / VOLUME SP volume_value
4904    
4905     create_instruction =     create_instruction =
4906    
4907        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 4912  Internet-Draft        LinuxSampler Contr
4912    
4913        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
4914    
4915          / FX_SEND SP sampler_channel SP midi_ctrl
4916    
4917          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
4918    
4919     reset_instruction =     reset_instruction =
4920    
4921          CHANNEL SP sampler_channel
4922    
4923       clear_instruction =
4924    
4925    
4926  Schoenebeck               Expires June 18, 2007                [Page 81]  
4927    Schoenebeck               Expires July 2, 2007                 [Page 88]
4928    
4929  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4930    
4931    
       CHANNEL SP sampler_channel  
   
    clear_instruction =  
   
4932        MIDI_INSTRUMENTS SP midi_map        MIDI_INSTRUMENTS SP midi_map
4933    
4934        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
# Line 4551  Internet-Draft        LinuxSampler Contr Line 4939  Internet-Draft        LinuxSampler Contr
4939    
4940        / MIDI_INPUT_DEVICE SP number        / MIDI_INPUT_DEVICE SP number
4941    
4942          / FX_SEND SP sampler_channel SP fx_send_id
4943    
4944     load_instruction =     load_instruction =
4945    
4946        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
# Line 4584  Internet-Draft        LinuxSampler Contr Line 4974  Internet-Draft        LinuxSampler Contr
4974    
4975        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
4976    
4977          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
4978    
4979    
4980    
4981    
4982    
4983  Schoenebeck               Expires June 18, 2007                [Page 82]  Schoenebeck               Expires July 2, 2007                 [Page 89]
4984    
4985  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4986    
4987    
       / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map  
   
4988        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE        / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
4989    
4990        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
# Line 4631  Internet-Draft        LinuxSampler Contr Line 5021  Internet-Draft        LinuxSampler Contr
5021    
5022        / MIDI_INSTRUMENT_MAPS        / MIDI_INSTRUMENT_MAPS
5023    
5024          / FX_SENDS SP sampler_channel
5025    
5026     load_instr_args =     load_instr_args =
5027    
5028        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 4644  Internet-Draft        LinuxSampler Contr Line 5036  Internet-Draft        LinuxSampler Contr
5036    
5037    
5038    
5039  Schoenebeck               Expires June 18, 2007                [Page 83]  Schoenebeck               Expires July 2, 2007                 [Page 90]
5040    
5041  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5042    
# Line 4695  Internet-Draft        LinuxSampler Contr Line 5087  Internet-Draft        LinuxSampler Contr
5087    
5088        number        number
5089    
5090     volume_value =     midi_ctrl =
5091    
5092    
5093    
5094    
5095  Schoenebeck               Expires June 18, 2007                [Page 84]  Schoenebeck               Expires July 2, 2007                 [Page 91]
5096    
5097  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5098    
5099    
5100          number
5101    
5102       volume_value =
5103    
5104        dotnum        dotnum
5105    
5106        / number        / number
# Line 4717  Internet-Draft        LinuxSampler Contr Line 5113  Internet-Draft        LinuxSampler Contr
5113    
5114        number        number
5115    
5116       fx_send_id =
5117    
5118          number
5119    
5120     engine_name =     engine_name =
5121    
5122        string        string
# Line 4733  Internet-Draft        LinuxSampler Contr Line 5133  Internet-Draft        LinuxSampler Contr
5133    
5134        stringval        stringval
5135    
5136       fx_send_name =
5137    
5138          stringval
5139    
5140     param_val_list =     param_val_list =
5141    
5142        param_val        param_val
# Line 4741  Internet-Draft        LinuxSampler Contr Line 5145  Internet-Draft        LinuxSampler Contr
5145    
5146     param_val =     param_val =
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires July 2, 2007                 [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol        December 2006
5154    
5155    
5156        string        string
5157    
5158        / stringval        / stringval
# Line 4756  Internet-Draft        LinuxSampler Contr Line 5168  Internet-Draft        LinuxSampler Contr
5168    
5169    
5170    
5171  Schoenebeck               Expires June 18, 2007                [Page 85]  
5172    
5173    
5174    
5175    
5176    
5177    
5178    
5179    
5180    
5181    
5182    
5183    
5184    
5185    
5186    
5187    
5188    
5189    
5190    
5191    
5192    
5193    
5194    
5195    
5196    
5197    
5198    
5199    
5200    
5201    
5202    
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires July 2, 2007                 [Page 93]
5208    
5209  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5210    
# Line 4766  Internet-Draft        LinuxSampler Contr Line 5214  Internet-Draft        LinuxSampler Contr
5214     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
5215     LinuxSampler.     LinuxSampler.
5216    
5217  8.1.  Number of sampler channels changed  8.1.  Number of audio output devices changed
5218    
5219       Client may want to be notified when the total number of audio output
5220       devices on the back-end changes by issuing the following command:
5221    
5222          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
5223    
5224       Server will start sending the following notification messages:
5225    
5226          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
5227    
5228       where <devices> will be replaced by the new number of audio output
5229       devices.
5230    
5231    8.2.  Audio output device's settings changed
5232    
5233       Client may want to be notified when changes were made to audio output
5234       devices on the back-end by issuing the following command:
5235    
5236          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
5237    
5238       Server will start sending the following notification messages:
5239    
5240          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
5241    
5242       where <device-id> will be replaced by the numerical ID of the audio
5243       output device, which settings has been changed.  The front-end will
5244       have to send the respective command to actually get the audio output
5245       device info.  Because these messages will be triggered by LSCP
5246       commands issued by other clients rather than real time events
5247       happening on the server, it is believed that an empty notification
5248       message is sufficient here.
5249    
5250    8.3.  Number of MIDI input devices changed
5251    
5252       Client may want to be notified when the total number of MIDI input
5253       devices on the back-end changes by issuing the following command:
5254    
5255          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
5256    
5257       Server will start sending the following notification messages:
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires July 2, 2007                 [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol        December 2006
5266    
5267    
5268          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
5269    
5270       where <devices> will be replaced by the new number of MIDI input
5271       devices.
5272    
5273    8.4.  MIDI input device's settings changed
5274    
5275       Client may want to be notified when changes were made to MIDI input
5276       devices on the back-end by issuing the following command:
5277    
5278          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
5279    
5280       Server will start sending the following notification messages:
5281    
5282          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
5283    
5284       where <device-id> will be replaced by the numerical ID of the MIDI
5285       input device, which settings has been changed.  The front-end will
5286       have to send the respective command to actually get the MIDI input
5287       device info.  Because these messages will be triggered by LSCP
5288       commands issued by other clients rather than real time events
5289       happening on the server, it is believed that an empty notification
5290       message is sufficient here.
5291    
5292    8.5.  Number of sampler channels changed
5293    
5294     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
5295     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 5303  Internet-Draft        LinuxSampler Contr
5303     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
5304     channels.     channels.
5305    
5306  8.2.  Number of active voices changed  8.6.  Number of active voices changed
5307    
5308     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-
5309     end changes by issuing the following command:     end changes by issuing the following command:
# Line 4789  Internet-Draft        LinuxSampler Contr Line 5312  Internet-Draft        LinuxSampler Contr
5312    
5313     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires July 2, 2007                 [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol        December 2006
5322    
5323    
5324        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>
5325    
5326     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5327     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
5328     voices on that channel.     voices on that channel.
5329    
5330  8.3.  Number of active disk streams changed  8.7.  Number of active disk streams changed
5331    
5332     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
5333     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 5341  Internet-Draft        LinuxSampler Contr
5341    
5342     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5343     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  
   
   
5344     active disk streams on that channel.     active disk streams on that channel.
5345    
5346  8.4.  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
5347    
5348     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
5349     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 5360  Internet-Draft        LinuxSampler Contr
5360     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
5361     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
5362    
5363  8.5.  Channel information changed  8.9.  Channel information changed
5364    
5365     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
5366     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 5369  Internet-Draft        LinuxSampler Contr
5369    
5370     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires July 2, 2007                 [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol        December 2006
5378    
5379    
5380        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
5381    
5382     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 5386  Internet-Draft        LinuxSampler Contr
5386     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
5387     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
5388    
5389  8.6.  Total number of active voices changed  8.10.  Total number of active voices changed
5390    
5391     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
5392     back-end changes by issuing the following command:     back-end changes by issuing the following command:
# Line 4863  Internet-Draft        LinuxSampler Contr Line 5395  Internet-Draft        LinuxSampler Contr
5395    
5396     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5397    
5398          "NOTIFY:TOTAL_VOICE_COUNT:<voices>
5399    
5400       where <voices> will be replaced by the new number of all currently
5401       active voices.
5402    
5403    8.11.  Number of MIDI instrument maps changed
5404    
5405       Client may want to be notified when the number of MIDI instrument
5406       maps on the back-end changes by issuing the following command:
5407    
5408          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
5409    
5410       Server will start sending the following notification messages:
5411    
5412          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
5413    
5414       where <maps> will be replaced by the new number of MIDI instrument
5415       maps.
5416    
5417    8.12.  MIDI instrument map information changed
5418    
5419       Client may want to be notified when changes were made to MIDI
5420       instrument maps on the back-end by issuing the following command:
5421    
5422          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
5423    
5424       Server will start sending the following notification messages:
5425    
5426  Schoenebeck               Expires June 18, 2007                [Page 87]  
5427    
5428    
5429    
5430    
5431    Schoenebeck               Expires July 2, 2007                 [Page 97]
5432    
5433  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5434    
5435    
5436        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
5437    
5438     where <voices> will be replaced by the new number of all currently     where <map-id> will be replaced by the numerical ID of the MIDI
5439     active voices.     instrument map, for which information changes occurred.  The front-
5440       end will have to send the respective command to actually get the MIDI
5441       instrument map info.  Because these messages will be triggered by
5442       LSCP commands issued by other clients rather than real time events
5443       happening on the server, it is believed that an empty notification
5444       message is sufficient here.
5445    
5446    8.13.  Number of MIDI instruments changed
5447    
5448       Client may want to be notified when the number of MIDI instrument
5449       maps on the back-end changes by issuing the following command:
5450    
5451          SUBSCRIBE MIDI_INSTRUMENT_COUNT
5452    
5453       Server will start sending the following notification messages:
5454    
5455          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
5456    
5457       where <map-id> is the numerical ID of the MIDI instrument map, in
5458       which the nuber of instruments has changed and <instruments> will be
5459       replaced by the new number of MIDI instruments in the specified map.
5460    
5461    8.14.  MIDI instrument information changed
5462    
5463       Client may want to be notified when changes were made to MIDI
5464       instruments on the back-end by issuing the following command:
5465    
5466          SUBSCRIBE MIDI_INSTRUMENT_INFO
5467    
5468       Server will start sending the following notification messages:
5469    
5470          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
5471    
5472       where <map-id> will be replaced by the numerical ID of the MIDI
5473       instrument map, in which a MIDI instrument is changed. <bank> and
5474       <program> specifies the location of the changed MIDI instrument in
5475       the map.  The front-end will have to send the respective command to
5476       actually get the MIDI instrument info.  Because these messages will
5477       be triggered by LSCP commands issued by other clients rather than
5478       real time events happening on the server, it is believed that an
5479       empty notification message is sufficient here.
5480    
5481  8.7.  Miscellaneous and debugging events  
5482    
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires July 2, 2007                 [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol        December 2006
5490    
5491    
5492    8.15.  Miscellaneous and debugging events
5493    
5494     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
5495     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 4924  Internet-Draft        LinuxSampler Contr Line 5535  Internet-Draft        LinuxSampler Contr
5535    
5536    
5537    
5538  Schoenebeck               Expires June 18, 2007                [Page 88]  
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires July 2, 2007                 [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5546    
# Line 4980  Internet-Draft        LinuxSampler Contr Line 5596  Internet-Draft        LinuxSampler Contr
5596    
5597    
5598    
5599  Schoenebeck               Expires June 18, 2007                [Page 89]  Schoenebeck               Expires July 2, 2007                [Page 100]
5600    
5601  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5602    
# Line 5036  Internet-Draft        LinuxSampler Contr Line 5652  Internet-Draft        LinuxSampler Contr
5652    
5653    
5654    
5655  Schoenebeck               Expires June 18, 2007                [Page 90]  Schoenebeck               Expires July 2, 2007                [Page 101]
5656    
5657  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5658    
# Line 5092  Internet-Draft        LinuxSampler Contr Line 5708  Internet-Draft        LinuxSampler Contr
5708    
5709    
5710    
5711  Schoenebeck               Expires June 18, 2007                [Page 91]  Schoenebeck               Expires July 2, 2007                [Page 102]
5712    
5713  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5714    
# Line 5148  Author's Address Line 5764  Author's Address
5764    
5765    
5766    
5767  Schoenebeck               Expires June 18, 2007                [Page 92]  Schoenebeck               Expires July 2, 2007                [Page 103]
5768    
5769  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5770    
# Line 5204  Acknowledgment Line 5820  Acknowledgment
5820    
5821    
5822    
5823  Schoenebeck               Expires June 18, 2007                [Page 93]  Schoenebeck               Expires July 2, 2007                [Page 104]
5824    
Legend:
Removed from v.974  
changed lines
  Added in v.1006
  ViewVC Help
Powered by ViewVC