/[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 993 by iliev, Wed Dec 20 19:56:43 2006 UTC revision 1028 by schoenebeck, Sun Jan 14 17:33:03 2007 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: June 23, 2007                                 December 20, 2006  Expires: July 18, 2007                                  January 14, 2007
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
# Line 33  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on June 23, 2007.     This Internet-Draft will expire on July 18, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2006).     Copyright (C) The Internet Society (2007).
41    
42    
43    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck               Expires June 23, 2007                 [Page 1]  Schoenebeck               Expires July 18, 2007                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
58    
59    
60  Abstract  Abstract
# Line 68  Abstract Line 68  Abstract
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  5     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   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 23, 2007                 [Page 2]  Schoenebeck               Expires July 18, 2007                 [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
114    
115    
116         6.3.8.  Getting all created MIDI input device list . . . . . . 36         6.3.8.  Getting all created MIDI input device list  . . . . .  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. Altering effect send's MIDI controller  . . . . . . .  66
156           6.4.32. Altering effect send's send level . . . . . . . . . .  67
157           6.4.33. Resetting a sampler channel . . . . . . . . . . . . .  68
158         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  68
159           6.5.1.  Register front-end for receiving event messages . . .  68
160         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
161                 messages . . . . . . . . . . . . . . . . . . . . . . . 62                 messages  . . . . . . . . . . . . . . . . . . . . . .  69
162         6.5.3.  Enable or disable echo of commands . . . . . . . . . . 63         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  70
163         6.5.4.  Close client connection  . . . . . . . . . . . . . . . 63         6.5.4.  Close client connection . . . . . . . . . . . . . . .  70
      6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 64  
        6.6.1.  Current number of active voices  . . . . . . . . . . . 64  
        6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 64  
        6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 64  
        6.6.4.  General sampler informations . . . . . . . . . . . . . 65  
      6.7.  MIDI Instrument Mapping  . . . . . . . . . . . . . . . . . 65  
        6.7.1.  Create a new MIDI instrument map . . . . . . . . . . . 66  
        6.7.2.  Delete one particular or all MIDI instrument maps  . . 67  
164    
165    
166    
167  Schoenebeck               Expires June 23, 2007                 [Page 3]  Schoenebeck               Expires July 18, 2007                 [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
170    
171    
172         6.7.3.  Get amount of existing MIDI instrument maps  . . . . . 67       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  71
173         6.7.4.  Getting all created MIDI instrument maps . . . . . . . 68         6.6.1.  Current number of active voices . . . . . . . . . . .  71
174         6.7.5.  Getting MIDI instrument map information  . . . . . . . 68         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  71
175         6.7.6.  Renaming a MIDI instrument map . . . . . . . . . . . . 69         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  71
176         6.7.7.  Create or replace a MIDI instrument map entry  . . . . 69         6.6.4.  General sampler informations  . . . . . . . . . . . .  72
177         6.7.8.  Getting ammount of MIDI instrument map entries . . . . 72         6.6.5.  Getting global volume attenuation . . . . . . . . . .  72
178           6.6.6.  Setting global volume attenuation . . . . . . . . . .  73
179         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  73
180           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  74
181           6.7.2.  Delete one particular or all MIDI instrument maps . .  75
182           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  75
183           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  76
184           6.7.5.  Getting MIDI instrument map information . . . . . . .  76
185           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  77
186           6.7.7.  Create or replace a MIDI instrument map entry . . . .  77
187           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  80
188         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
189                 instrument map . . . . . . . . . . . . . . . . . . . . 73                 instrument map  . . . . . . . . . . . . . . . . . . .  81
190         6.7.10. Remove an entry from the MIDI instrument map . . . . . 73         6.7.10. Remove an entry from the MIDI instrument map  . . . .  81
191         6.7.11. Get current settings of MIDI instrument map entry  . . 74         6.7.11. Get current settings of MIDI instrument map entry . .  82
192         6.7.12. Clear MIDI instrument map  . . . . . . . . . . . . . . 76         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  84
193     7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 77     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  85
194     8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  96
195       8.1.  Number of audio output devices changed . . . . . . . . . . 87       8.1.  Number of audio output devices changed  . . . . . . . . .  96
196       8.2.  Audio output device's settings changed . . . . . . . . . . 87       8.2.  Audio output device's settings changed  . . . . . . . . .  96
197       8.3.  Number of MIDI input devices changed . . . . . . . . . . . 87       8.3.  Number of MIDI input devices changed  . . . . . . . . . .  96
198       8.4.  MIDI input device's settings changed . . . . . . . . . . . 88       8.4.  MIDI input device's settings changed  . . . . . . . . . .  97
199       8.5.  Number of sampler channels changed . . . . . . . . . . . . 88       8.5.  Number of sampler channels changed  . . . . . . . . . . .  97
200       8.6.  Number of active voices changed  . . . . . . . . . . . . . 88       8.6.  Number of active voices changed . . . . . . . . . . . . .  97
201       8.7.  Number of active disk streams changed  . . . . . . . . . . 89       8.7.  Number of active disk streams changed . . . . . . . . . .  98
202       8.8.  Disk stream buffer fill state changed  . . . . . . . . . . 89       8.8.  Disk stream buffer fill state changed . . . . . . . . . .  98
203       8.9.  Channel information changed  . . . . . . . . . . . . . . . 89       8.9.  Channel information changed . . . . . . . . . . . . . . .  98
204       8.10. Total number of active voices changed  . . . . . . . . . . 90       8.10. Total number of active voices changed . . . . . . . . . .  99
205       8.11. Number of MIDI instrument maps changed . . . . . . . . . . 90       8.11. Number of MIDI instrument maps changed  . . . . . . . . .  99
206       8.12. MIDI instrument map information changed  . . . . . . . . . 90       8.12. MIDI instrument map information changed . . . . . . . . .  99
207       8.13. Number of MIDI instruments changed . . . . . . . . . . . . 91       8.13. Number of MIDI instruments changed  . . . . . . . . . . . 100
208       8.14. MIDI instrument information changed  . . . . . . . . . . . 91       8.14. MIDI instrument information changed . . . . . . . . . . . 100
209       8.15. Miscellaneous and debugging events . . . . . . . . . . . . 92       8.15. Miscellaneous and debugging events  . . . . . . . . . . . 101
210     9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 93     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 102
211     10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 94     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 103
212     11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 95     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 104
213     Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 96     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 105
214     Intellectual Property and Copyright Statements . . . . . . . . . . 97     Intellectual Property and Copyright Statements  . . . . . . . . . 106
215    
216    
217    
# Line 210  Internet-Draft        LinuxSampler Contr Line 220  Internet-Draft        LinuxSampler Contr
220    
221    
222    
223    Schoenebeck               Expires July 18, 2007                 [Page 4]
   
   
   
   
   
   
   
   
   
 Schoenebeck               Expires June 23, 2007                 [Page 4]  
224    
225  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
226    
227    
228  1.  Requirements notation  1.  Requirements notation
# Line 276  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck               Expires June 23, 2007                 [Page 5]  Schoenebeck               Expires July 18, 2007                 [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
282    
283    
284  2.  Versioning of this specification  2.  Versioning of this specification
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires June 23, 2007                 [Page 6]  Schoenebeck               Expires July 18, 2007                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
338    
339    
340  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires June 23, 2007                 [Page 7]  Schoenebeck               Expires July 18, 2007                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
394    
395    
396  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires June 23, 2007                 [Page 8]  Schoenebeck               Expires July 18, 2007                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
450    
451    
452  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires June 23, 2007                 [Page 9]  Schoenebeck               Expires July 18, 2007                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
506    
507    
508  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires June 23, 2007                [Page 10]  Schoenebeck               Expires July 18, 2007                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
562    
563    
564     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires June 23, 2007                [Page 11]  Schoenebeck               Expires July 18, 2007                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
618    
619    
620     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires June 23, 2007                [Page 12]  Schoenebeck               Expires July 18, 2007                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
674    
675    
676         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires June 23, 2007                [Page 13]  Schoenebeck               Expires July 18, 2007                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
730    
731    
732  6.  Description for control commands  6.  Description for control commands
# Line 780  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck               Expires June 23, 2007                [Page 14]  Schoenebeck               Expires July 18, 2007                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
786    
787    
788  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 836  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck               Expires June 23, 2007                [Page 15]  Schoenebeck               Expires July 18, 2007                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
842    
843    
844        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires June 23, 2007                [Page 16]  Schoenebeck               Expires July 18, 2007                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
898    
899    
900     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires June 23, 2007                [Page 17]  Schoenebeck               Expires July 18, 2007                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
954    
955    
956        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires June 23, 2007                [Page 18]  Schoenebeck               Expires July 18, 2007                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1010    
1011    
1012           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires June 23, 2007                [Page 19]  Schoenebeck               Expires July 18, 2007                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1066    
1067    
1068           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires June 23, 2007                [Page 20]  Schoenebeck               Expires July 18, 2007                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1122    
1123    
1124           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires June 23, 2007                [Page 21]  Schoenebeck               Expires July 18, 2007                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1178    
1179    
1180        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires June 23, 2007                [Page 22]  Schoenebeck               Expires July 18, 2007                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1234    
1235    
1236     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires June 23, 2007                [Page 23]  Schoenebeck               Expires July 18, 2007                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1290    
1291    
1292           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck               Expires June 23, 2007                [Page 24]  Schoenebeck               Expires July 18, 2007                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1346    
1347    
1348  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck               Expires June 23, 2007                [Page 25]  Schoenebeck               Expires July 18, 2007                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1402    
1403    
1404     Examples:     Examples:
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck               Expires June 23, 2007                [Page 26]  Schoenebeck               Expires July 18, 2007                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1458    
1459    
1460     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck               Expires June 23, 2007                [Page 27]  Schoenebeck               Expires July 18, 2007                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1514    
1515    
1516           RANGE_MAX -           RANGE_MAX -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires June 23, 2007                [Page 28]  Schoenebeck               Expires July 18, 2007                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1570    
1571    
1572        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires June 23, 2007                [Page 29]  Schoenebeck               Expires July 18, 2007                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1626    
1627    
1628     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck               Expires June 23, 2007                [Page 30]  Schoenebeck               Expires July 18, 2007                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1682    
1683    
1684  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck               Expires June 23, 2007                [Page 31]  Schoenebeck               Expires July 18, 2007                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1738    
1739    
1740  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck               Expires June 23, 2007                [Page 32]  Schoenebeck               Expires July 18, 2007                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1794    
1795    
1796        FIX -        FIX -
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck               Expires June 23, 2007                [Page 33]  Schoenebeck               Expires July 18, 2007                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1850    
1851    
1852           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck               Expires June 23, 2007                [Page 34]  Schoenebeck               Expires July 18, 2007                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1906    
1907    
1908        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 1956  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck               Expires June 23, 2007                [Page 35]  Schoenebeck               Expires July 18, 2007                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1962    
1963    
1964           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck               Expires June 23, 2007                [Page 36]  Schoenebeck               Expires July 18, 2007                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2018    
2019    
2020  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck               Expires June 23, 2007                [Page 37]  Schoenebeck               Expires July 18, 2007                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2074    
2075    
2076           "ACTIVE: true"           "ACTIVE: true"
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck               Expires June 23, 2007                [Page 38]  Schoenebeck               Expires July 18, 2007                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2130    
2131    
2132     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck               Expires June 23, 2007                [Page 39]  Schoenebeck               Expires July 18, 2007                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2186    
2187    
2188        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck               Expires June 23, 2007                [Page 40]  Schoenebeck               Expires July 18, 2007                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2242    
2243    
2244           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck               Expires June 23, 2007                [Page 41]  Schoenebeck               Expires July 18, 2007                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2298    
2299    
2300           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck               Expires June 23, 2007                [Page 42]  Schoenebeck               Expires July 18, 2007                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2354    
2355    
2356           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck               Expires June 23, 2007                [Page 43]  Schoenebeck               Expires July 18, 2007                [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2410    
2411    
2412     Example:     Example:
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck               Expires June 23, 2007                [Page 44]  Schoenebeck               Expires July 18, 2007                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2466    
2467    
2468        ADD CHANNEL        ADD CHANNEL
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck               Expires June 23, 2007                [Page 45]  Schoenebeck               Expires July 18, 2007                [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2522    
2523    
2524        "OK" -        "OK" -
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck               Expires June 23, 2007                [Page 46]  Schoenebeck               Expires July 18, 2007                [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2578    
2579    
2580        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires June 23, 2007                [Page 47]  Schoenebeck               Expires July 18, 2007                [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2634    
2635    
2636           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires June 23, 2007                [Page 48]  Schoenebeck               Expires July 18, 2007                [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2690    
2691    
2692              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires June 23, 2007                [Page 49]  Schoenebeck               Expires July 18, 2007                [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2746    
2747    
2748           MUTE -           MUTE -
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck               Expires June 23, 2007                [Page 50]  Schoenebeck               Expires July 18, 2007                [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2802    
2803    
2804           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
# Line 2852  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855  Schoenebeck               Expires June 23, 2007                [Page 51]  Schoenebeck               Expires July 18, 2007                [Page 51]
2856    
2857  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2858    
2859    
2860        return "NA" for not available.        return "NA" for not available.
# Line 2908  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911  Schoenebeck               Expires June 23, 2007                [Page 52]  Schoenebeck               Expires July 18, 2007                [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2914    
2915    
2916        S: ""        S: ""
# Line 2964  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck               Expires June 23, 2007                [Page 53]  Schoenebeck               Expires July 18, 2007                [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2970    
2971    
2972     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
# Line 3020  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck               Expires June 23, 2007                [Page 54]  Schoenebeck               Expires July 18, 2007                [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3026    
3027    
3028           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck               Expires June 23, 2007                [Page 55]  Schoenebeck               Expires July 18, 2007                [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3082    
3083    
3084  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
# Line 3132  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck               Expires June 23, 2007                [Page 56]  Schoenebeck               Expires July 18, 2007                [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3138    
3139    
3140           on success           on success
# Line 3188  Internet-Draft        LinuxSampler Contr Line 3188  Internet-Draft        LinuxSampler Contr
3188    
3189    
3190    
3191  Schoenebeck               Expires June 23, 2007                [Page 57]  Schoenebeck               Expires July 18, 2007                [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3194    
3195    
3196    
# Line 3244  Internet-Draft        LinuxSampler Contr Line 3244  Internet-Draft        LinuxSampler Contr
3244    
3245    
3246    
3247  Schoenebeck               Expires June 23, 2007                [Page 58]  Schoenebeck               Expires July 18, 2007                [Page 58]
3248    
3249  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3250    
3251    
3252        "OK" -        "OK" -
# Line 3300  Internet-Draft        LinuxSampler Contr Line 3300  Internet-Draft        LinuxSampler Contr
3300    
3301    
3302    
3303  Schoenebeck               Expires June 23, 2007                [Page 59]  Schoenebeck               Expires July 18, 2007                [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3306    
3307    
3308     Examples:     Examples:
# Line 3356  Internet-Draft        LinuxSampler Contr Line 3356  Internet-Draft        LinuxSampler Contr
3356    
3357    
3358    
3359  Schoenebeck               Expires June 23, 2007                [Page 60]  Schoenebeck               Expires July 18, 2007                [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3362    
3363    
3364     Examples:     Examples:
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 18, 2007                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol         January 2007
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 18, 2007                [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol         January 2007
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 18, 2007                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol         January 2007
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             MIDI_CONTROLLER -
3560    
3561                a value between 0 and 127 reflecting the MIDI controller
3562                which is able to modify the effect send's send level
3563    
3564             LEVEL -
3565    
3566                optionally dotted number reflecting the effect send's
3567                current send level (where a value < 1.0 means attenuation
3568                and a value > 1.0 means amplification)
3569    
3570             AUDIO_OUTPUT_ROUTING -
3571    
3572                comma separated list which reflects to which audio channel
3573                of the selected audio output device each effect send output
3574                channel is routed to, e.g. "0,3" would mean the effect
3575                send's output channel 0 is routed to channel 0 of the audio
3576                output device and the effect send's output channel 1 is
3577                routed to the channel 3 of the audio output device (see "SET
3578                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires July 18, 2007                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol         January 2007
3586    
3587    
3588       The mentioned fields above don't have to be in particular order.
3589    
3590       Example:
3591    
3592          C: "GET FX_SEND INFO 0 0"
3593    
3594          S: "NAME: Reverb Send"
3595    
3596             "MIDI_CONTROLLER: 91"
3597    
3598             "LEVEL: 0.3"
3599    
3600             "AUDIO_OUTPUT_ROUTING: 2,3"
3601    
3602             "."
3603    
3604    6.4.30.  Altering effect send's audio routing
3605    
3606       The front-end can alter the destination of an effect send's audio
3607       channel on a specific sampler channel by sending the following
3608       command:
3609    
3610          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3611          <audio-src> <audio-dst>
3612    
3613       Where <sampler-chan> is the sampler channel number as returned by the
3614       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3615       command, <fx-send-id> reflects the numerical ID of the effect send
3616       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3617       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3618       of the effect send's audio channel which should be rerouted and
3619       <audio-dst> is the numerical ID of the audio channel of the selected
3620       audio output device where <audio-src> should be routed to.
3621    
3622       Note that effect sends can only route audio to the same audio output
3623       device as assigned to the effect send's sampler channel.  Also note
3624       that an effect send entity does always have exactly as much audio
3625       channels as its sampler channel.  So if the sampler channel is
3626       stereo, the effect send does have two audio channels as well.  Also
3627       keep in mind that the amount of audio channels on a sampler channel
3628       might be dependant not only to the deployed sampler engine on the
3629       sampler channel, but also dependant to the instrument currently
3630       loaded.  However you can (effectively) turn an i.e. stereo effect
3631       send into a mono one by simply altering its audio routing
3632       appropriately.
3633    
3634       Possible Answers:
3635    
3636    
3637    
3638    
3639    Schoenebeck               Expires July 18, 2007                [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol         January 2007
3642    
3643    
3644          "OK" -
3645    
3646             on success
3647    
3648          "WRN:<warning-code>:<warning-message>" -
3649    
3650             if audio output channel was set, but there are noteworthy
3651             issue(s) related, providing an appropriate warning code and
3652             warning message
3653    
3654          "ERR:<error-code>:<error-message>" -
3655    
3656             in case it failed, providing an appropriate error code and
3657             error message
3658    
3659       Example:
3660    
3661          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3662    
3663          S: "OK"
3664    
3665    6.4.31.  Altering effect send's MIDI controller
3666    
3667       The front-end can alter the MIDI controller of an effect send entity
3668       by sending the following command:
3669    
3670          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3671          ctrl>
3672    
3673       Where <sampler-chan> is the sampler channel number as returned by the
3674       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3675       command, <fx-send-id> reflects the numerical ID of the effect send
3676       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3677       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3678       controller which shall be able to modify the effect send's send
3679       level.
3680    
3681       Possible Answers:
3682    
3683          "OK" -
3684    
3685             on success
3686    
3687          "WRN:<warning-code>:<warning-message>" -
3688    
3689             if MIDI controller was set, but there are noteworthy issue(s)
3690             related, providing an appropriate warning code and warning
3691             message
3692    
3693    
3694    
3695    Schoenebeck               Expires July 18, 2007                [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol         January 2007
3698    
3699    
3700          "ERR:<error-code>:<error-message>" -
3701    
3702             in case it failed, providing an appropriate error code and
3703             error message
3704    
3705       Example:
3706    
3707          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3708    
3709          S: "OK"
3710    
3711    6.4.32.  Altering effect send's send level
3712    
3713       The front-end can alter the current send level of an effect send
3714       entity by sending the following command:
3715    
3716          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3717    
3718       Where <sampler-chan> is the sampler channel number as returned by the
3719       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3720       command, <fx-send-id> reflects the numerical ID of the effect send
3721       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3722       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3723       dotted positive number (a value smaller than 1.0 means attenuation,
3724       whereas a value greater than 1.0 means amplification) reflecting the
3725       new send level.
3726    
3727       Possible Answers:
3728    
3729          "OK" -
3730    
3731             on success
3732    
3733          "WRN:<warning-code>:<warning-message>" -
3734    
3735             if new send level was set, but there are noteworthy issue(s)
3736             related, providing an appropriate warning code and warning
3737             message
3738    
3739          "ERR:<error-code>:<error-message>" -
3740    
3741             in case it failed, providing an appropriate error code and
3742             error message
3743    
3744       Example:
3745    
3746    
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires July 18, 2007                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol         January 2007
3754    
3755    
3756          C: "SET FX_SEND LEVEL 0 0 0.15"
3757    
3758          S: "OK"
3759    
3760    6.4.33.  Resetting a sampler channel
3761    
3762     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3763     following command:     following command:
# Line 3412  Internet-Draft        LinuxSampler Contr Line 3804  Internet-Draft        LinuxSampler Contr
3804    
3805    
3806    
3807  Schoenebeck               Expires June 23, 2007                [Page 61]  Schoenebeck               Expires July 18, 2007                [Page 68]
3808    
3809  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3810    
3811    
3812        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
# Line 3468  Internet-Draft        LinuxSampler Contr Line 3860  Internet-Draft        LinuxSampler Contr
3860    
3861    
3862    
3863  Schoenebeck               Expires June 23, 2007                [Page 62]  Schoenebeck               Expires July 18, 2007                [Page 69]
3864    
3865  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3866    
3867    
3868        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3524  Internet-Draft        LinuxSampler Contr Line 3916  Internet-Draft        LinuxSampler Contr
3916    
3917    
3918    
3919  Schoenebeck               Expires June 23, 2007                [Page 63]  Schoenebeck               Expires July 18, 2007                [Page 70]
3920    
3921  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3922    
3923    
3924  6.6.  Global commands  6.6.  Global commands
# Line 3580  Internet-Draft        LinuxSampler Contr Line 3972  Internet-Draft        LinuxSampler Contr
3972    
3973    
3974    
3975  Schoenebeck               Expires June 23, 2007                [Page 64]  Schoenebeck               Expires July 18, 2007                [Page 71]
3976    
3977  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3978    
3979    
3980  6.6.4.  General sampler informations  6.6.4.  General sampler informations
# Line 3618  Internet-Draft        LinuxSampler Contr Line 4010  Internet-Draft        LinuxSampler Contr
4010     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4011     Other fields might be added in future.     Other fields might be added in future.
4012    
4013    6.6.5.  Getting global volume attenuation
4014    
4015       The client can ask for the current global sampler-wide volume
4016       attenuation by sending the following command:
4017    
4018          GET VOLUME
4019    
4020       Possible Answers:
4021    
4022          The sampler will always answer by returning the optional dotted
4023          floating point coefficient, reflecting the current global volume
4024          attenuation.
4025    
4026       Note: it is up to the respective sampler engine whether to obey that
4027       global volume parameter or not, but in general all engines SHOULD use
4028    
4029    
4030    
4031    Schoenebeck               Expires July 18, 2007                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol         January 2007
4034    
4035    
4036       this parameter.
4037    
4038    6.6.6.  Setting global volume attenuation
4039    
4040       The client can alter the current global sampler-wide volume
4041       attenuation by sending the following command:
4042    
4043          SET VOLUME <volume>
4044    
4045       Where <volume> should be replaced by the optional dotted floating
4046       point value, reflecting the new global volume parameter.  This value
4047       might usually be in the range between 0.0 and 1.0, that is for
4048       attenuating the overall volume.
4049    
4050       Possible Answers:
4051    
4052          "OK" -
4053    
4054             on success
4055    
4056          "WRN:<warning-code>:<warning-message>" -
4057    
4058             if the global volume was set, but there are noteworthy issue(s)
4059             related, providing an appropriate warning code and warning
4060             message
4061    
4062          "ERR:<error-code>:<error-message>" -
4063    
4064             in case it failed, providing an appropriate error code and
4065             error message
4066    
4067  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4068    
4069     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 4079  Internet-Draft        LinuxSampler Contr
4079     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,
4080     thus the sampler will simply ignore all program change messages.  The     thus the sampler will simply ignore all program change messages.  The
4081     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
4082       the map and tell the respective sampler channel(s) which MIDI
4083       instrument map to use, so the sampler knows how to react on a given
4084    
4085    
4086    
4087  Schoenebeck               Expires June 23, 2007                [Page 65]  Schoenebeck               Expires July 18, 2007                [Page 73]
4088    
4089  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4090    
4091    
    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  
4092     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
4093     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
4094     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 4134  Internet-Draft        LinuxSampler Contr
4134    
4135        S: "OK[1]"        S: "OK[1]"
4136    
4137          C: "ADD MIDI_INSTRUMENT_MAP"
4138    
4139    
4140    
4141    
 Schoenebeck               Expires June 23, 2007                [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
4142    
4143    Schoenebeck               Expires July 18, 2007                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol         January 2007
4146    
       C: "ADD MIDI_INSTRUMENT_MAP"  
4147    
4148        S: "OK[5]"        S: "OK[5]"
4149    
# Line 3748  Internet-Draft        LinuxSampler Contr Line 4194  Internet-Draft        LinuxSampler Contr
4194    
4195    
4196    
4197  Schoenebeck               Expires June 23, 2007                [Page 67]  
4198    
4199    Schoenebeck               Expires July 18, 2007                [Page 75]
4200    
4201  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4202    
4203    
4204        The sampler will answer by returning the current number of MIDI        The sampler will answer by returning the current number of MIDI
# Line 3804  Internet-Draft        LinuxSampler Contr Line 4252  Internet-Draft        LinuxSampler Contr
4252    
4253    
4254    
4255  Schoenebeck               Expires June 23, 2007                [Page 68]  Schoenebeck               Expires July 18, 2007                [Page 76]
4256    
4257  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4258    
4259    
4260    
# Line 3860  Internet-Draft        LinuxSampler Contr Line 4308  Internet-Draft        LinuxSampler Contr
4308    
4309    
4310    
4311  Schoenebeck               Expires June 23, 2007                [Page 69]  Schoenebeck               Expires July 18, 2007                [Page 77]
4312    
4313  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4314    
4315    
4316        MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>        MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>
# Line 3916  Internet-Draft        LinuxSampler Contr Line 4364  Internet-Draft        LinuxSampler Contr
4364    
4365    
4366    
4367  Schoenebeck               Expires June 23, 2007                [Page 70]  Schoenebeck               Expires July 18, 2007                [Page 78]
4368    
4369  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4370    
4371    
4372        not supplied -        not supplied -
# Line 3972  Internet-Draft        LinuxSampler Contr Line 4420  Internet-Draft        LinuxSampler Contr
4420    
4421    
4422    
4423  Schoenebeck               Expires June 23, 2007                [Page 71]  Schoenebeck               Expires July 18, 2007                [Page 79]
4424    
4425  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4426    
4427    
4428        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
# Line 4028  Internet-Draft        LinuxSampler Contr Line 4476  Internet-Draft        LinuxSampler Contr
4476    
4477    
4478    
4479  Schoenebeck               Expires June 23, 2007                [Page 72]  Schoenebeck               Expires July 18, 2007                [Page 80]
4480    
4481  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4482    
4483    
4484        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
# Line 4084  Internet-Draft        LinuxSampler Contr Line 4532  Internet-Draft        LinuxSampler Contr
4532    
4533    
4534    
4535  Schoenebeck               Expires June 23, 2007                [Page 73]  Schoenebeck               Expires July 18, 2007                [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4538    
4539    
4540        "OK" -        "OK" -
# Line 4140  Internet-Draft        LinuxSampler Contr Line 4588  Internet-Draft        LinuxSampler Contr
4588    
4589    
4590    
4591  Schoenebeck               Expires June 23, 2007                [Page 74]  Schoenebeck               Expires July 18, 2007                [Page 82]
4592    
4593  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4594    
4595    
4596        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
# Line 4196  Internet-Draft        LinuxSampler Contr Line 4644  Internet-Draft        LinuxSampler Contr
4644    
4645    
4646    
4647  Schoenebeck               Expires June 23, 2007                [Page 75]  Schoenebeck               Expires July 18, 2007                [Page 83]
4648    
4649  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4650    
4651    
4652  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
# Line 4252  Internet-Draft        LinuxSampler Contr Line 4700  Internet-Draft        LinuxSampler Contr
4700    
4701    
4702    
4703  Schoenebeck               Expires June 23, 2007                [Page 76]  Schoenebeck               Expires July 18, 2007                [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4706    
4707    
4708  7.  Command Syntax  7.  Command Syntax
# Line 4308  Internet-Draft        LinuxSampler Contr Line 4756  Internet-Draft        LinuxSampler Contr
4756    
4757    
4758    
4759  Schoenebeck               Expires June 23, 2007                [Page 77]  Schoenebeck               Expires July 18, 2007                [Page 85]
4760    
4761  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4762    
4763    
4764        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4364  Internet-Draft        LinuxSampler Contr Line 4812  Internet-Draft        LinuxSampler Contr
4812    
4813    
4814    
4815  Schoenebeck               Expires June 23, 2007                [Page 78]  Schoenebeck               Expires July 18, 2007                [Page 86]
4816    
4817  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4818    
4819    
4820        / CHANNEL_INFO        / CHANNEL_INFO
# Line 4420  Internet-Draft        LinuxSampler Contr Line 4868  Internet-Draft        LinuxSampler Contr
4868    
4869    
4870    
4871  Schoenebeck               Expires June 23, 2007                [Page 79]  Schoenebeck               Expires July 18, 2007                [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4874    
4875    
4876        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
# Line 4476  Internet-Draft        LinuxSampler Contr Line 4924  Internet-Draft        LinuxSampler Contr
4924    
4925    
4926    
4927  Schoenebeck               Expires June 23, 2007                [Page 80]  Schoenebeck               Expires July 18, 2007                [Page 88]
4928    
4929  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4930    
4931    
4932        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
# Line 4526  Internet-Draft        LinuxSampler Contr Line 4974  Internet-Draft        LinuxSampler Contr
4974    
4975        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
4976    
4977     set_instruction =        / FX_SENDS SP sampler_channel
4978    
4979    
4980    
4981    
4982    
4983  Schoenebeck               Expires June 23, 2007                [Page 81]  Schoenebeck               Expires July 18, 2007                [Page 89]
4984    
4985  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4986    
4987    
4988          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
4989    
4990          / VOLUME
4991    
4992       set_instruction =
4993    
4994        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
4995        param_val_list        param_val_list
# Line 4553  Internet-Draft        LinuxSampler Contr Line 5007  Internet-Draft        LinuxSampler Contr
5007    
5008        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5009    
5010          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
5011          SP audio_channel_index SP audio_channel_index
5012    
5013          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
5014          midi_ctrl
5015    
5016          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
5017          volume_value
5018    
5019        / ECHO SP boolean        / ECHO SP boolean
5020    
5021          / VOLUME SP volume_value
5022    
5023     create_instruction =     create_instruction =
5024    
5025        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 4565  Internet-Draft        LinuxSampler Contr Line 5030  Internet-Draft        LinuxSampler Contr
5030    
5031        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
5032    
5033          / FX_SEND SP sampler_channel SP midi_ctrl
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires July 18, 2007                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol         January 2007
5042    
5043    
5044          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
5045    
5046     reset_instruction =     reset_instruction =
5047    
5048        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
# Line 4581  Internet-Draft        LinuxSampler Contr Line 5059  Internet-Draft        LinuxSampler Contr
5059    
5060        / MIDI_INPUT_DEVICE SP number        / MIDI_INPUT_DEVICE SP number
5061    
5062          / FX_SEND SP sampler_channel SP fx_send_id
5063    
5064     load_instruction =     load_instruction =
5065    
5066        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
5067    
   
   
   
 Schoenebeck               Expires June 23, 2007                [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
5068        / ENGINE SP load_engine_args        / ENGINE SP load_engine_args
5069    
5070     set_chan_instruction =     set_chan_instruction =
# Line 4616  Internet-Draft        LinuxSampler Contr Line 5088  Internet-Draft        LinuxSampler Contr
5088    
5089        / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name        / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires July 18, 2007                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol         January 2007
5098    
5099    
5100        / VOLUME SP sampler_channel SP volume_value        / VOLUME SP sampler_channel SP volume_value
5101    
5102        / MUTE SP sampler_channel SP boolean        / MUTE SP sampler_channel SP boolean
# Line 4642  Internet-Draft        LinuxSampler Contr Line 5123  Internet-Draft        LinuxSampler Contr
5123    
5124     list_instruction =     list_instruction =
5125    
   
   
 Schoenebeck               Expires June 23, 2007                [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
5126        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
5127    
5128        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 4667  Internet-Draft        LinuxSampler Contr Line 5141  Internet-Draft        LinuxSampler Contr
5141    
5142        / MIDI_INSTRUMENT_MAPS        / MIDI_INSTRUMENT_MAPS
5143    
5144          / FX_SENDS SP sampler_channel
5145    
5146     load_instr_args =     load_instr_args =
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires July 18, 2007                [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol         January 2007
5154    
5155    
5156        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
5157    
5158        / NON_MODAL SP filename SP instrument_index SP sampler_channel        / NON_MODAL SP filename SP instrument_index SP sampler_channel
# Line 4697  Internet-Draft        LinuxSampler Contr Line 5181  Internet-Draft        LinuxSampler Contr
5181    
5182        string        string
5183    
   
   
   
 Schoenebeck               Expires June 23, 2007                [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
   
5184     midi_input_port_index =     midi_input_port_index =
5185    
5186        number        number
# Line 4725  Internet-Draft        LinuxSampler Contr Line 5201  Internet-Draft        LinuxSampler Contr
5201    
5202     midi_bank =     midi_bank =
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires July 18, 2007                [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol         January 2007
5210    
5211    
5212        number        number
5213    
5214     midi_prog =     midi_prog =
5215    
5216        number        number
5217    
5218       midi_ctrl =
5219    
5220          number
5221    
5222     volume_value =     volume_value =
5223    
5224        dotnum        dotnum
# Line 4745  Internet-Draft        LinuxSampler Contr Line 5233  Internet-Draft        LinuxSampler Contr
5233    
5234        number        number
5235    
5236       fx_send_id =
5237    
5238          number
5239    
5240     engine_name =     engine_name =
5241    
5242        string        string
# Line 4753  Internet-Draft        LinuxSampler Contr Line 5245  Internet-Draft        LinuxSampler Contr
5245    
5246        stringval        stringval
5247    
5248       map_name =
5249    
5250          stringval
5251    
5252       entry_name =
5253    
5254  Schoenebeck               Expires June 23, 2007                [Page 85]        stringval
   
 Internet-Draft        LinuxSampler Control Protocol        December 2006  
   
5255    
5256     map_name =     fx_send_name =
5257    
5258        stringval        stringval
5259    
    entry_name =  
5260    
5261        stringval  
5262    
5263    Schoenebeck               Expires July 18, 2007                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol         January 2007
5266    
5267    
5268     param_val_list =     param_val_list =
5269    
# Line 4812  Internet-Draft        LinuxSampler Contr Line 5308  Internet-Draft        LinuxSampler Contr
5308    
5309    
5310    
5311  Schoenebeck               Expires June 23, 2007                [Page 86]  
5312    
5313    
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires July 18, 2007                [Page 95]
5320    
5321  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5322    
5323    
5324  8.  Events  8.  Events
# Line 4868  Internet-Draft        LinuxSampler Contr Line 5372  Internet-Draft        LinuxSampler Contr
5372    
5373    
5374    
5375  Schoenebeck               Expires June 23, 2007                [Page 87]  Schoenebeck               Expires July 18, 2007                [Page 96]
5376    
5377  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5378    
5379    
5380        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 4924  Internet-Draft        LinuxSampler Contr Line 5428  Internet-Draft        LinuxSampler Contr
5428    
5429    
5430    
5431  Schoenebeck               Expires June 23, 2007                [Page 88]  Schoenebeck               Expires July 18, 2007                [Page 97]
5432    
5433  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5434    
5435    
5436        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>
# Line 4980  Internet-Draft        LinuxSampler Contr Line 5484  Internet-Draft        LinuxSampler Contr
5484    
5485    
5486    
5487  Schoenebeck               Expires June 23, 2007                [Page 89]  Schoenebeck               Expires July 18, 2007                [Page 98]
5488    
5489  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5490    
5491    
5492        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 5036  Internet-Draft        LinuxSampler Contr Line 5540  Internet-Draft        LinuxSampler Contr
5540    
5541    
5542    
5543  Schoenebeck               Expires June 23, 2007                [Page 90]  Schoenebeck               Expires July 18, 2007                [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5546    
5547    
5548        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
# Line 5092  Internet-Draft        LinuxSampler Contr Line 5596  Internet-Draft        LinuxSampler Contr
5596    
5597    
5598    
5599  Schoenebeck               Expires June 23, 2007                [Page 91]  Schoenebeck               Expires July 18, 2007               [Page 100]
5600    
5601  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5602    
5603    
5604  8.15.  Miscellaneous and debugging events  8.15.  Miscellaneous and debugging events
# Line 5148  Internet-Draft        LinuxSampler Contr Line 5652  Internet-Draft        LinuxSampler Contr
5652    
5653    
5654    
5655  Schoenebeck               Expires June 23, 2007                [Page 92]  Schoenebeck               Expires July 18, 2007               [Page 101]
5656    
5657  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5658    
5659    
5660  9.  Security Considerations  9.  Security Considerations
# Line 5204  Internet-Draft        LinuxSampler Contr Line 5708  Internet-Draft        LinuxSampler Contr
5708    
5709    
5710    
5711  Schoenebeck               Expires June 23, 2007                [Page 93]  Schoenebeck               Expires July 18, 2007               [Page 102]
5712    
5713  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5714    
5715    
5716  10.  Acknowledgments  10.  Acknowledgments
# Line 5260  Internet-Draft        LinuxSampler Contr Line 5764  Internet-Draft        LinuxSampler Contr
5764    
5765    
5766    
5767  Schoenebeck               Expires June 23, 2007                [Page 94]  Schoenebeck               Expires July 18, 2007               [Page 103]
5768    
5769  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5770    
5771    
5772  11.  References  11.  References
# Line 5316  Internet-Draft        LinuxSampler Contr Line 5820  Internet-Draft        LinuxSampler Contr
5820    
5821    
5822    
5823  Schoenebeck               Expires June 23, 2007                [Page 95]  Schoenebeck               Expires July 18, 2007               [Page 104]
5824    
5825  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5826    
5827    
5828  Author's Address  Author's Address
# Line 5372  Author's Address Line 5876  Author's Address
5876    
5877    
5878    
5879  Schoenebeck               Expires June 23, 2007                [Page 96]  Schoenebeck               Expires July 18, 2007               [Page 105]
5880    
5881  Internet-Draft        LinuxSampler Control Protocol        December 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5882    
5883    
5884  Full Copyright Statement  Full Copyright Statement
5885    
5886     Copyright (C) The Internet Society (2006).     Copyright (C) The Internet Society (2007).
5887    
5888     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
5889     contained in BCP 78, and except as set forth therein, the authors     contained in BCP 78, and except as set forth therein, the authors
# Line 5428  Acknowledgment Line 5932  Acknowledgment
5932    
5933    
5934    
5935  Schoenebeck               Expires June 23, 2007                [Page 97]  Schoenebeck               Expires July 18, 2007               [Page 106]
5936    
Legend:
Removed from v.993  
changed lines
  Added in v.1028
  ViewVC Help
Powered by ViewVC