/[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 1110 by iliev, Thu Mar 22 21:12:10 2007 UTC revision 1189 by iliev, Wed May 16 14:42:04 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: September 23, 2007                               March 22, 2007  Expires: November 17, 2007                                  May 16, 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 September 23, 2007.     This Internet-Draft will expire on November 17, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
# Line 52  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55  Schoenebeck            Expires September 23, 2007               [Page 1]  Schoenebeck             Expires November 17, 2007               [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
58    
59    
60  Abstract  Abstract
# Line 68  Abstract Line 68  Abstract
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6
72     2.  Versioning of this specification  . . . . . . . . . . . . . .   6     2.  Versioning of this specification  . . . . . . . . . . . . . .   7
73     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8
74     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9
75     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10
76       5.1.  Request/response communication method . . . . . . . . . .   9       5.1.  Request/response communication method . . . . . . . . . .  10
77         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11
78       5.2.  Subscribe/notify communication method . . . . . . . . . .  12       5.2.  Subscribe/notify communication method . . . . . . . . . .  13
79     6.  Description for control commands  . . . . . . . . . . . . . .  14     6.  Description for control commands  . . . . . . . . . . . . . .  15
80       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15
81       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15
82         6.2.1.  Getting amount of available audio output drivers  . .  15         6.2.1.  Getting amount of available audio output drivers  . .  16
83         6.2.2.  Getting all available audio output drivers  . . . . .  15         6.2.2.  Getting all available audio output drivers  . . . . .  16
84         6.2.3.  Getting information about a specific audio output         6.2.3.  Getting information about a specific audio output
85                 driver  . . . . . . . . . . . . . . . . . . . . . . .  15                 driver  . . . . . . . . . . . . . . . . . . . . . . .  16
86         6.2.4.  Getting information about specific audio output         6.2.4.  Getting information about specific audio output
87                 driver parameter  . . . . . . . . . . . . . . . . . .  16                 driver parameter  . . . . . . . . . . . . . . . . . .  17
88         6.2.5.  Creating an audio output device . . . . . . . . . . .  20         6.2.5.  Creating an audio output device . . . . . . . . . . .  21
89         6.2.6.  Destroying an audio output device . . . . . . . . . .  21         6.2.6.  Destroying an audio output device . . . . . . . . . .  22
90         6.2.7.  Getting all created audio output device count . . . .  22         6.2.7.  Getting all created audio output device count . . . .  23
91         6.2.8.  Getting all created audio output device list  . . . .  22         6.2.8.  Getting all created audio output device list  . . . .  23
92         6.2.9.  Getting current settings of an audio output device  .  22         6.2.9.  Getting current settings of an audio output device  .  23
93         6.2.10. Changing settings of audio output devices . . . . . .  24         6.2.10. Changing settings of audio output devices . . . . . .  25
94         6.2.11. Getting information about an audio channel  . . . . .  25         6.2.11. Getting information about an audio channel  . . . . .  26
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter . . . . . . . . . . . . . . . . . . . . . .  26                 parameter . . . . . . . . . . . . . . . . . . . . . .  27
97         6.2.13. Changing settings of audio output channels  . . . . .  28         6.2.13. Changing settings of audio output channels  . . . . .  29
98       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30
99         6.3.1.  Getting amount of available MIDI input drivers  . . .  30         6.3.1.  Getting amount of available MIDI input drivers  . . .  31
100         6.3.2.  Getting all available MIDI input drivers  . . . . . .  30         6.3.2.  Getting all available MIDI input drivers  . . . . . .  31
101         6.3.3.  Getting information about a specific MIDI input         6.3.3.  Getting information about a specific MIDI input
102                 driver  . . . . . . . . . . . . . . . . . . . . . . .  31                 driver  . . . . . . . . . . . . . . . . . . . . . . .  32
103         6.3.4.  Getting information about specific MIDI input         6.3.4.  Getting information about specific MIDI input
104                 driver parameter  . . . . . . . . . . . . . . . . . .  32                 driver parameter  . . . . . . . . . . . . . . . . . .  33
105         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35
106         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36
107         6.3.7.  Getting all created MIDI input device count . . . . .  36         6.3.7.  Getting all created MIDI input device count . . . . .  37
108    
109    
110    
111  Schoenebeck            Expires September 23, 2007               [Page 2]  Schoenebeck             Expires November 17, 2007               [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
114    
115    
116         6.3.8.  Getting all created MIDI input device list  . . . . .  36         6.3.8.  Getting all created MIDI input device list  . . . . .  37
117         6.3.9.  Getting current settings of a MIDI input device . . .  37         6.3.9.  Getting current settings of a MIDI input device . . .  38
118         6.3.10. Changing settings of MIDI input devices . . . . . . .  38         6.3.10. Changing settings of MIDI input devices . . . . . . .  39
119         6.3.11. Getting information about a MIDI port . . . . . . . .  38         6.3.11. Getting information about a MIDI port . . . . . . . .  39
120         6.3.12. Getting information about specific MIDI port         6.3.12. Getting information about specific MIDI port
121                 parameter . . . . . . . . . . . . . . . . . . . . . .  39                 parameter . . . . . . . . . . . . . . . . . . . . . .  40
122         6.3.13. Changing settings of MIDI input ports . . . . . . . .  41         6.3.13. Changing settings of MIDI input ports . . . . . . . .  42
123       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43
124         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126         6.4.3.  Getting all created sampler channel count . . . . . .  44         6.4.3.  Getting all created sampler channel count . . . . . .  45
127         6.4.4.  Getting all created sampler channel list  . . . . . .  44         6.4.4.  Getting all created sampler channel list  . . . . . .  45
128         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  45
129         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  46
130         6.4.7.  Getting amount of available engines . . . . . . . . .  46         6.4.7.  Getting amount of available engines . . . . . . . . .  47
131         6.4.8.  Getting all available engines . . . . . . . . . . . .  46         6.4.8.  Getting all available engines . . . . . . . . . . . .  47
132         6.4.9.  Getting information about an engine . . . . . . . . .  47         6.4.9.  Getting information about an engine . . . . . . . . .  48
133         6.4.10. Getting sampler channel information . . . . . . . . .  48         6.4.10. Getting sampler channel information . . . . . . . . .  49
134         6.4.11. Current number of active voices . . . . . . . . . . .  51         6.4.11. Current number of active voices . . . . . . . . . . .  52
135         6.4.12. Current number of active disk streams . . . . . . . .  51         6.4.12. Current number of active disk streams . . . . . . . .  52
136         6.4.13. Current fill state of disk stream buffers . . . . . .  52         6.4.13. Current fill state of disk stream buffers . . . . . .  53
137         6.4.14. Setting audio output device . . . . . . . . . . . . .  53         6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138         6.4.15. Setting audio output type . . . . . . . . . . . . . .  53         6.4.15. Setting audio output type . . . . . . . . . . . . . .  54
139         6.4.16. Setting audio output channel  . . . . . . . . . . . .  54         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55
140         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  55         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  56         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  57
143         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  59
146         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60
147         6.4.24. Assigning a MIDI instrument map to a sampler         6.4.24. Assigning a MIDI instrument map to a sampler
148                 channel . . . . . . . . . . . . . . . . . . . . . . .  60                 channel . . . . . . . . . . . . . . . . . . . . . . .  61
149         6.4.25. Adding an effect send to a sampler channel  . . . . .  61         6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150         6.4.26. Removing an effect send from a sampler channel  . . .  62         6.4.26. Removing an effect send from a sampler channel  . . .  63
151         6.4.27. Getting amount of effect sends on a sampler channel .  63         6.4.27. Getting amount of effect sends on a sampler channel .  64
152         6.4.28. Listing all effect sends on a sampler channel . . . .  63         6.4.28. Listing all effect sends on a sampler channel . . . .  64
153         6.4.29. Getting effect send information . . . . . . . . . . .  64         6.4.29. Getting effect send information . . . . . . . . . . .  65
154         6.4.30. Altering effect send's audio routing  . . . . . . . .  65         6.4.30. Changing effect send's name . . . . . . . . . . . . .  66
155         6.4.31. Altering effect send's MIDI controller  . . . . . . .  66         6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156         6.4.32. Altering effect send's send level . . . . . . . . . .  67         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157         6.4.33. Resetting a sampler channel . . . . . . . . . . . . .  68         6.4.33. Altering effect send's send level . . . . . . . . . .  68
158       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  68         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  69
159         6.5.1.  Register front-end for receiving event messages . . .  68       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70
160           6.5.1.  Register front-end for receiving event messages . . .  70
161         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
162                 messages  . . . . . . . . . . . . . . . . . . . . . .  69                 messages  . . . . . . . . . . . . . . . . . . . . . .  71
163         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  70         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  71
        6.5.4.  Close client connection . . . . . . . . . . . . . . .  70  
164    
165    
166    
167  Schoenebeck            Expires September 23, 2007               [Page 3]  Schoenebeck             Expires November 17, 2007               [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
170    
171    
172       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  71         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
173         6.6.1.  Current number of active voices . . . . . . . . . . .  71       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72
174         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  71         6.6.1.  Current number of active voices . . . . . . . . . . .  72
175         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  71         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73
176         6.6.4.  General sampler informations  . . . . . . . . . . . .  72         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73
177         6.6.5.  Getting global volume attenuation . . . . . . . . . .  72         6.6.4.  General sampler informations  . . . . . . . . . . . .  73
178         6.6.6.  Setting global volume attenuation . . . . . . . . . .  73         6.6.5.  Getting global volume attenuation . . . . . . . . . .  74
179       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  73         6.6.6.  Setting global volume attenuation . . . . . . . . . .  74
180         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  74       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75
181         6.7.2.  Delete one particular or all MIDI instrument maps . .  75         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76
182         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  75         6.7.2.  Delete one particular or all MIDI instrument maps . .  76
183         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  76         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77
184         6.7.5.  Getting MIDI instrument map information . . . . . . .  76         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  77
185         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  77         6.7.5.  Getting MIDI instrument map information . . . . . . .  78
186         6.7.7.  Create or replace a MIDI instrument map entry . . . .  77         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79
187         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  80         6.7.7.  Create or replace a MIDI instrument map entry . . . .  79
188           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82
189         6.7.9.  Getting indeces of all entries of a MIDI         6.7.9.  Getting indeces of all entries of a MIDI
190                 instrument map  . . . . . . . . . . . . . . . . . . .  81                 instrument map  . . . . . . . . . . . . . . . . . . .  83
191         6.7.10. Remove an entry from the MIDI instrument map  . . . .  82         6.7.10. Remove an entry from the MIDI instrument map  . . . .  83
192         6.7.11. Get current settings of MIDI instrument map entry . .  82         6.7.11. Get current settings of MIDI instrument map entry . .  84
193         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  84         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  85       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  86
195     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  96         6.8.1.  Creating a new instrument directory . . . . . . . . .  86
196       8.1.  Number of audio output devices changed  . . . . . . . . .  96         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87
197       8.2.  Audio output device's settings changed  . . . . . . . . .  96         6.8.3.  Getting amount of instrument directories  . . . . . .  88
198       8.3.  Number of MIDI input devices changed  . . . . . . . . . .  96         6.8.4.  Listing all directories in specific directory . . . .  88
199       8.4.  MIDI input device's settings changed  . . . . . . . . . .  97         6.8.5.  Getting instrument directory information  . . . . . .  89
200       8.5.  Number of sampler channels changed  . . . . . . . . . . .  97         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90
201       8.6.  Number of active voices changed . . . . . . . . . . . . .  97         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  90
202       8.7.  Number of active disk streams changed . . . . . . . . . .  98         6.8.8.  Copying instrument directories  . . . . . . . . . . .  91
203       8.8.  Disk stream buffer fill state changed . . . . . . . . . .  98         6.8.9.  Changing the description of directory . . . . . . . .  92
204       8.9.  Channel information changed . . . . . . . . . . . . . . .  98         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  92
205       8.10. Number of effect sends changed  . . . . . . . . . . . . .  99         6.8.11. Adding instruments to the instruments database  . . .  94
206       8.11. Effect send information changed . . . . . . . . . . . . .  99         6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  95
207       8.12. Total number of active voices changed . . . . . . . . . .  99         6.8.13. Getting amount of instruments . . . . . . . . . . . .  95
208       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 100         6.8.14. Listing all instruments in specific directory . . . .  96
209       8.14. MIDI instrument map information changed . . . . . . . . . 100         6.8.15. Getting instrument information  . . . . . . . . . . .  97
210       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 100         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . .  99
211       8.16. MIDI instrument information changed . . . . . . . . . . . 101         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . .  99
212       8.17. Global settings changed . . . . . . . . . . . . . . . . . 101         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 100
213       8.18. Miscellaneous and debugging events  . . . . . . . . . . . 102         6.8.19. Changing the description of instrument  . . . . . . . 101
214     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 103         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 101
215     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 104     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 104
216     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 105     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
217     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 106       8.1.  Number of audio output devices changed  . . . . . . . . . 117
218     Intellectual Property and Copyright Statements  . . . . . . . . . 107       8.2.  Audio output device's settings changed  . . . . . . . . . 117
219         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 117
220    
221    
222    
223    Schoenebeck             Expires November 17, 2007               [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol             May 2007
226    
227    
228         8.4.  MIDI input device's settings changed  . . . . . . . . . . 118
229         8.5.  Number of sampler channels changed  . . . . . . . . . . . 118
230         8.6.  Number of active voices changed . . . . . . . . . . . . . 118
231         8.7.  Number of active disk streams changed . . . . . . . . . . 119
232         8.8.  Disk stream buffer fill state changed . . . . . . . . . . 119
233         8.9.  Channel information changed . . . . . . . . . . . . . . . 119
234         8.10. Number of effect sends changed  . . . . . . . . . . . . . 120
235         8.11. Effect send information changed . . . . . . . . . . . . . 120
236         8.12. Total number of active voices changed . . . . . . . . . . 120
237         8.13. Number of MIDI instrument maps changed  . . . . . . . . . 121
238         8.14. MIDI instrument map information changed . . . . . . . . . 121
239         8.15. Number of MIDI instruments changed  . . . . . . . . . . . 121
240         8.16. MIDI instrument information changed . . . . . . . . . . . 122
241         8.17. Global settings changed . . . . . . . . . . . . . . . . . 122
242         8.18. Number of database instrument directories changed . . . . 123
243         8.19. Database instrument directory information changed . . . . 123
244         8.20. Number of database instruments changed  . . . . . . . . . 124
245         8.21. Database instrument information changed . . . . . . . . . 124
246         8.22. Miscellaneous and debugging events  . . . . . . . . . . . 125
247       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 126
248       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 127
249       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 128
250       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 129
251       Intellectual Property and Copyright Statements  . . . . . . . . . 130
252    
253    
254    
255    
256    
257    
258    
259    
260    
261    
262    
263    
264    
265    
266  Schoenebeck            Expires September 23, 2007               [Page 4]  
267    
268    
269    
270    
271    
272    
273    
274    
275    
276    
277    
278    
279    Schoenebeck             Expires November 17, 2007               [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck            Expires September 23, 2007               [Page 5]  Schoenebeck             Expires November 17, 2007               [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck            Expires September 23, 2007               [Page 6]  Schoenebeck             Expires November 17, 2007               [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck            Expires September 23, 2007               [Page 7]  Schoenebeck             Expires November 17, 2007               [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck            Expires September 23, 2007               [Page 8]  Schoenebeck             Expires November 17, 2007               [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck            Expires September 23, 2007               [Page 9]  Schoenebeck             Expires November 17, 2007              [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
562    
563    
564  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck            Expires September 23, 2007              [Page 10]  Schoenebeck             Expires November 17, 2007              [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck            Expires September 23, 2007              [Page 11]  Schoenebeck             Expires November 17, 2007              [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck            Expires September 23, 2007              [Page 12]  Schoenebeck             Expires November 17, 2007              [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
730    
731    
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 724  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck            Expires September 23, 2007              [Page 13]  Schoenebeck             Expires November 17, 2007              [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 780  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck            Expires September 23, 2007              [Page 14]  Schoenebeck             Expires November 17, 2007              [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
842    
843    
844  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck            Expires September 23, 2007              [Page 15]  Schoenebeck             Expires November 17, 2007              [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck            Expires September 23, 2007              [Page 16]  Schoenebeck             Expires November 17, 2007              [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
954    
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck            Expires September 23, 2007              [Page 17]  Schoenebeck             Expires November 17, 2007              [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck            Expires September 23, 2007              [Page 18]  Schoenebeck             Expires November 17, 2007              [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck            Expires September 23, 2007              [Page 19]  Schoenebeck             Expires November 17, 2007              [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck            Expires September 23, 2007              [Page 20]  Schoenebeck             Expires November 17, 2007              [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1178    
1179    
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck            Expires September 23, 2007              [Page 21]  Schoenebeck             Expires November 17, 2007              [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1234    
1235    
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck            Expires September 23, 2007              [Page 22]  Schoenebeck             Expires November 17, 2007              [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck            Expires September 23, 2007              [Page 23]  Schoenebeck             Expires November 17, 2007              [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1346    
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck            Expires September 23, 2007              [Page 24]  Schoenebeck             Expires November 17, 2007              [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1402    
1403    
1404  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck            Expires September 23, 2007              [Page 25]  Schoenebeck             Expires November 17, 2007              [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1458    
1459    
1460     Examples:     Examples:
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck            Expires September 23, 2007              [Page 26]  Schoenebeck             Expires November 17, 2007              [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck            Expires September 23, 2007              [Page 27]  Schoenebeck             Expires November 17, 2007              [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck            Expires September 23, 2007              [Page 28]  Schoenebeck             Expires November 17, 2007              [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1626    
1627    
1628        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck            Expires September 23, 2007              [Page 29]  Schoenebeck             Expires November 17, 2007              [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck            Expires September 23, 2007              [Page 30]  Schoenebeck             Expires November 17, 2007              [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1738    
1739    
1740  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck            Expires September 23, 2007              [Page 31]  Schoenebeck             Expires November 17, 2007              [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1794    
1795    
1796  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck            Expires September 23, 2007              [Page 32]  Schoenebeck             Expires November 17, 2007              [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1850    
1851    
1852        FIX -        FIX -
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck            Expires September 23, 2007              [Page 33]  Schoenebeck             Expires November 17, 2007              [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck            Expires September 23, 2007              [Page 34]  Schoenebeck             Expires November 17, 2007              [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 1956  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck            Expires September 23, 2007              [Page 35]  Schoenebeck             Expires November 17, 2007              [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck            Expires September 23, 2007              [Page 36]  Schoenebeck             Expires November 17, 2007              [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2074    
2075    
2076  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck            Expires September 23, 2007              [Page 37]  Schoenebeck             Expires November 17, 2007              [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck            Expires September 23, 2007              [Page 38]  Schoenebeck             Expires November 17, 2007              [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck            Expires September 23, 2007              [Page 39]  Schoenebeck             Expires November 17, 2007              [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck            Expires September 23, 2007              [Page 40]  Schoenebeck             Expires November 17, 2007              [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck            Expires September 23, 2007              [Page 41]  Schoenebeck             Expires November 17, 2007              [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2354    
2355    
2356           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck            Expires September 23, 2007              [Page 42]  Schoenebeck             Expires November 17, 2007              [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2410    
2411    
2412           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck            Expires September 23, 2007              [Page 43]  Schoenebeck             Expires November 17, 2007              [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2466    
2467    
2468     Example:     Example:
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck            Expires September 23, 2007              [Page 44]  Schoenebeck             Expires November 17, 2007              [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2522    
2523    
2524        ADD CHANNEL        ADD CHANNEL
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck            Expires September 23, 2007              [Page 45]  Schoenebeck             Expires November 17, 2007              [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2578    
2579    
2580        "OK" -        "OK" -
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck            Expires September 23, 2007              [Page 46]  Schoenebeck             Expires November 17, 2007              [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2634    
2635    
2636        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck            Expires September 23, 2007              [Page 47]  Schoenebeck             Expires November 17, 2007              [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2690    
2691    
2692           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck            Expires September 23, 2007              [Page 48]  Schoenebeck             Expires November 17, 2007              [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2746    
2747    
2748              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck            Expires September 23, 2007              [Page 49]  Schoenebeck             Expires November 17, 2007              [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2802    
2803    
2804           MUTE -           MUTE -
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855  Schoenebeck            Expires September 23, 2007              [Page 50]  Schoenebeck             Expires November 17, 2007              [Page 51]
2856    
2857  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2858    
2859    
2860           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
# Line 2852  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911  Schoenebeck            Expires September 23, 2007              [Page 51]  Schoenebeck             Expires November 17, 2007              [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2914    
2915    
2916        return "NA" for not available.        return "NA" for not available.
# Line 2908  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck            Expires September 23, 2007              [Page 52]  Schoenebeck             Expires November 17, 2007              [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
2970    
2971    
2972        S: ""        S: ""
# Line 2964  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck            Expires September 23, 2007              [Page 53]  Schoenebeck             Expires November 17, 2007              [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3026    
3027    
3028     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
# Line 3020  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck            Expires September 23, 2007              [Page 54]  Schoenebeck             Expires November 17, 2007              [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3082    
3083    
3084           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck            Expires September 23, 2007              [Page 55]  Schoenebeck             Expires November 17, 2007              [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3138    
3139    
3140  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
# Line 3132  Internet-Draft        LinuxSampler Contr Line 3188  Internet-Draft        LinuxSampler Contr
3188    
3189    
3190    
3191  Schoenebeck            Expires September 23, 2007              [Page 56]  Schoenebeck             Expires November 17, 2007              [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3194    
3195    
3196           on success           on success
# Line 3188  Internet-Draft        LinuxSampler Contr Line 3244  Internet-Draft        LinuxSampler Contr
3244    
3245    
3246    
3247  Schoenebeck            Expires September 23, 2007              [Page 57]  Schoenebeck             Expires November 17, 2007              [Page 58]
3248    
3249  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3250    
3251    
3252    
# Line 3244  Internet-Draft        LinuxSampler Contr Line 3300  Internet-Draft        LinuxSampler Contr
3300    
3301    
3302    
3303  Schoenebeck            Expires September 23, 2007              [Page 58]  Schoenebeck             Expires November 17, 2007              [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3306    
3307    
3308        "OK" -        "OK" -
# Line 3300  Internet-Draft        LinuxSampler Contr Line 3356  Internet-Draft        LinuxSampler Contr
3356    
3357    
3358    
3359  Schoenebeck            Expires September 23, 2007              [Page 59]  Schoenebeck             Expires November 17, 2007              [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3362    
3363    
3364     Examples:     Examples:
# Line 3356  Internet-Draft        LinuxSampler Contr Line 3412  Internet-Draft        LinuxSampler Contr
3412    
3413    
3414    
3415  Schoenebeck            Expires September 23, 2007              [Page 60]  Schoenebeck             Expires November 17, 2007              [Page 61]
3416    
3417  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3418    
3419    
3420     Examples:     Examples:
# Line 3387  Internet-Draft        LinuxSampler Contr Line 3443  Internet-Draft        LinuxSampler Contr
3443     having dedicated effect send output channels and when "CREATE     having dedicated effect send output channels and when "CREATE
3444     FX_SEND" is called, those channels will automatically be picked.  You     FX_SEND" is called, those channels will automatically be picked.  You
3445     can alter the destination channels however with "SET FX_SEND     can alter the destination channels however with "SET FX_SEND
3446     AUDIO_OUTPUT_CHANNEL" (Section 6.4.30).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3447    
3448     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3449     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
# Line 3412  Internet-Draft        LinuxSampler Contr Line 3468  Internet-Draft        LinuxSampler Contr
3468    
3469    
3470    
3471  Schoenebeck            Expires September 23, 2007              [Page 61]  Schoenebeck             Expires November 17, 2007              [Page 62]
3472    
3473  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3474    
3475    
3476        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3468  Internet-Draft        LinuxSampler Contr Line 3524  Internet-Draft        LinuxSampler Contr
3524    
3525    
3526    
3527  Schoenebeck            Expires September 23, 2007              [Page 62]  Schoenebeck             Expires November 17, 2007              [Page 63]
3528    
3529  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3530    
3531    
3532  6.4.27.  Getting amount of effect sends on a sampler channel  6.4.27.  Getting amount of effect sends on a sampler channel
# Line 3524  Internet-Draft        LinuxSampler Contr Line 3580  Internet-Draft        LinuxSampler Contr
3580    
3581    
3582    
3583  Schoenebeck            Expires September 23, 2007              [Page 63]  Schoenebeck             Expires November 17, 2007              [Page 64]
3584    
3585  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3586    
3587    
3588  6.4.29.  Getting effect send information  6.4.29.  Getting effect send information
# Line 3575  Internet-Draft        LinuxSampler Contr Line 3631  Internet-Draft        LinuxSampler Contr
3631              send's output channel 0 is routed to channel 0 of the audio              send's output channel 0 is routed to channel 0 of the audio
3632              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
3633              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3634              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3635    
3636    
3637    
3638    
3639  Schoenebeck            Expires September 23, 2007              [Page 64]  Schoenebeck             Expires November 17, 2007              [Page 65]
3640    
3641  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
3642    
3643    
3644     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 3601  Internet-Draft        LinuxSampler Contr Line 3657  Internet-Draft        LinuxSampler Contr
3657    
3658           "."           "."
3659    
3660  6.4.30.  Altering effect send's audio routing  6.4.30.  Changing effect send's name
3661    
3662       The front-end can alter the current name of an effect send entity by
3663       sending the following command:
3664    
3665          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3666    
3667       Where <sampler-chan> is the sampler channel number as returned by the
3668       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3669       command, <fx-send-id> reflects the numerical ID of the effect send
3670       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3671       FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3672       effect send entity, which does not have to be unique.
3673    
3674       Possible Answers:
3675    
3676          "OK" -
3677    
3678             on success
3679    
3680          "ERR:<error-code>:<error-message>" -
3681    
3682             in case it failed, providing an appropriate error code and
3683             error message
3684    
3685       Example:
3686    
3687          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3688    
3689          S: "OK"
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck             Expires November 17, 2007              [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol             May 2007
3698    
3699    
3700    6.4.31.  Altering effect send's audio routing
3701    
3702     The front-end can alter the destination of an effect send's audio     The front-end can alter the destination of an effect send's audio
3703     channel on a specific sampler channel by sending the following     channel on a specific sampler channel by sending the following
# Line 3633  Internet-Draft        LinuxSampler Contr Line 3729  Internet-Draft        LinuxSampler Contr
3729    
3730     Possible Answers:     Possible Answers:
3731    
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
3732        "OK" -        "OK" -
3733    
3734           on success           on success
# Line 3658  Internet-Draft        LinuxSampler Contr Line 3746  Internet-Draft        LinuxSampler Contr
3746    
3747     Example:     Example:
3748    
3749    
3750    
3751    Schoenebeck             Expires November 17, 2007              [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol             May 2007
3754    
3755    
3756        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3757    
3758        S: "OK"        S: "OK"
3759    
3760  6.4.31.  Altering effect send's MIDI controller  6.4.32.  Altering effect send's MIDI controller
3761    
3762     The front-end can alter the MIDI controller of an effect send entity     The front-end can alter the MIDI controller of an effect send entity
3763     by sending the following command:     by sending the following command:
# Line 3690  Internet-Draft        LinuxSampler Contr Line 3785  Internet-Draft        LinuxSampler Contr
3785           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3786           message           message
3787    
   
   
 Schoenebeck            Expires September 23, 2007              [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
3788        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3789    
3790           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3708  Internet-Draft        LinuxSampler Contr Line 3796  Internet-Draft        LinuxSampler Contr
3796    
3797        S: "OK"        S: "OK"
3798    
3799  6.4.32.  Altering effect send's send level  6.4.33.  Altering effect send's send level
3800    
3801     The front-end can alter the current send level of an effect send     The front-end can alter the current send level of an effect send
3802     entity by sending the following command:     entity by sending the following command:
3803    
3804    
3805    
3806    
3807    Schoenebeck             Expires November 17, 2007              [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol             May 2007
3810    
3811    
3812        SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>        SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3813    
3814     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
# Line 3743  Internet-Draft        LinuxSampler Contr Line 3839  Internet-Draft        LinuxSampler Contr
3839    
3840     Example:     Example:
3841    
   
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
3842        C: "SET FX_SEND LEVEL 0 0 0.15"        C: "SET FX_SEND LEVEL 0 0 0.15"
3843    
3844        S: "OK"        S: "OK"
3845    
3846  6.4.33.  Resetting a sampler channel  6.4.34.  Resetting a sampler channel
3847    
3848     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3849     following command:     following command:
# Line 3771  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857    
3858     Possible Answers:     Possible Answers:
3859    
3860    
3861    
3862    
3863    Schoenebeck             Expires November 17, 2007              [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol             May 2007
3866    
3867    
3868        "OK" -        "OK" -
3869    
3870           on success           on success
# Line 3800  Internet-Draft        LinuxSampler Contr Line 3894  Internet-Draft        LinuxSampler Contr
3894     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3895     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3896    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
3897        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3898    
3899     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
# Line 3826  Internet-Draft        LinuxSampler Contr Line 3911  Internet-Draft        LinuxSampler Contr
3911           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3912           message           message
3913    
3914    
3915    
3916    
3917    
3918    
3919    Schoenebeck             Expires November 17, 2007              [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol             May 2007
3922    
3923    
3924        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3925    
3926           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3857  Internet-Draft        LinuxSampler Contr Line 3952  Internet-Draft        LinuxSampler Contr
3952           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3953           message           message
3954    
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
3955        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3956    
3957           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3882  Internet-Draft        LinuxSampler Contr Line 3969  Internet-Draft        LinuxSampler Contr
3969        SET ECHO <value>        SET ECHO <value>
3970    
3971     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
3972    
3973    
3974    
3975    Schoenebeck             Expires November 17, 2007              [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol             May 2007
3978    
3979    
3980     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
3981     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
3982     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 3912  Internet-Draft        LinuxSampler Contr Line 4007  Internet-Draft        LinuxSampler Contr
4007     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4008     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4009    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4010  6.6.  Global commands  6.6.  Global commands
4011    
4012     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
# Line 3937  Internet-Draft        LinuxSampler Contr Line 4023  Internet-Draft        LinuxSampler Contr
4023        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4024        voices on the sampler.        voices on the sampler.
4025    
4026    
4027    
4028    
4029    
4030    
4031    Schoenebeck             Expires November 17, 2007              [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol             May 2007
4034    
4035    
4036  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
4037    
4038     The front-end can ask for the maximum number of active voices by     The front-end can ask for the maximum number of active voices by
# Line 3966  Internet-Draft        LinuxSampler Contr Line 4062  Internet-Draft        LinuxSampler Contr
4062    
4063    
4064    
   
   
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4065  6.6.4.  General sampler informations  6.6.4.  General sampler informations
4066    
4067     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
# Line 3996  Internet-Draft        LinuxSampler Contr Line 4081  Internet-Draft        LinuxSampler Contr
4081    
4082           DESCRIPTION -           DESCRIPTION -
4083    
4084    
4085    
4086    
4087    Schoenebeck             Expires November 17, 2007              [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol             May 2007
4090    
4091    
4092              arbitrary textual description about the sampler              arbitrary textual description about the sampler
4093    
4094           VERSION -           VERSION -
# Line 4007  Internet-Draft        LinuxSampler Contr Line 4100  Internet-Draft        LinuxSampler Contr
4100              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
4101              (see Section 2 for details)              (see Section 2 for details)
4102    
4103             INSTRUMENTS_DB_SUPPORT -
4104    
4105                either yes or no, specifies whether the sampler is build
4106                with instruments database support.
4107    
4108     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4109     Other fields might be added in future.     Other fields might be added in future.
4110    
# Line 4025  Internet-Draft        LinuxSampler Contr Line 4123  Internet-Draft        LinuxSampler Contr
4123    
4124     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4125     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4126     this parameter.     this parameter.
4127    
4128  6.6.6.  Setting global volume attenuation  6.6.6.  Setting global volume attenuation
# Line 4047  Internet-Draft        LinuxSampler Contr Line 4137  Internet-Draft        LinuxSampler Contr
4137     might usually be in the range between 0.0 and 1.0, that is for     might usually be in the range between 0.0 and 1.0, that is for
4138     attenuating the overall volume.     attenuating the overall volume.
4139    
4140    
4141    
4142    
4143    Schoenebeck             Expires November 17, 2007              [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol             May 2007
4146    
4147    
4148     Possible Answers:     Possible Answers:
4149    
4150        "OK" -        "OK" -
# Line 4081  Internet-Draft        LinuxSampler Contr Line 4179  Internet-Draft        LinuxSampler Contr
4179     front-end has to explicitly create at least one map, add entries to     front-end has to explicitly create at least one map, add entries to
4180     the map and tell the respective sampler channel(s) which MIDI     the map and tell the respective sampler channel(s) which MIDI
4181     instrument map to use, so the sampler knows how to react on a given     instrument map to use, so the sampler knows how to react on a given
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4182     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
4183     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
4184     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
# Line 4102  Internet-Draft        LinuxSampler Contr Line 4192  Internet-Draft        LinuxSampler Contr
4192     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4193     current MIDI instrument map.     current MIDI instrument map.
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck             Expires November 17, 2007              [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol             May 2007
4202    
4203    
4204  6.7.1.  Create a new MIDI instrument map  6.7.1.  Create a new MIDI instrument map
4205    
4206     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
# Line 4136  Internet-Draft        LinuxSampler Contr Line 4235  Internet-Draft        LinuxSampler Contr
4235    
4236        C: "ADD MIDI_INSTRUMENT_MAP"        C: "ADD MIDI_INSTRUMENT_MAP"
4237    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4238        S: "OK[5]"        S: "OK[5]"
4239    
4240  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
# Line 4160  Internet-Draft        LinuxSampler Contr Line 4250  Internet-Draft        LinuxSampler Contr
4250     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4251     following command:     following command:
4252    
4253    
4254    
4255    Schoenebeck             Expires November 17, 2007              [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol             May 2007
4258    
4259    
4260        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4261    
4262     Possible Answers:     Possible Answers:
# Line 4191  Internet-Draft        LinuxSampler Contr Line 4288  Internet-Draft        LinuxSampler Contr
4288    
4289     Possible Answers:     Possible Answers:
4290    
   
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4291        The sampler will answer by returning the current number of MIDI        The sampler will answer by returning the current number of MIDI
4292        instrument maps.        instrument maps.
4293    
# Line 4216  Internet-Draft        LinuxSampler Contr Line 4303  Internet-Draft        LinuxSampler Contr
4303     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4304     following command:     following command:
4305    
4306    
4307    
4308    
4309    
4310    
4311    Schoenebeck             Expires November 17, 2007              [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol             May 2007
4314    
4315    
4316        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4317    
4318     Possible Answers:     Possible Answers:
# Line 4250  Internet-Draft        LinuxSampler Contr Line 4347  Internet-Draft        LinuxSampler Contr
4347    
4348    
4349    
4350             NAME -
4351    
4352                custom name of the given map, which does not have to be
4353                unique
4354    
4355  Schoenebeck            Expires September 23, 2007              [Page 76]           DEFAULT -
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
4356    
4357                either true or false, defines whether this map is the
4358                default map
4359    
4360       The mentioned fields above don't have to be in particular order.
4361    
4362       Example:
4363    
          NAME -  
4364    
             custom name of the given map, which does not have to be  
             unique  
4365    
    The mentioned fields above don't have to be in particular order.  
4366    
4367     Example:  Schoenebeck             Expires November 17, 2007              [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol             May 2007
4370    
4371    
4372        C: "GET MIDI_INSTRUMENT_MAP INFO 0"        C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4373    
4374        S: "NAME: Standard Map"        S: "NAME: Standard Map"
4375    
4376             "DEFAULT: true"
4377    
4378           "."           "."
4379    
4380  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
# Line 4305  Internet-Draft        LinuxSampler Contr Line 4408  Internet-Draft        LinuxSampler Contr
4408     The front-end can create a new or replace an existing entry in a     The front-end can create a new or replace an existing entry in a
4409     sampler's MIDI instrument map by sending the following command:     sampler's MIDI instrument map by sending the following command:
4410    
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4411        MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>        MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4412        <engine_name> <filename> <instrument_index> <volume_value>        <engine_name> <filename> <instrument_index> <volume_value>
4413        [<instr_load_mode>] [<name>]        [<instr_load_mode>] [<name>]
# Line 4322  Internet-Draft        LinuxSampler Contr Line 4417  Internet-Draft        LinuxSampler Contr
4417     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4418     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4419     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4420    
4421    
4422    
4423    Schoenebeck             Expires November 17, 2007              [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol             May 2007
4426    
4427    
4428     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
4429     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes),
4430     <instrument_index> the index (integer value) of the instrument within     <instrument_index> the index (integer value) of the instrument within
# Line 4360  Internet-Draft        LinuxSampler Contr Line 4463  Internet-Draft        LinuxSampler Contr
4463           respective instrument) are explicitly changed to "ON_DEMAND"           respective instrument) are explicitly changed to "ON_DEMAND"
4464           and no sampler channel is using the instrument anymore.           and no sampler channel is using the instrument anymore.
4465    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4466        not supplied -        not supplied -
4467    
4468           In case there is no <instr_load_mode> argument given, it will           In case there is no <instr_load_mode> argument given, it will
# Line 4379  Internet-Draft        LinuxSampler Contr Line 4473  Internet-Draft        LinuxSampler Contr
4473           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
4474           that is it will not change the mode.           that is it will not change the mode.
4475    
4476    
4477    
4478    
4479    Schoenebeck             Expires November 17, 2007              [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol             May 2007
4482    
4483    
4484     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
4485     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
4486     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
# Line 4415  Internet-Draft        LinuxSampler Contr Line 4517  Internet-Draft        LinuxSampler Contr
4517    
4518     Possible Answers:     Possible Answers:
4519    
   
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4520        "OK" -        "OK" -
4521    
4522           usually           usually
# Line 4436  Internet-Draft        LinuxSampler Contr Line 4528  Internet-Draft        LinuxSampler Contr
4528    
4529     Examples:     Examples:
4530    
4531    
4532    
4533    
4534    
4535    Schoenebeck             Expires November 17, 2007              [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol             May 2007
4538    
4539    
4540        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4541        0.8 PERSISTENT"        0.8 PERSISTENT"
4542    
# Line 4471  Internet-Draft        LinuxSampler Contr Line 4572  Internet-Draft        LinuxSampler Contr
4572     The front-end can query the amount of currently existing entries in     The front-end can query the amount of currently existing entries in
4573     all MIDI instrument maps by sending the following command:     all MIDI instrument maps by sending the following command:
4574    
   
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4575        GET MIDI_INSTRUMENTS ALL        GET MIDI_INSTRUMENTS ALL
4576    
4577     Possible Answers:     Possible Answers:
# Line 4494  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585    
4586        S: "234"        S: "234"
4587    
4588    
4589    
4590    
4591    Schoenebeck             Expires November 17, 2007              [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol             May 2007
4594    
4595    
4596        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
4597    
4598        S: "954"        S: "954"
# Line 4528  Internet-Draft        LinuxSampler Contr Line 4627  Internet-Draft        LinuxSampler Contr
4627    
4628        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4629    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4630  6.7.10.  Remove an entry from the MIDI instrument map  6.7.10.  Remove an entry from the MIDI instrument map
4631    
4632     The front-end can delete an entry from a MIDI instrument map by     The front-end can delete an entry from a MIDI instrument map by
# Line 4551  Internet-Draft        LinuxSampler Contr Line 4641  Internet-Draft        LinuxSampler Contr
4641    
4642     Possible Answers:     Possible Answers:
4643    
4644    
4645    
4646    
4647    Schoenebeck             Expires November 17, 2007              [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol             May 2007
4650    
4651    
4652        "OK" -        "OK" -
4653    
4654           usually           usually
# Line 4586  Internet-Draft        LinuxSampler Contr Line 4684  Internet-Draft        LinuxSampler Contr
4684        character string to that info category.  At the moment the        character string to that info category.  At the moment the
4685        following categories are defined:        following categories are defined:
4686    
   
   
 Schoenebeck            Expires September 23, 2007              [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4687        "NAME" -        "NAME" -
4688    
4689           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
# Line 4605  Internet-Draft        LinuxSampler Contr Line 4696  Internet-Draft        LinuxSampler Contr
4696    
4697           Name of the engine to be deployed for this instrument.           Name of the engine to be deployed for this instrument.
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck             Expires November 17, 2007              [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol             May 2007
4706    
4707    
4708        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4709    
4710           File name of the instrument.           File name of the instrument.
# Line 4640  Internet-Draft        LinuxSampler Contr Line 4740  Internet-Draft        LinuxSampler Contr
4740    
4741           "ENGINE_NAME: GigEngine"           "ENGINE_NAME: GigEngine"
4742    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
4743           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"           "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4744    
4745           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
# Line 4661  Internet-Draft        LinuxSampler Contr Line 4752  Internet-Draft        LinuxSampler Contr
4752    
4753           "."           "."
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck             Expires November 17, 2007              [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol             May 2007
4762    
4763    
4764  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
4765    
4766     The front-end can clear a whole MIDI instrument map, that is delete     The front-end can clear a whole MIDI instrument map, that is delete
# Line 4695  Internet-Draft        LinuxSampler Contr Line 4795  Internet-Draft        LinuxSampler Contr
4795    
4796        S: "OK"        S: "OK"
4797    
4798    6.8.  Managing Instruments Database
4799    
4800       The following commands describe how to use and manage the instruments
4801       database.
4802    
4803    6.8.1.  Creating a new instrument directory
4804    
4805       The front-end can add a new instrument directory to the instruments
4806       database by sending the following command:
4807    
4808          ADD DB_INSTRUMENT_DIRECTORY <dir>
4809    
4810       Where <dir> is the absolute path name of the directory to be created
4811       (encapsulated into apostrophes).
4812    
4813    
4814    
4815    Schoenebeck             Expires November 17, 2007              [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol             May 2007
4818    
4819    
4820       Possible Answers:
4821    
4822          "OK" -
4823    
4824             on success
4825    
4826          "ERR:<error-code>:<error-message>" -
4827    
4828             when the directory could not be created, which can happen if
4829             the directory already exists or the name contains not allowed
4830             symbols
4831    
4832       Examples:
4833    
4834          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
4835    
4836          S: "OK"
4837    
4838    6.8.2.  Deleting an instrument directory
4839    
4840       The front-end can delete a particular instrument directory from the
4841       instruments database by sending the following command:
4842    
4843          REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4844    
4845       Where <dir> is the absolute path name of the directory to delete.
4846       The optional FORCE argument can be used to force the deletion of a
4847       non-empty directory and all its content.
4848    
4849       Possible Answers:
4850    
4851          "OK" -
4852    
4853             if the directory is deleted successfully
4854    
4855          "ERR:<error-code>:<error-message>" -
4856    
4857             if the given directory does not exist, or if trying to delete a
4858             non-empty directory, without using the FORCE argument.
4859    
4860       Examples:
4861    
4862  Schoenebeck            Expires September 23, 2007              [Page 84]        C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
4863    
4864          S: "OK"
4865    
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck             Expires November 17, 2007              [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
4874    
4875    
4876    6.8.3.  Getting amount of instrument directories
4877    
4878       The front-end can retrieve the current amount of directories in a
4879       specific directory by sending the following command:
4880    
4881          GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4882    
4883       Where <dir> should be replaced by the absolute path name of the
4884       directory.  If RECURSIVE is specified, the number of all directories,
4885       including those located in subdirectories of the specified directory,
4886       will be returned.
4887    
4888       Possible Answers:
4889    
4890          The current number of instrument directories in the specified
4891          directory.
4892    
4893          "ERR:<error-code>:<error-message>" -
4894    
4895             if the given directory does not exist.
4896    
4897       Example:
4898    
4899          C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4900    
4901          S: "2"
4902    
4903    6.8.4.  Listing all directories in specific directory
4904    
4905       The front-end can retrieve the current list of directories in
4906       specific directory by sending the following command:
4907    
4908          LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4909    
4910       Where <dir> should be replaced by the absolute path name of the
4911       directory.  If RECURSIVE is specified, the absolute path names of all
4912       directories, including those located in subdirectories of the
4913       specified directory, will be returned.
4914    
4915       Possible Answers:
4916    
4917          A comma separated list of all instrument directories (encapsulated
4918          into apostrophes) in the specified directory.
4919    
4920          "ERR:<error-code>:<error-message>" -
4921    
4922             if the given directory does not exist.
4923    
4924    
4925    
4926    
4927    Schoenebeck             Expires November 17, 2007              [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol             May 2007
4930    
4931    
4932       Example:
4933    
4934          C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
4935    
4936          S: "'Piano Collection','Percussion Collection'"
4937    
4938          C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
4939    
4940          S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
4941          Collection/Acoustic/New','/Percussion Collection'"
4942    
4943    6.8.5.  Getting instrument directory information
4944    
4945       The front-end can ask for the current settings of an instrument
4946       directory by sending the following command:
4947    
4948          GET DB_INSTRUMENT_DIRECTORY INFO <dir>
4949    
4950       Where <dir> should be replaced by the absolute path name of the
4951       directory the front-end is interested in.
4952    
4953       Possible Answers:
4954    
4955          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4956          answer line begins with the settings category name followed by a
4957          colon and then a space character <SP> and finally the info
4958          character string to that setting category.  At the moment the
4959          following categories are defined:
4960    
4961    
4962    
4963             DESCRIPTION -
4964    
4965                A brief description of the directory content
4966    
4967             CREATED -
4968    
4969                The creation date and time of the directory, represented in
4970                "YYYY-MM-DD HH:MM:SS" format
4971    
4972             MODIFIED -
4973    
4974                The date and time of the last modification of the directory,
4975                represented in "YYYY-MM-DD HH:MM:SS" format
4976    
4977       The mentioned fields above don't have to be in particular order.
4978    
4979       Example:
4980    
4981    
4982    
4983    Schoenebeck             Expires November 17, 2007              [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol             May 2007
4986    
4987    
4988          C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
4989    
4990          S: "DESCRIPTION: Piano collection of instruments in GigaSampler
4991          format."
4992    
4993             "CREATED: 2007-02-05 10:23:12"
4994    
4995             "MODIFIED: 2007-04-07 12:50:21"
4996    
4997             "."
4998    
4999    6.8.6.  Renaming an instrument directory
5000    
5001       The front-end can alter the name of a specific instrument directory
5002       by sending the following command:
5003    
5004          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5005    
5006       Where <dir> is the absolute path name of the directory and <name> is
5007       the new name for that directory.
5008    
5009       Possible Answers:
5010    
5011          "OK" -
5012    
5013             on success
5014    
5015          "ERR:<error-code>:<error-message>" -
5016    
5017             in case the given directory does not exists, or if a directory
5018             with name equal to the new name already exists.
5019    
5020       Example:
5021    
5022          C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5023          'Acoustic'"
5024    
5025          S: "OK"
5026    
5027    6.8.7.  Moving an instrument directory
5028    
5029       The front-end can move a specific instrument directory by sending the
5030       following command:
5031    
5032          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5033    
5034       Where <dir> is the absolute path name of the directory to move and
5035       <dst> is the location where the directory will be moved to.
5036    
5037    
5038    
5039    Schoenebeck             Expires November 17, 2007              [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol             May 2007
5042    
5043    
5044       Possible Answers:
5045    
5046          "OK" -
5047    
5048             on success
5049    
5050          "ERR:<error-code>:<error-message>" -
5051    
5052             in case a given directory does not exists, or if a directory
5053             with name equal to the name of the specified directory already
5054             exists in the destination directory.  Error is also thrown when
5055             trying to move a directory to a subdirectory of itself.
5056    
5057       Example:
5058    
5059          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5060          Acoustic'"
5061    
5062          S: "OK"
5063    
5064    6.8.8.  Copying instrument directories
5065    
5066       The front-end can copy a specific instrument directory by sending the
5067       following command:
5068    
5069          COPY DB_INSTRUMENT_DIRECTORY <dir> <dst>
5070    
5071       Where <dir> is the absolute path name of the directory to copy and
5072       <dst> is the location where the directory will be copied to.
5073    
5074       Possible Answers:
5075    
5076          "OK" -
5077    
5078             on success
5079    
5080          "ERR:<error-code>:<error-message>" -
5081    
5082             in case a given directory does not exists, or if a directory
5083             with name equal to the name of the specified directory already
5084             exists in the destination directory.  Error is also thrown when
5085             trying to copy a directory to a subdirectory of itself.
5086    
5087       Example:
5088    
5089          C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5090          '/Acoustic/Pianos'"
5091    
5092    
5093    
5094    
5095    Schoenebeck             Expires November 17, 2007              [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol             May 2007
5098    
5099    
5100          S: "OK"
5101    
5102    6.8.9.  Changing the description of directory
5103    
5104       The front-end can alter the description of a specific instrument
5105       directory by sending the following command:
5106    
5107          SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5108    
5109       Where <dir> is the absolute path name of the directory and <desc> is
5110       the new description for the directory.
5111    
5112       Possible Answers:
5113    
5114          "OK" -
5115    
5116             on success
5117    
5118          "ERR:<error-code>:<error-message>" -
5119    
5120             in case the given directory does not exists.
5121    
5122       Example:
5123    
5124          C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5125          collection of piano instruments in various format.'"
5126    
5127          S: "OK"
5128    
5129    6.8.10.  Finding directories
5130    
5131       The front-end can search for directories in specific directory by
5132       sending the following command:
5133    
5134          FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-
5135          list>
5136    
5137       Where <dir> should be replaced by the absolute path name of the
5138       directory to search in.  If NON_RECURSIVE is specified, the
5139       directories located in subdirectories of the specified directory will
5140       not be searched. <criteria-list> is a list of search criterias in
5141       form of "key1=val1 key2=val2 ...".  The following criterias are
5142       allowed:
5143    
5144       NAME='<search-string>'
5145    
5146          Restricts the search to directories, which names satisfy the
5147          supplied search string.
5148    
5149    
5150    
5151    Schoenebeck             Expires November 17, 2007              [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol             May 2007
5154    
5155    
5156       CREATED='[<date-after>]..[<date-before>]'
5157    
5158          Restricts the search to directories, which creation date satisfies
5159          the specified period, where <date-after> and <date-before> are in
5160          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5161          search is restricted to directories created before <date-before>.
5162          If <date-before> is omitted, the search is restricted to
5163          directories created after <date-after>.
5164    
5165       MODIFIED='[<date-after>]..[<date-before>]'
5166    
5167          Restricts the search to directories, which date of last
5168          modification satisfies the specified period, where <date-after>
5169          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5170          after> is omitted the search is restricted to directories, which
5171          are last modified before <date-before>.  If <date-before> is
5172          omitted, the search is restricted to directories, which are last
5173          modified after <date-after>.
5174    
5175       DESCRIPTION='<search-string>'
5176    
5177          Restricts the search to directories with description that
5178          satisfies the supplied search string.
5179    
5180       Where <search-string> is either a regular expression, or a word list
5181       separated with spaces for OR search and with '+' for AND search.
5182    
5183       Possible Answers:
5184    
5185          A comma separated list with the absolute path names (encapsulated
5186          into apostrophes) of all directories in the specified directory
5187          that satisfy the supplied search criterias.
5188    
5189          "ERR:<error-code>:<error-message>" -
5190    
5191             if the given directory does not exist.
5192    
5193       Example:
5194    
5195          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5196    
5197          S: "'/Piano Collection'"
5198    
5199          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5200          30:13'"
5201    
5202          S: "'/Piano Collection','/Percussions'"
5203    
5204    
5205    
5206    
5207    Schoenebeck             Expires November 17, 2007              [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol             May 2007
5210    
5211    
5212    6.8.11.  Adding instruments to the instruments database
5213    
5214       The front-end can add one or more instruments to the instruments
5215       database by sending the following command:
5216    
5217          ADD DB_INSTRUMENTS [<mode>] <db_dir> <file_path> [<instr_index>]
5218    
5219       Where <db_dir> is the absolute path name of a directory (encapsulated
5220       into apostrophes) in the instruments database in which only the new
5221       instruments (that are not already in the database) will be added,
5222       <file_path> is the absolute path name of a file or directory in the
5223       file system (encapsulated into apostrophes).  In case an instrument
5224       file is supplied, only the instruments in the specified file will be
5225       added to the instruments database.  If the optional <instr_index>
5226       (the index of the instrument within the given file) is supplied too,
5227       then only the specified instrument will be added.  In case a
5228       directory is supplied, the instruments in that directory will be
5229       added.  The OPTIONAL <mode> argument is only applied when a directory
5230       is provided as <file_path> and specifies how the scanning will be
5231       done and has exactly the following possibilities:
5232    
5233          "NON_RECURSIVE" -
5234    
5235             Only the instruments in the specified directory will be added,
5236             the instruments in the subdirectories will not be processed.
5237    
5238          "FLAT" -
5239    
5240             All instruments will be processed, including those in the
5241             subdirectories, but the respective subdirectory structure will
5242             not be recreated in the instruments database.  All instruments
5243             will be added directly in the specified database directory.
5244    
5245          not supplied -
5246    
5247             The subdirectory tree structure will be recreated in the
5248             instruments database and all instruments will be processed and
5249             added to the respective subdirectory in the instruments
5250             database.
5251    
5252       Possible Answers:
5253    
5254          "OK" -
5255    
5256             on success
5257    
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck             Expires November 17, 2007              [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol             May 2007
5266    
5267    
5268          "ERR:<error-code>:<error-message>" -
5269    
5270             if an invalid path is specified.
5271    
5272       Examples:
5273    
5274          C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5275          Bosendorfer 290.gig' 0"
5276    
5277          S: "OK"
5278    
5279    6.8.12.  Removing an instrument
5280    
5281       The front-end can remove a particular instrument from the instruments
5282       database by sending the following command:
5283    
5284          REMOVE DB_INSTRUMENT <instr_path>
5285    
5286       Where <instr_path> is the absolute path name (in the instruments
5287       database) of the instrument to remove.
5288    
5289       Possible Answers:
5290    
5291          "OK" -
5292    
5293             if the instrument is removed successfully
5294    
5295          "ERR:<error-code>:<error-message>" -
5296    
5297             if the given path does not exist or is a directory.
5298    
5299       Examples:
5300    
5301          C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
5302    
5303          S: "OK"
5304    
5305    6.8.13.  Getting amount of instruments
5306    
5307       The front-end can retrieve the current amount of instruments in a
5308       specific directory by sending the following command:
5309    
5310          GET DB_INSTRUMENTS [RECURSIVE] <dir>
5311    
5312       Where <dir> should be replaced by the absolute path name of the
5313       directory.  If RECURSIVE is specified, the number of all instruments,
5314       including those located in subdirectories of the specified directory,
5315       will be returned.
5316    
5317    
5318    
5319    Schoenebeck             Expires November 17, 2007              [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol             May 2007
5322    
5323    
5324       Possible Answers:
5325    
5326          The current number of instruments in the specified directory.
5327    
5328          "ERR:<error-code>:<error-message>" -
5329    
5330             if the given directory does not exist.
5331    
5332       Example:
5333    
5334          C: "GET DB_INSTRUMENTS '/Piano Collection'"
5335    
5336          S: "2"
5337    
5338    6.8.14.  Listing all instruments in specific directory
5339    
5340       The front-end can retrieve the current list of instruments in
5341       specific directory by sending the following command:
5342    
5343          LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5344    
5345       Where <dir> should be replaced by the absolute path name of the
5346       directory.  If RECURSIVE is specified, the absolute path names of all
5347       instruments, including those located in subdirectories of the
5348       specified directory, will be returned.
5349    
5350       Possible Answers:
5351    
5352          A comma separated list of all instruments (encapsulated into
5353          apostrophes) in the specified directory.
5354    
5355          "ERR:<error-code>:<error-message>" -
5356    
5357             if the given directory does not exist.
5358    
5359       Example:
5360    
5361          C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5362    
5363          S: "'Bosendorfer 290','Steinway D'"
5364    
5365          C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
5366    
5367          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5368          Steinway D','/Piano Collection/Lite/Free Piano'"
5369    
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck             Expires November 17, 2007              [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol             May 2007
5378    
5379    
5380    6.8.15.  Getting instrument information
5381    
5382       The front-end can ask for the current settings of an instrument by
5383       sending the following command:
5384    
5385          GET DB_INSTRUMENT INFO <instr_path>
5386    
5387       Where <instr_path> should be replaced by the absolute path name of
5388       the instrument the front-end is interested in.
5389    
5390       Possible Answers:
5391    
5392          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5393          answer line begins with the settings category name followed by a
5394          colon and then a space character <SP> and finally the info
5395          character string to that setting category.  At the moment the
5396          following categories are defined:
5397    
5398    
5399    
5400             INSTRUMENT_FILE -
5401    
5402                File name of the instrument.
5403    
5404             INSTRUMENT_NR -
5405    
5406                Index of the instrument within the file.
5407    
5408             FORMAT_FAMILY -
5409    
5410                The format family of the instrument.
5411    
5412             FORMAT_VERSION -
5413    
5414                The format version of the instrument.
5415    
5416             SIZE -
5417    
5418                The size of the instrument in bytes.
5419    
5420             CREATED -
5421    
5422                The date and time when the instrument is added in the
5423                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5424                format
5425    
5426    
5427    
5428    
5429    
5430    
5431    Schoenebeck             Expires November 17, 2007              [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol             May 2007
5434    
5435    
5436             MODIFIED -
5437    
5438                The date and time of the last modification of the
5439                instrument's database settings, represented in "YYYY-MM-DD
5440                HH:MM:SS" format
5441    
5442             DESCRIPTION -
5443    
5444                A brief description of the instrument
5445    
5446             IS_DRUM -
5447    
5448                either true or false, determines whether the instrument is a
5449                drumkit or a chromatic instrument
5450    
5451             PRODUCT -
5452    
5453                The product title of the instrument
5454    
5455             ARTISTS -
5456    
5457                Lists the artist names
5458    
5459             KEYWORDS -
5460    
5461                Provides a list of keywords that refer to the instrument.
5462                Keywords are separated with semicolon and blank.
5463    
5464       The mentioned fields above don't have to be in particular order.
5465    
5466       Example:
5467    
5468          C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
5469    
5470          S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
5471    
5472             "INSTRUMENT_NR: 0"
5473    
5474             "FORMAT_FAMILY: GIG"
5475    
5476             "FORMAT_VERSION: 2"
5477    
5478             "SIZE: 2050871870"
5479    
5480             "CREATED: 2007-02-05 10:23:12"
5481    
5482             "MODIFIED: 2007-04-07 12:50:21"
5483    
5484    
5485    
5486    
5487    Schoenebeck             Expires November 17, 2007              [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol             May 2007
5490    
5491    
5492             "DESCRIPTION: "
5493    
5494             "IS_DRUM: false"
5495    
5496             "PRODUCT: GRANDIOSO Bosendorfer 290"
5497    
5498             "ARTISTS: Post Musical Instruments"
5499    
5500             "KEYWORDS: Bosendorfer"
5501    
5502             "."
5503    
5504    6.8.16.  Renaming an instrument
5505    
5506       The front-end can alter the name of a specific instrument by sending
5507       the following command:
5508    
5509          SET DB_INSTRUMENT NAME <instr> <name>
5510    
5511       Where <instr> is the absolute path name of the instrument and <name>
5512       is the new name for that instrument.
5513    
5514       Possible Answers:
5515    
5516          "OK" -
5517    
5518             on success
5519    
5520          "ERR:<error-code>:<error-message>" -
5521    
5522             in case the given instrument does not exists, or if an
5523             instrument with name equal to the new name already exists.
5524    
5525       Example:
5526    
5527          C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
5528          'Bosendorfer 290'"
5529    
5530          S: "OK"
5531    
5532    6.8.17.  Moving an instrument
5533    
5534       The front-end can move a specific instrument to another directory by
5535       sending the following command:
5536    
5537          MOVE DB_INSTRUMENT <instr> <dst>
5538    
5539       Where <instr> is the absolute path name of the instrument to move and
5540    
5541    
5542    
5543    Schoenebeck             Expires November 17, 2007              [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol             May 2007
5546    
5547    
5548       <dst> is the directory where the instrument will be moved to.
5549    
5550       Possible Answers:
5551    
5552          "OK" -
5553    
5554             on success
5555    
5556          "ERR:<error-code>:<error-message>" -
5557    
5558             in case the given instrument does not exists, or if an
5559             instrument with name equal to the name of the specified
5560             instrument already exists in the destination directory.
5561    
5562       Example:
5563    
5564          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
5565          Collection/Acoustic'"
5566    
5567          S: "OK"
5568    
5569    6.8.18.  Copying instruments
5570    
5571       The front-end can copy a specific instrument to another directory by
5572       sending the following command:
5573    
5574          COPY DB_INSTRUMENT <instr> <dst>
5575    
5576       Where <instr> is the absolute path name of the instrument to copy and
5577       <dst> is the directory where the instrument will be copied to.
5578    
5579       Possible Answers:
5580    
5581          "OK" -
5582    
5583             on success
5584    
5585          "ERR:<error-code>:<error-message>" -
5586    
5587             in case the given instrument does not exists, or if an
5588             instrument with name equal to the name of the specified
5589             instrument already exists in the destination directory.
5590    
5591       Example:
5592    
5593          C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
5594          '/Acoustic/Pianos/'"
5595    
5596    
5597    
5598    
5599    Schoenebeck             Expires November 17, 2007             [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol             May 2007
5602    
5603    
5604          S: "OK"
5605    
5606    6.8.19.  Changing the description of instrument
5607    
5608       The front-end can alter the description of a specific instrument by
5609       sending the following command:
5610    
5611          SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5612    
5613       Where <instr> is the absolute path name of the instrument and <desc>
5614       is the new description for the instrument.
5615    
5616       Possible Answers:
5617    
5618          "OK" -
5619    
5620             on success
5621    
5622          "ERR:<error-code>:<error-message>" -
5623    
5624             in case the given instrument does not exists.
5625    
5626       Example:
5627    
5628          C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
5629          Bosendorfer 290' 'No comment :)'"
5630    
5631          S: "OK"
5632    
5633    6.8.20.  Finding instruments
5634    
5635       The front-end can search for instruments in specific directory by
5636       sending the following command:
5637    
5638          FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5639    
5640       Where <dir> should be replaced by the absolute path name of the
5641       directory to search in.  If NON_RECURSIVE is specified, the
5642       directories located in subdirectories of the specified directory will
5643       not be searched. <criteria-list> is a list of search criterias in
5644       form of "key1=val1 key2=val2 ...".  The following criterias are
5645       allowed:
5646    
5647       NAME='<search-string>'
5648    
5649          Restricts the search to instruments, which names satisfy the
5650          supplied search string.
5651    
5652    
5653    
5654    
5655    Schoenebeck             Expires November 17, 2007             [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol             May 2007
5658    
5659    
5660       SIZE=[<min>]..[<max>]
5661    
5662          Restricts the search to instruments, which size is in the
5663          specified range.  If <min> is omitted, the search results are
5664          restricted to instruments with size less then or equal to <max>.
5665          If <max> is omitted, the search is restricted to instruments with
5666          size greater then or equal to <min>.
5667    
5668       CREATED='[<date-after>]..[<date-before>]'
5669    
5670          Restricts the search to instruments, which creation date satisfies
5671          the specified period, where <date-after> and <date-before> are in
5672          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5673          search is restricted to instruments created before <date-before>.
5674          If <date-before> is omitted, the search is restricted to
5675          instruments created after <date-after>.
5676    
5677       MODIFIED='[<date-after>]..[<date-before>]'
5678    
5679          Restricts the search to instruments, which date of last
5680          modification satisfies the specified period, where <date-after>
5681          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5682          after> is omitted the search is restricted to instruments, which
5683          are last modified before <date-before>.  If <date-before> is
5684          omitted, the search is restricted to instruments, which are last
5685          modified after <date-after>.
5686    
5687       DESCRIPTION='<search-string>'
5688    
5689          Restricts the search to instruments with description that
5690          satisfies the supplied search string.
5691    
5692       PRODUCT='<search-string>'
5693    
5694          Restricts the search to instruments with product info that
5695          satisfies the supplied search string.
5696    
5697       ARTISTS='<search-string>'
5698    
5699          Restricts the search to instruments with artists info that
5700          satisfies the supplied search string.
5701    
5702       KEYWORDS='<search-string>'
5703    
5704          Restricts the search to instruments with keyword list that
5705          satisfies the supplied search string.
5706    
5707       IS_DRUM=true | false
5708    
5709    
5710    
5711    Schoenebeck             Expires November 17, 2007             [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol             May 2007
5714    
5715    
5716          Either true or false.  Restricts the search to drum kits or
5717          chromatic instruments.
5718    
5719       FORMAT_FAMILIES='<format-list>'
5720    
5721          Restricts the search to instruments of the supplied format
5722          families, where <format-list> is a comma separated list of format
5723          families.
5724    
5725       Where <search-string> is either a regular expression, or a word list
5726       separated with spaces for OR search and with '+' for AND search.
5727    
5728       Possible Answers:
5729    
5730          A comma separated list with the absolute path names (encapsulated
5731          into apostrophes) of all instruments in the specified directory
5732          that satisfy the supplied search criterias.
5733    
5734          "ERR:<error-code>:<error-message>" -
5735    
5736             if the given directory does not exist.
5737    
5738       Example:
5739    
5740          C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5741          290'"
5742    
5743          S: "'/Piano Collection/Bosendorfer 290'"
5744    
5745          C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
5746          09:30:13..'"
5747    
5748          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5749          Steinway D'"
5750    
5751    
5752    
5753    
5754    
5755    
5756    
5757    
5758    
5759    
5760    
5761    
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck             Expires November 17, 2007             [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol             May 2007
5770    
5771    
5772  7.  Command Syntax  7.  Command Syntax
# Line 4756  Internet-Draft        LinuxSampler Contr Line 5820  Internet-Draft        LinuxSampler Contr
5820    
5821    
5822    
5823  Schoenebeck            Expires September 23, 2007              [Page 85]  Schoenebeck             Expires November 17, 2007             [Page 104]
5824    
5825  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
5826    
5827    
5828        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4773  Internet-Draft        LinuxSampler Contr Line 5837  Internet-Draft        LinuxSampler Contr
5837    
5838        / UNSUBSCRIBE SP unsubscribe_event        / UNSUBSCRIBE SP unsubscribe_event
5839    
       / SELECT SP text  
   
5840        / RESET SP reset_instruction        / RESET SP reset_instruction
5841    
5842        / CLEAR SP clear_instruction        / CLEAR SP clear_instruction
5843    
5844          / FIND SP find_instruction
5845    
5846          / MOVE SP move_instruction
5847    
5848          / COPY SP copy_instruction
5849    
5850        / RESET        / RESET
5851    
5852        / QUIT        / QUIT
# Line 4787  Internet-Draft        LinuxSampler Contr Line 5855  Internet-Draft        LinuxSampler Contr
5855    
5856        CHANNEL        CHANNEL
5857    
5858          / DB_INSTRUMENT_DIRECTORY SP pathname
5859    
5860          / DB_INSTRUMENTS SP FLAT SP pathname SP pathname
5861    
5862          / DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
5863    
5864          / DB_INSTRUMENTS SP pathname SP pathname
5865    
5866          / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5867    
5868        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
5869    
5870        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
# Line 4795  Internet-Draft        LinuxSampler Contr Line 5873  Internet-Draft        LinuxSampler Contr
5873    
5874        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
5875    
5876    
5877    
5878    
5879    Schoenebeck             Expires November 17, 2007             [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol             May 2007
5882    
5883    
5884        / AUDIO_OUTPUT_DEVICE_INFO        / AUDIO_OUTPUT_DEVICE_INFO
5885    
5886        / MIDI_INPUT_DEVICE_COUNT        / MIDI_INPUT_DEVICE_COUNT
# Line 4809  Internet-Draft        LinuxSampler Contr Line 5895  Internet-Draft        LinuxSampler Contr
5895    
5896        / BUFFER_FILL        / BUFFER_FILL
5897    
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
5898        / CHANNEL_INFO        / CHANNEL_INFO
5899    
5900        / FX_SEND_COUNT        / FX_SEND_COUNT
# Line 4831  Internet-Draft        LinuxSampler Contr Line 5909  Internet-Draft        LinuxSampler Contr
5909    
5910        / MIDI_INSTRUMENT_INFO        / MIDI_INSTRUMENT_INFO
5911    
5912          / DB_INSTRUMENT_DIRECTORY_COUNT
5913    
5914          / DB_INSTRUMENT_DIRECTORY_INFO
5915    
5916          / DB_INSTRUMENT_COUNT
5917    
5918          / DB_INSTRUMENT_INFO
5919    
5920        / MISCELLANEOUS        / MISCELLANEOUS
5921    
5922        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
# Line 4843  Internet-Draft        LinuxSampler Contr Line 5929  Internet-Draft        LinuxSampler Contr
5929    
5930        / AUDIO_OUTPUT_DEVICE_INFO        / AUDIO_OUTPUT_DEVICE_INFO
5931    
5932    
5933    
5934    
5935    Schoenebeck             Expires November 17, 2007             [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol             May 2007
5938    
5939    
5940        / MIDI_INPUT_DEVICE_COUNT        / MIDI_INPUT_DEVICE_COUNT
5941    
5942        / MIDI_INPUT_DEVICE_INFO        / MIDI_INPUT_DEVICE_INFO
# Line 4865  Internet-Draft        LinuxSampler Contr Line 5959  Internet-Draft        LinuxSampler Contr
5959    
5960        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
5961    
5962          / MIDI_INSTRUMENT_COUNT
5963    
5964          / MIDI_INSTRUMENT_INFO
5965    
5966          / DB_INSTRUMENT_DIRECTORY_COUNT
5967    
5968  Schoenebeck            Expires September 23, 2007              [Page 87]        / DB_INSTRUMENT_DIRECTORY_INFO
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
5969    
5970        / MIDI_INSTRUMENT_COUNT        / DB_INSTRUMENT_COUNT
5971    
5972        / MIDI_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
5973    
5974        / MISCELLANEOUS        / MISCELLANEOUS
5975    
# Line 4892  Internet-Draft        LinuxSampler Contr Line 5986  Internet-Draft        LinuxSampler Contr
5986        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
5987        instr_load_mode        instr_load_mode
5988    
5989    
5990    
5991    Schoenebeck             Expires November 17, 2007             [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol             May 2007
5994    
5995    
5996        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
5997        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
5998        entry_name        entry_name
# Line 4912  Internet-Draft        LinuxSampler Contr Line 6013  Internet-Draft        LinuxSampler Contr
6013    
6014        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
6015    
6016          / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
6017    
6018          / DB_INSTRUMENT_DIRECTORY SP pathname
6019    
6020          / DB_INSTRUMENT SP pathname
6021    
6022     get_instruction =     get_instruction =
6023    
6024        AVAILABLE_ENGINES        AVAILABLE_ENGINES
# Line 4920  Internet-Draft        LinuxSampler Contr Line 6027  Internet-Draft        LinuxSampler Contr
6027    
6028        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
6029    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
6030        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6031    
6032        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
# Line 4943  Internet-Draft        LinuxSampler Contr Line 6041  Internet-Draft        LinuxSampler Contr
6041        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6042        key_val_list        key_val_list
6043    
6044    
6045    
6046    
6047    Schoenebeck             Expires November 17, 2007             [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol             May 2007
6050    
6051    
6052        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
6053    
6054        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 4976  Internet-Draft        LinuxSampler Contr Line 6082  Internet-Draft        LinuxSampler Contr
6082    
6083        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
6084    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
6085        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
6086    
6087        / MIDI_INSTRUMENTS SP midi_map        / MIDI_INSTRUMENTS SP midi_map
# Line 4999  Internet-Draft        LinuxSampler Contr Line 6096  Internet-Draft        LinuxSampler Contr
6096    
6097        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6098    
6099    
6100    
6101    
6102    
6103    Schoenebeck             Expires November 17, 2007             [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol             May 2007
6106    
6107    
6108        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6109    
6110          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6111    
6112          / DB_INSTRUMENT_DIRECTORIES SP pathname
6113    
6114          / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
6115    
6116          / DB_INSTRUMENTS SP RECURSIVE SP pathname
6117    
6118          / DB_INSTRUMENTS SP pathname
6119    
6120          / DB_INSTRUMENT SP INFO SP pathname
6121    
6122        / VOLUME        / VOLUME
6123    
6124     set_instruction =     set_instruction =
# Line 5021  Internet-Draft        LinuxSampler Contr Line 6139  Internet-Draft        LinuxSampler Contr
6139    
6140        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6141    
6142          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6143    
6144        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id        / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
6145        SP audio_channel_index SP audio_channel_index        SP audio_channel_index SP audio_channel_index
6146    
# Line 5030  Internet-Draft        LinuxSampler Contr Line 6150  Internet-Draft        LinuxSampler Contr
6150        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6151        volume_value        volume_value
6152    
6153        / ECHO SP boolean        / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
6154    
6155    
6156    
6157    
6158    
6159  Schoenebeck            Expires September 23, 2007              [Page 90]  Schoenebeck             Expires November 17, 2007             [Page 110]
6160    
6161  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6162    
6163    
6164          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
6165    
6166          / DB_INSTRUMENT SP NAME SP pathname SP dirname
6167    
6168          / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
6169    
6170          / ECHO SP boolean
6171    
6172        / VOLUME SP volume_value        / VOLUME SP volume_value
6173    
# Line 5067  Internet-Draft        LinuxSampler Contr Line 6195  Internet-Draft        LinuxSampler Contr
6195    
6196        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
6197    
6198       find_instruction =
6199    
6200          DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
6201    
6202          / DB_INSTRUMENTS SP pathname SP query_val_list
6203    
6204          / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP
6205          query_val_list
6206    
6207          / DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
6208    
6209       move_instruction =
6210    
6211    
6212    
6213    
6214    
6215    Schoenebeck             Expires November 17, 2007             [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol             May 2007
6218    
6219    
6220          DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6221    
6222          / DB_INSTRUMENT SP pathname SP pathname
6223    
6224       copy_instruction =
6225    
6226          DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6227    
6228          / DB_INSTRUMENT SP pathname SP pathname
6229    
6230     destroy_instruction =     destroy_instruction =
6231    
6232        AUDIO_OUTPUT_DEVICE SP number        AUDIO_OUTPUT_DEVICE SP number
# Line 5088  Internet-Draft        LinuxSampler Contr Line 6248  Internet-Draft        LinuxSampler Contr
6248        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
6249        SP audio_channel_index        SP audio_channel_index
6250    
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
6251        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6252    
6253        / MIDI_INPUT SP sampler_channel SP device_index SP        / MIDI_INPUT SP sampler_channel SP device_index SP
# Line 5113  Internet-Draft        LinuxSampler Contr Line 6264  Internet-Draft        LinuxSampler Contr
6264    
6265        / VOLUME SP sampler_channel SP volume_value        / VOLUME SP sampler_channel SP volume_value
6266    
6267    
6268    
6269    
6270    
6271    Schoenebeck             Expires November 17, 2007             [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol             May 2007
6274    
6275    
6276        / MUTE SP sampler_channel SP boolean        / MUTE SP sampler_channel SP boolean
6277    
6278        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
# Line 5145  Internet-Draft        LinuxSampler Contr Line 6305  Internet-Draft        LinuxSampler Contr
6305    
6306        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
6307    
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
   
   
6308        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
6309    
6310        / CHANNELS        / CHANNELS
# Line 5169  Internet-Draft        LinuxSampler Contr Line 6321  Internet-Draft        LinuxSampler Contr
6321    
6322        / MIDI_INSTRUMENT_MAPS        / MIDI_INSTRUMENT_MAPS
6323    
6324    
6325    
6326    
6327    Schoenebeck             Expires November 17, 2007             [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol             May 2007
6330    
6331    
6332        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
6333    
6334          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6335    
6336          / DB_INSTRUMENT_DIRECTORIES SP pathname
6337    
6338          / DB_INSTRUMENTS SP RECURSIVE SP pathname
6339    
6340          / DB_INSTRUMENTS SP pathname
6341    
6342     load_instr_args =     load_instr_args =
6343    
6344        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 5201  Internet-Draft        LinuxSampler Contr Line 6369  Internet-Draft        LinuxSampler Contr
6369    
6370        string        string
6371    
6372       midi_input_port_index =
6373    
6374          number
6375    
6376       midi_input_channel_index =
6377    
6378  Schoenebeck            Expires September 23, 2007              [Page 93]        number
   
 Internet-Draft        LinuxSampler Control Protocol           March 2007  
6379    
6380    
    midi_input_port_index =  
6381    
       number  
6382    
6383     midi_input_channel_index =  Schoenebeck             Expires November 17, 2007             [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol             May 2007
6386    
       number  
6387    
6388        / ALL        / ALL
6389    
# Line 5257  Internet-Draft        LinuxSampler Contr Line 6425  Internet-Draft        LinuxSampler Contr
6425    
6426        number        number
6427    
6428       engine_name =
6429    
6430          string
6431    
6432       pathname =
6433    
6434          stringval
6435    
6436    
6437  Schoenebeck            Expires September 23, 2007              [Page 94]  
6438    
6439    Schoenebeck             Expires November 17, 2007             [Page 115]
6440    
6441  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6442    
6443    
6444     engine_name =     dirname =
6445    
6446        string        stringval
6447    
6448     filename =     filename =
6449    
# Line 5301  Internet-Draft        LinuxSampler Contr Line 6477  Internet-Draft        LinuxSampler Contr
6477    
6478        / dotnum        / dotnum
6479    
6480       query_val_list =
6481    
6482          string '=' query_val
6483    
6484          / query_val_list SP string '=' query_val
6485    
6486       query_val =
6487    
6488          string
6489    
6490          / stringval
6491    
6492    
6493    
6494    
6495    Schoenebeck             Expires November 17, 2007             [Page 116]
   
   
   
   
   
 Schoenebeck            Expires September 23, 2007              [Page 95]  
6496    
6497  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6498    
6499    
6500  8.  Events  8.  Events
# Line 5372  Internet-Draft        LinuxSampler Contr Line 6548  Internet-Draft        LinuxSampler Contr
6548    
6549    
6550    
6551  Schoenebeck            Expires September 23, 2007              [Page 96]  Schoenebeck             Expires November 17, 2007             [Page 117]
6552    
6553  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6554    
6555    
6556        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 5428  Internet-Draft        LinuxSampler Contr Line 6604  Internet-Draft        LinuxSampler Contr
6604    
6605    
6606    
6607  Schoenebeck            Expires September 23, 2007              [Page 97]  Schoenebeck             Expires November 17, 2007             [Page 118]
6608    
6609  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6610    
6611    
6612        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
# Line 5484  Internet-Draft        LinuxSampler Contr Line 6660  Internet-Draft        LinuxSampler Contr
6660    
6661    
6662    
6663  Schoenebeck            Expires September 23, 2007              [Page 98]  Schoenebeck             Expires November 17, 2007             [Page 119]
6664    
6665  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6666    
6667    
6668        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
# Line 5540  Internet-Draft        LinuxSampler Contr Line 6716  Internet-Draft        LinuxSampler Contr
6716    
6717    
6718    
6719  Schoenebeck            Expires September 23, 2007              [Page 99]  Schoenebeck             Expires November 17, 2007             [Page 120]
6720    
6721  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6722    
6723    
6724        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
# Line 5596  Internet-Draft        LinuxSampler Contr Line 6772  Internet-Draft        LinuxSampler Contr
6772    
6773    
6774    
6775  Schoenebeck            Expires September 23, 2007             [Page 100]  Schoenebeck             Expires November 17, 2007             [Page 121]
6776    
6777  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6778    
6779    
6780        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
# Line 5652  Internet-Draft        LinuxSampler Contr Line 6828  Internet-Draft        LinuxSampler Contr
6828    
6829    
6830    
6831  Schoenebeck            Expires September 23, 2007             [Page 101]  Schoenebeck             Expires November 17, 2007             [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol             May 2007
6834    
6835    
6836    8.18.  Number of database instrument directories changed
6837    
6838       Client may want to be notified when the number of instrument
6839       directories in a particular directory in the instruments database is
6840       changed by issuing the following command:
6841    
6842          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
6843    
6844       Server will start sending the following notification messages:
6845    
6846          "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
6847    
6848       where <dir-path> will be replaced by the absolute path name of the
6849       directory in the instruments database, in which the number of
6850       directories is changed.
6851    
6852       Note that when a non-empty directory is removed, this event is not
6853       sent for the subdirectories in that directory.
6854    
6855    8.19.  Database instrument directory information changed
6856    
6857       Client may want to be notified when changes were made to directories
6858       in the instruments database by issuing the following command:
6859    
6860          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
6861    
6862       Server will start sending the following notification messages:
6863    
6864          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
6865    
6866       where <dir-path> will be replaced by the absolute path name of the
6867       directory, for which information changes occurred.  The front-end
6868       will have to send the respective command to actually get the updated
6869       directory info.  Because these messages will be triggered by LSCP
6870       commands issued by other clients rather than real time events
6871       happening on the server, it is believed that an empty notification
6872       message is sufficient here.
6873    
6874          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
6875          name>"
6876    
6877       where <old-dir-path> is the old absolute path name of the directory
6878       (encapsulated into apostrophes), which name is changes and <new-name>
6879       is the new name of the directory, encapsulated into apostrophes.
6880    
6881    
6882    
6883    
6884    
6885    
6886    
6887    Schoenebeck             Expires November 17, 2007             [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol             May 2007
6890    
6891    
6892    8.20.  Number of database instruments changed
6893    
6894       Client may want to be notified when the number of instruments in a
6895       particular directory in the instruments database is changed by
6896       issuing the following command:
6897    
6898          SUBSCRIBE DB_INSTRUMENT_COUNT
6899    
6900       Server will start sending the following notification messages:
6901    
6902          "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
6903    
6904       where <dir-path> will be replaced by the absolute path name of the
6905       directory in the instruments database, in which the number of
6906       instruments is changed.
6907    
6908       Note that when a non-empty directory is removed, this event is not
6909       sent for the instruments in that directory.
6910    
6911    8.21.  Database instrument information changed
6912    
6913       Client may want to be notified when changes were made to instruments
6914       in the instruments database by issuing the following command:
6915    
6916          SUBSCRIBE DB_INSTRUMENT_INFO
6917    
6918       Server will start sending the following notification messages:
6919    
6920          "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
6921    
6922       where <instr-path> will be replaced by the absolute path name of the
6923       instrument, which settings are changed.  The front-end will have to
6924       send the respective command to actually get the updated directory
6925       info.  Because these messages will be triggered by LSCP commands
6926       issued by other clients rather than real time events happening on the
6927       server, it is believed that an empty notification message is
6928       sufficient here.
6929    
6930          "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
6931    
6932       where <old-instr-path> is the old absolute path name of the
6933       instrument (encapsulated into apostrophes), which name is changes and
6934       <new-name> is the new name of the instrument, encapsulated into
6935       apostrophes.
6936    
6937    
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck             Expires November 17, 2007             [Page 124]
6944    
6945  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
6946    
6947    
6948  8.18.  Miscellaneous and debugging events  8.22.  Miscellaneous and debugging events
6949    
6950     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
6951     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 5708  Internet-Draft        LinuxSampler Contr Line 6996  Internet-Draft        LinuxSampler Contr
6996    
6997    
6998    
6999  Schoenebeck            Expires September 23, 2007             [Page 102]  Schoenebeck             Expires November 17, 2007             [Page 125]
7000    
7001  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
7002    
7003    
7004  9.  Security Considerations  9.  Security Considerations
# Line 5764  Internet-Draft        LinuxSampler Contr Line 7052  Internet-Draft        LinuxSampler Contr
7052    
7053    
7054    
7055  Schoenebeck            Expires September 23, 2007             [Page 103]  Schoenebeck             Expires November 17, 2007             [Page 126]
7056    
7057  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
7058    
7059    
7060  10.  Acknowledgments  10.  Acknowledgments
# Line 5820  Internet-Draft        LinuxSampler Contr Line 7108  Internet-Draft        LinuxSampler Contr
7108    
7109    
7110    
7111  Schoenebeck            Expires September 23, 2007             [Page 104]  Schoenebeck             Expires November 17, 2007             [Page 127]
7112    
7113  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
7114    
7115    
7116  11.  References  11.  References
# Line 5876  Internet-Draft        LinuxSampler Contr Line 7164  Internet-Draft        LinuxSampler Contr
7164    
7165    
7166    
7167  Schoenebeck            Expires September 23, 2007             [Page 105]  Schoenebeck             Expires November 17, 2007             [Page 128]
7168    
7169  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
7170    
7171    
7172  Author's Address  Author's Address
# Line 5932  Author's Address Line 7220  Author's Address
7220    
7221    
7222    
7223  Schoenebeck            Expires September 23, 2007             [Page 106]  Schoenebeck             Expires November 17, 2007             [Page 129]
7224    
7225  Internet-Draft        LinuxSampler Control Protocol           March 2007  Internet-Draft        LinuxSampler Control Protocol             May 2007
7226    
7227    
7228  Full Copyright Statement  Full Copyright Statement
# Line 5988  Acknowledgment Line 7276  Acknowledgment
7276    
7277    
7278    
7279  Schoenebeck            Expires September 23, 2007             [Page 107]  Schoenebeck             Expires November 17, 2007             [Page 130]
7280    
Legend:
Removed from v.1110  
changed lines
  Added in v.1189
  ViewVC Help
Powered by ViewVC