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

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

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

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