/[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 1430 by schoenebeck, Sun Oct 14 23:39:14 2007 UTC revision 2141 by schoenebeck, Tue Oct 5 10:36:00 2010 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: April 17, 2008                                 October 15, 2007  Expires: April 8, 2011                                   October 5, 2010
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.2                                  LSCP 1.5
12    
13    Abstract
14    
15       The LinuxSampler Control Protocol (LSCP) is an application-level
16       protocol primarily intended for local and remote controlling the
17       LinuxSampler backend application, which is a sophisticated server-
18       like console application essentially playing back audio samples and
19       manipulating the samples in real time to certain extent.
20    
21  Status of this Memo  Status of this Memo
22    
# Line 18  Status of this Memo Line 26  Status of this Memo
26     aware will be disclosed, in accordance with Section 6 of BCP 79.     aware will be disclosed, in accordance with Section 6 of BCP 79.
27    
28     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
29     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF).  Note that other groups may also distribute
30     other groups may also distribute working documents as Internet-     working documents as Internet-Drafts.  The list of current Internet-
31     Drafts.     Drafts is at http://datatracker.ietf.org/drafts/current/.
32    
33     Internet-Drafts are draft documents valid for a maximum of six months     Internet-Drafts are draft documents valid for a maximum of six months
34     and may be updated, replaced, or obsoleted by other documents at any     and may be updated, replaced, or obsoleted by other documents at any
35     time.  It is inappropriate to use Internet-Drafts as reference     time.  It is inappropriate to use Internet-Drafts as reference
36     material or to cite them other than as "work in progress."     material or to cite them other than as "work in progress."
37    
38     The list of current Internet-Drafts can be accessed at     This Internet-Draft will expire on April 8, 2011.
    http://www.ietf.org/ietf/1id-abstracts.txt.  
39    
    The list of Internet-Draft Shadow Directories can be accessed at  
    http://www.ietf.org/shadow.html.  
40    
    This Internet-Draft will expire on April 17, 2008.  
41    
 Copyright Notice  
42    
    Copyright (C) The IETF Trust (2007).  
43    
44    
45    
# Line 50  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55    Schoenebeck               Expires April 8, 2011                 [Page 1]
56    
57    Internet-Draft        LinuxSampler Control Protocol         October 2010
58    
59    
60    Table of Contents
61    
62       1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   7
63       2.  Versioning of this specification  . . . . . . . . . . . . . .   8
64       3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   9
65       4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .  10
66       5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  11
67         5.1.  Request/response communication method . . . . . . . . . .  11
68           5.1.1.   Result format  . . . . . . . . . . . . . . . . . . .  12
69         5.2.  Subscribe/notify communication method . . . . . . . . . .  14
70       6.  Description for control commands  . . . . . . . . . . . . . .  16
71         6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  16
72         6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  16
73           6.2.1.   Getting amount of available audio output drivers . .  17
74           6.2.2.   Getting all available audio output drivers . . . . .  17
75           6.2.3.   Getting information about a specific audio output
76                    driver . . . . . . . . . . . . . . . . . . . . . . .  17
77           6.2.4.   Getting information about specific audio output
78                    driver parameter . . . . . . . . . . . . . . . . . .  18
79           6.2.5.   Creating an audio output device  . . . . . . . . . .  22
80           6.2.6.   Destroying an audio output device  . . . . . . . . .  23
81           6.2.7.   Getting all created audio output device count  . . .  24
82           6.2.8.   Getting all created audio output device list . . . .  24
83           6.2.9.   Getting current settings of an audio output device .  24
84           6.2.10.  Changing settings of audio output devices  . . . . .  26
85           6.2.11.  Getting information about an audio channel . . . . .  27
86           6.2.12.  Getting information about specific audio channel
87                    parameter  . . . . . . . . . . . . . . . . . . . . .  28
88           6.2.13.  Changing settings of audio output channels . . . . .  30
89         6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  31
90           6.3.1.   Getting amount of available MIDI input drivers . . .  32
91           6.3.2.   Getting all available MIDI input drivers . . . . . .  32
92           6.3.3.   Getting information about a specific MIDI input
93                    driver . . . . . . . . . . . . . . . . . . . . . . .  33
94           6.3.4.   Getting information about specific MIDI input
95                    driver parameter . . . . . . . . . . . . . . . . . .  34
96           6.3.5.   Creating a MIDI input device . . . . . . . . . . . .  36
97           6.3.6.   Destroying a MIDI input device . . . . . . . . . . .  37
98           6.3.7.   Getting all created MIDI input device count  . . . .  38
99           6.3.8.   Getting all created MIDI input device list . . . . .  38
100           6.3.9.   Getting current settings of a MIDI input device  . .  39
101           6.3.10.  Changing settings of MIDI input devices  . . . . . .  40
102           6.3.11.  Getting information about a MIDI port  . . . . . . .  40
103           6.3.12.  Getting information about specific MIDI port
104                    parameter  . . . . . . . . . . . . . . . . . . . . .  41
105           6.3.13.  Changing settings of MIDI input ports  . . . . . . .  43
106         6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  44
107           6.4.1.   Loading an instrument  . . . . . . . . . . . . . . .  44
108    
109    
110    
111    Schoenebeck               Expires April 8, 2011                 [Page 2]
112    
113    Internet-Draft        LinuxSampler Control Protocol         October 2010
114    
115    
116           6.4.2.   Loading a sampler engine . . . . . . . . . . . . . .  45
117           6.4.3.   Getting all created sampler channel count  . . . . .  46
118           6.4.4.   Getting all created sampler channel list . . . . . .  47
119           6.4.5.   Adding a new sampler channel . . . . . . . . . . . .  47
120           6.4.6.   Removing a sampler channel . . . . . . . . . . . . .  48
121           6.4.7.   Getting amount of available engines  . . . . . . . .  49
122           6.4.8.   Getting all available engines  . . . . . . . . . . .  49
123           6.4.9.   Getting information about an engine  . . . . . . . .  49
124           6.4.10.  Getting sampler channel information  . . . . . . . .  50
125           6.4.11.  Current number of active voices  . . . . . . . . . .  53
126           6.4.12.  Current number of active disk streams  . . . . . . .  54
127           6.4.13.  Current fill state of disk stream buffers  . . . . .  54
128           6.4.14.  Setting audio output device  . . . . . . . . . . . .  55
129           6.4.15.  Setting audio output type  . . . . . . . . . . . . .  56
130           6.4.16.  Setting audio output channel . . . . . . . . . . . .  57
131           6.4.17.  Setting MIDI input device  . . . . . . . . . . . . .  58
132           6.4.18.  Setting MIDI input type  . . . . . . . . . . . . . .  58
133           6.4.19.  Setting MIDI input port  . . . . . . . . . . . . . .  59
134           6.4.20.  Setting MIDI input channel . . . . . . . . . . . . .  60
135           6.4.21.  Setting channel volume . . . . . . . . . . . . . . .  60
136           6.4.22.  Muting a sampler channel . . . . . . . . . . . . . .  61
137           6.4.23.  Soloing a sampler channel  . . . . . . . . . . . . .  62
138           6.4.24.  Assigning a MIDI instrument map to a sampler
139                    channel  . . . . . . . . . . . . . . . . . . . . . .  62
140           6.4.25.  Adding an effect send to a sampler channel . . . . .  63
141           6.4.26.  Removing an effect send from a sampler channel . . .  65
142           6.4.27.  Getting amount of effect sends on a sampler
143                    channel  . . . . . . . . . . . . . . . . . . . . . .  65
144           6.4.28.  Listing all effect sends on a sampler channel  . . .  66
145           6.4.29.  Getting effect send information  . . . . . . . . . .  66
146           6.4.30.  Changing effect send's name  . . . . . . . . . . . .  68
147           6.4.31.  Altering effect send's audio routing . . . . . . . .  69
148           6.4.32.  Assigning destination effect to an effect send . . .  70
149           6.4.33.  Removing destination effect from an effect send  . .  71
150           6.4.34.  Altering effect send's MIDI controller . . . . . . .  72
151           6.4.35.  Altering effect send's send level  . . . . . . . . .  72
152           6.4.36.  Sending MIDI messages to sampler channel . . . . . .  73
153           6.4.37.  Resetting a sampler channel  . . . . . . . . . . . .  74
154         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  75
155           6.5.1.   Register front-end for receiving event messages  . .  75
156           6.5.2.   Unregister front-end for not receiving event
157                    messages . . . . . . . . . . . . . . . . . . . . . .  76
158           6.5.3.   Enable or disable echo of commands . . . . . . . . .  76
159           6.5.4.   Close client connection  . . . . . . . . . . . . . .  77
160         6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  77
161           6.6.1.   Current number of active voices  . . . . . . . . . .  77
162           6.6.2.   Maximum amount of active voices  . . . . . . . . . .  78
163           6.6.3.   Current number of active disk streams  . . . . . . .  78
164    
165    
166    
167    Schoenebeck               Expires April 8, 2011                 [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol         October 2010
170    
171    
172           6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  78
173           6.6.5.   General sampler informations . . . . . . . . . . . .  78
174           6.6.6.   Getting global volume attenuation  . . . . . . . . .  79
175           6.6.7.   Setting global volume attenuation  . . . . . . . . .  80
176           6.6.8.   Getting global voice limit . . . . . . . . . . . . .  80
177           6.6.9.   Setting global voice limit . . . . . . . . . . . . .  81
178           6.6.10.  Getting global disk stream limit . . . . . . . . . .  81
179           6.6.11.  Setting global disk stream limit . . . . . . . . . .  82
180         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  83
181           6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  83
182           6.7.2.   Delete one particular or all MIDI instrument maps  .  84
183           6.7.3.   Get amount of existing MIDI instrument maps  . . . .  85
184           6.7.4.   Getting all created MIDI instrument maps . . . . . .  85
185           6.7.5.   Getting MIDI instrument map information  . . . . . .  86
186           6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  87
187           6.7.7.   Create or replace a MIDI instrument map entry  . . .  87
188           6.7.8.   Getting ammount of MIDI instrument map entries . . .  90
189           6.7.9.   Getting indeces of all entries of a MIDI
190                    instrument map . . . . . . . . . . . . . . . . . . .  91
191           6.7.10.  Remove an entry from the MIDI instrument map . . . .  91
192           6.7.11.  Get current settings of MIDI instrument map entry  .  92
193           6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  94
194         6.8.  Managing Instruments Database . . . . . . . . . . . . . .  94
195           6.8.1.   Creating a new instrument directory  . . . . . . . .  95
196           6.8.2.   Deleting an instrument directory . . . . . . . . . .  95
197           6.8.3.   Getting amount of instrument directories . . . . . .  96
198           6.8.4.   Listing all directories in specific directory  . . .  96
199           6.8.5.   Getting instrument directory information . . . . . .  97
200           6.8.6.   Renaming an instrument directory . . . . . . . . . .  98
201           6.8.7.   Moving an instrument directory . . . . . . . . . . .  99
202           6.8.8.   Copying instrument directories . . . . . . . . . . .  99
203           6.8.9.   Changing the description of directory  . . . . . . . 100
204           6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 101
205           6.8.11.  Adding instruments to the instruments database . . . 102
206           6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 104
207           6.8.13.  Getting amount of instruments  . . . . . . . . . . . 104
208           6.8.14.  Listing all instruments in specific directory  . . . 105
209           6.8.15.  Getting instrument information . . . . . . . . . . . 105
210           6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 108
211           6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 108
212           6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 109
213           6.8.19.  Changing the description of instrument . . . . . . . 110
214           6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 110
215           6.8.21.  Getting job status information . . . . . . . . . . . 113
216           6.8.22.  Formatting the instruments database  . . . . . . . . 114
217           6.8.23.  Checking for lost instrument files . . . . . . . . . 114
218           6.8.24.  Replacing an instrument file . . . . . . . . . . . . 115
219         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 115
220    
221    
222    
223    Schoenebeck               Expires April 8, 2011                 [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol         October 2010
226    
227    
228           6.9.1.   Opening an appropriate instrument editor
229                    application  . . . . . . . . . . . . . . . . . . . . 116
230         6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 117
231           6.10.1.  Retrieving amount of instruments of a file . . . . . 117
232           6.10.2.  Retrieving all instruments of a file . . . . . . . . 117
233           6.10.3.  Retrieving informations about one instrument in a
234                    file . . . . . . . . . . . . . . . . . . . . . . . . 118
235         6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 120
236           6.11.1.  Retrieve amount of available effects . . . . . . . . 120
237           6.11.2.  Get list of available effects  . . . . . . . . . . . 121
238           6.11.3.  Retrieving general information about an effect . . . 121
239           6.11.4.  Creating an instance of an effect by its portable
240                    ID . . . . . . . . . . . . . . . . . . . . . . . . . 122
241           6.11.5.  Creating an instance of an effect by its
242                    numerical ID . . . . . . . . . . . . . . . . . . . . 123
243           6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 124
244           6.11.7.  Retrieve amount of effect instances  . . . . . . . . 125
245           6.11.8.  Get list of effect instances . . . . . . . . . . . . 126
246           6.11.9.  Retrieving current information about an effect
247                    instance . . . . . . . . . . . . . . . . . . . . . . 126
248           6.11.10. Retrieving information about an effect parameter . . 127
249           6.11.11. Altering an effect parameter . . . . . . . . . . . . 129
250           6.11.12. Retrieve amount of send effect chains  . . . . . . . 130
251           6.11.13. Retrieve list of send effect chains  . . . . . . . . 130
252           6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 131
253           6.11.15. Remove send effect chain . . . . . . . . . . . . . . 131
254           6.11.16. Retrieving information about a send effect chain . . 132
255           6.11.17. Append effect instance to a send effect chain  . . . 133
256           6.11.18. Insert effect instance to a send effect chain  . . . 134
257           6.11.19. Remove effect instance from send effect chain  . . . 135
258       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 136
259         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 152
260       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
261         8.1.  Number of audio output devices changed  . . . . . . . . . 157
262         8.2.  Audio output device's settings changed  . . . . . . . . . 157
263         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 157
264         8.4.  MIDI input device's settings changed  . . . . . . . . . . 158
265         8.5.  Number of sampler channels changed  . . . . . . . . . . . 158
266         8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 158
267         8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 159
268         8.8.  Number of active voices changed . . . . . . . . . . . . . 159
269         8.9.  Number of active disk streams changed . . . . . . . . . . 160
270         8.10. Disk stream buffer fill state changed . . . . . . . . . . 160
271         8.11. Channel information changed . . . . . . . . . . . . . . . 160
272         8.12. Number of effect sends changed  . . . . . . . . . . . . . 161
273         8.13. Effect send information changed . . . . . . . . . . . . . 161
274         8.14. Total number of active voices changed . . . . . . . . . . 162
275         8.15. Total number of active disk streams changed . . . . . . . 162
276    
277    
278    
279    Schoenebeck               Expires April 8, 2011                 [Page 5]
280    
281    Internet-Draft        LinuxSampler Control Protocol         October 2010
282    
283    
284         8.16. Number of MIDI instrument maps changed  . . . . . . . . . 162
285         8.17. MIDI instrument map information changed . . . . . . . . . 162
286         8.18. Number of MIDI instruments changed  . . . . . . . . . . . 163
287         8.19. MIDI instrument information changed . . . . . . . . . . . 163
288         8.20. Global settings changed . . . . . . . . . . . . . . . . . 164
289         8.21. Number of database instrument directories changed . . . . 164
290         8.22. Database instrument directory information changed . . . . 164
291         8.23. Number of database instruments changed  . . . . . . . . . 165
292         8.24. Database instrument information changed . . . . . . . . . 165
293         8.25. Database job status information changed . . . . . . . . . 166
294         8.26. Miscellaneous and debugging events  . . . . . . . . . . . 166
295       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 168
296       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 169
297       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 170
298       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 171
299       Intellectual Property and Copyright Statements  . . . . . . . . . 172
300    
301    
302    
303    
304    
 Schoenebeck              Expires April 17, 2008                 [Page 1]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
305    
306    
 Abstract  
307    
    The LinuxSampler Control Protocol (LSCP) is an application-level  
    protocol primarily intended for local and remote controlling the  
    LinuxSampler backend application, which is a sophisticated server-  
    like console application essentially playing back audio samples and  
    manipulating the samples in real time to certain extent.  
308    
309    
 Table of Contents  
310    
    1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6  
    2.  Versioning of this specification  . . . . . . . . . . . . . .   7  
    3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8  
    4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9  
    5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10  
      5.1.  Request/response communication method . . . . . . . . . .  10  
        5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11  
      5.2.  Subscribe/notify communication method . . . . . . . . . .  13  
    6.  Description for control commands  . . . . . . . . . . . . . .  15  
      6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15  
      6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15  
        6.2.1.  Getting amount of available audio output drivers  . .  16  
        6.2.2.  Getting all available audio output drivers  . . . . .  16  
        6.2.3.  Getting information about a specific audio output  
                driver  . . . . . . . . . . . . . . . . . . . . . . .  16  
        6.2.4.  Getting information about specific audio output  
                driver parameter  . . . . . . . . . . . . . . . . . .  17  
        6.2.5.  Creating an audio output device . . . . . . . . . . .  21  
        6.2.6.  Destroying an audio output device . . . . . . . . . .  22  
        6.2.7.  Getting all created audio output device count . . . .  23  
        6.2.8.  Getting all created audio output device list  . . . .  23  
        6.2.9.  Getting current settings of an audio output device  .  23  
        6.2.10. Changing settings of audio output devices . . . . . .  25  
        6.2.11. Getting information about an audio channel  . . . . .  26  
        6.2.12. Getting information about specific audio channel  
                parameter . . . . . . . . . . . . . . . . . . . . . .  27  
        6.2.13. Changing settings of audio output channels  . . . . .  29  
      6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30  
        6.3.1.  Getting amount of available MIDI input drivers  . . .  31  
        6.3.2.  Getting all available MIDI input drivers  . . . . . .  31  
        6.3.3.  Getting information about a specific MIDI input  
                driver  . . . . . . . . . . . . . . . . . . . . . . .  32  
        6.3.4.  Getting information about specific MIDI input  
                driver parameter  . . . . . . . . . . . . . . . . . .  33  
        6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35  
        6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36  
        6.3.7.  Getting all created MIDI input device count . . . . .  37  
   
   
   
 Schoenebeck              Expires April 17, 2008                 [Page 2]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
        6.3.8.  Getting all created MIDI input device list  . . . . .  37  
        6.3.9.  Getting current settings of a MIDI input device . . .  38  
        6.3.10. Changing settings of MIDI input devices . . . . . . .  39  
        6.3.11. Getting information about a MIDI port . . . . . . . .  39  
        6.3.12. Getting information about specific MIDI port  
                parameter . . . . . . . . . . . . . . . . . . . . . .  40  
        6.3.13. Changing settings of MIDI input ports . . . . . . . .  42  
      6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43  
        6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43  
        6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44  
        6.4.3.  Getting all created sampler channel count . . . . . .  45  
        6.4.4.  Getting all created sampler channel list  . . . . . .  45  
        6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46  
        6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47  
        6.4.7.  Getting amount of available engines . . . . . . . . .  47  
        6.4.8.  Getting all available engines . . . . . . . . . . . .  48  
        6.4.9.  Getting information about an engine . . . . . . . . .  48  
        6.4.10. Getting sampler channel information . . . . . . . . .  49  
        6.4.11. Current number of active voices . . . . . . . . . . .  52  
        6.4.12. Current number of active disk streams . . . . . . . .  53  
        6.4.13. Current fill state of disk stream buffers . . . . . .  53  
        6.4.14. Setting audio output device . . . . . . . . . . . . .  54  
        6.4.15. Setting audio output type . . . . . . . . . . . . . .  55  
        6.4.16. Setting audio output channel  . . . . . . . . . . . .  55  
        6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56  
        6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57  
        6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58  
        6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58  
        6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59  
        6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60  
        6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60  
        6.4.24. Assigning a MIDI instrument map to a sampler  
                channel . . . . . . . . . . . . . . . . . . . . . . .  61  
        6.4.25. Adding an effect send to a sampler channel  . . . . .  62  
        6.4.26. Removing an effect send from a sampler channel  . . .  63  
        6.4.27. Getting amount of effect sends on a sampler channel .  64  
        6.4.28. Listing all effect sends on a sampler channel . . . .  64  
        6.4.29. Getting effect send information . . . . . . . . . . .  65  
        6.4.30. Changing effect send's name . . . . . . . . . . . . .  66  
        6.4.31. Altering effect send's audio routing  . . . . . . . .  67  
        6.4.32. Altering effect send's MIDI controller  . . . . . . .  68  
        6.4.33. Altering effect send's send level . . . . . . . . . .  69  
        6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70  
      6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70  
        6.5.1.  Register front-end for receiving event messages . . .  70  
        6.5.2.  Unregister front-end for not receiving event  
                messages  . . . . . . . . . . . . . . . . . . . . . .  71  
        6.5.3.  Enable or disable echo of commands  . . . . . . . . .  72  
   
   
   
 Schoenebeck              Expires April 17, 2008                 [Page 3]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
        6.5.4.  Close client connection . . . . . . . . . . . . . . .  72  
      6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  73  
        6.6.1.  Current number of active voices . . . . . . . . . . .  73  
        6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73  
        6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73  
        6.6.4.  General sampler informations  . . . . . . . . . . . .  74  
        6.6.5.  Getting global volume attenuation . . . . . . . . . .  74  
        6.6.6.  Setting global volume attenuation . . . . . . . . . .  75  
      6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75  
        6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76  
        6.7.2.  Delete one particular or all MIDI instrument maps . .  77  
        6.7.3.  Get amount of existing MIDI instrument maps . . . . .  78  
        6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78  
        6.7.5.  Getting MIDI instrument map information . . . . . . .  78  
        6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79  
        6.7.7.  Create or replace a MIDI instrument map entry . . . .  80  
        6.7.8.  Getting ammount of MIDI instrument map entries  . . .  83  
        6.7.9.  Getting indeces of all entries of a MIDI  
                instrument map  . . . . . . . . . . . . . . . . . . .  83  
        6.7.10. Remove an entry from the MIDI instrument map  . . . .  84  
        6.7.11. Get current settings of MIDI instrument map entry . .  85  
        6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86  
      6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87  
        6.8.1.  Creating a new instrument directory . . . . . . . . .  87  
        6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88  
        6.8.3.  Getting amount of instrument directories  . . . . . .  89  
        6.8.4.  Listing all directories in specific directory . . . .  89  
        6.8.5.  Getting instrument directory information  . . . . . .  90  
        6.8.6.  Renaming an instrument directory  . . . . . . . . . .  91  
        6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91  
        6.8.8.  Copying instrument directories  . . . . . . . . . . .  92  
        6.8.9.  Changing the description of directory . . . . . . . .  93  
        6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93  
        6.8.11. Adding instruments to the instruments database  . . .  95  
        6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96  
        6.8.13. Getting amount of instruments . . . . . . . . . . . .  97  
        6.8.14. Listing all instruments in specific directory . . . .  97  
        6.8.15. Getting instrument information  . . . . . . . . . . .  98  
        6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100  
        6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 101  
        6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102  
        6.8.19. Changing the description of instrument  . . . . . . . 102  
        6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103  
        6.8.21. Getting job status information  . . . . . . . . . . . 105  
        6.8.22. Formatting the instruments database . . . . . . . . . 106  
      6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 107  
        6.9.1.  Opening an appropriate instrument editor  
                application . . . . . . . . . . . . . . . . . . . . . 107  
   
   
   
 Schoenebeck              Expires April 17, 2008                 [Page 4]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
    7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 109  
      7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 122  
    8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 126  
      8.1.  Number of audio output devices changed  . . . . . . . . . 126  
      8.2.  Audio output device's settings changed  . . . . . . . . . 126  
      8.3.  Number of MIDI input devices changed  . . . . . . . . . . 126  
      8.4.  MIDI input device's settings changed  . . . . . . . . . . 127  
      8.5.  Number of sampler channels changed  . . . . . . . . . . . 127  
      8.6.  Number of active voices changed . . . . . . . . . . . . . 127  
      8.7.  Number of active disk streams changed . . . . . . . . . . 128  
      8.8.  Disk stream buffer fill state changed . . . . . . . . . . 128  
      8.9.  Channel information changed . . . . . . . . . . . . . . . 128  
      8.10. Number of effect sends changed  . . . . . . . . . . . . . 129  
      8.11. Effect send information changed . . . . . . . . . . . . . 129  
      8.12. Total number of active voices changed . . . . . . . . . . 129  
      8.13. Number of MIDI instrument maps changed  . . . . . . . . . 130  
      8.14. MIDI instrument map information changed . . . . . . . . . 130  
      8.15. Number of MIDI instruments changed  . . . . . . . . . . . 130  
      8.16. MIDI instrument information changed . . . . . . . . . . . 131  
      8.17. Global settings changed . . . . . . . . . . . . . . . . . 131  
      8.18. Number of database instrument directories changed . . . . 132  
      8.19. Database instrument directory information changed . . . . 132  
      8.20. Number of database instruments changed  . . . . . . . . . 133  
      8.21. Database instrument information changed . . . . . . . . . 133  
      8.22. Database job status information changed . . . . . . . . . 134  
      8.23. Miscellaneous and debugging events  . . . . . . . . . . . 134  
    9.  Security Considerations . . . . . . . . . . . . . . . . . . . 135  
    10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 136  
    11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 137  
    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 138  
    Intellectual Property and Copyright Statements  . . . . . . . . . 139  
311    
312    
313    
# Line 276  Internet-Draft        LinuxSampler Contr Line 328  Internet-Draft        LinuxSampler Contr
328    
329    
330    
331  Schoenebeck              Expires April 17, 2008                 [Page 5]  
332    
333    
334    
335    Schoenebeck               Expires April 8, 2011                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
338    
339    
340  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck              Expires April 17, 2008                 [Page 6]  Schoenebeck               Expires April 8, 2011                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
394    
395    
396  2.  Versioning of this specification  2.  Versioning of this specification
# Line 363  Internet-Draft        LinuxSampler Contr Line 419  Internet-Draft        LinuxSampler Contr
419         sampler's LSCP minor version.         sampler's LSCP minor version.
420    
421     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
422     frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get     frontend can use the "GET SERVER INFO" (Section 6.6.5) command to get
423     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
424    
425    
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck              Expires April 17, 2008                 [Page 7]  Schoenebeck               Expires April 8, 2011                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
450    
451    
452  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck              Expires April 17, 2008                 [Page 8]  Schoenebeck               Expires April 8, 2011                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
506    
507    
508  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck              Expires April 17, 2008                 [Page 9]  Schoenebeck               Expires April 8, 2011                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
562    
563    
564  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck              Expires April 17, 2008                [Page 10]  Schoenebeck               Expires April 8, 2011                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
618    
619    
620  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck              Expires April 17, 2008                [Page 11]  Schoenebeck               Expires April 8, 2011                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
674    
675    
676     set has the following format:     set has the following format:
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck              Expires April 17, 2008                [Page 12]  Schoenebeck               Expires April 8, 2011                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
730    
731    
732     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck              Expires April 17, 2008                [Page 13]  Schoenebeck               Expires April 8, 2011                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
786    
787    
788         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 780  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck              Expires April 17, 2008                [Page 14]  Schoenebeck               Expires April 8, 2011                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
842    
843    
844  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck              Expires April 17, 2008                [Page 15]  Schoenebeck               Expires April 8, 2011                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
898    
899    
900  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck              Expires April 17, 2008                [Page 16]  Schoenebeck               Expires April 8, 2011                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
954    
955    
956        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck              Expires April 17, 2008                [Page 17]  Schoenebeck               Expires April 8, 2011                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1010    
1011    
1012     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck              Expires April 17, 2008                [Page 18]  Schoenebeck               Expires April 8, 2011                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1066    
1067    
1068        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck              Expires April 17, 2008                [Page 19]  Schoenebeck               Expires April 8, 2011                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1122    
1123    
1124           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck              Expires April 17, 2008                [Page 20]  Schoenebeck               Expires April 8, 2011                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1178    
1179    
1180           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck              Expires April 17, 2008                [Page 21]  Schoenebeck               Expires April 8, 2011                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1234    
1235    
1236           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck              Expires April 17, 2008                [Page 22]  Schoenebeck               Expires April 8, 2011                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1290    
1291    
1292        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck              Expires April 17, 2008                [Page 23]  Schoenebeck               Expires April 8, 2011                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1346    
1347    
1348     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck              Expires April 17, 2008                [Page 24]  Schoenebeck               Expires April 8, 2011                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1402    
1403    
1404           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck              Expires April 17, 2008                [Page 25]  Schoenebeck               Expires April 8, 2011                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1458    
1459    
1460  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck              Expires April 17, 2008                [Page 26]  Schoenebeck               Expires April 8, 2011                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1514    
1515    
1516     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck              Expires April 17, 2008                [Page 27]  Schoenebeck               Expires April 8, 2011                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1570    
1571    
1572     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck              Expires April 17, 2008                [Page 28]  Schoenebeck               Expires April 8, 2011                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1626    
1627    
1628           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck              Expires April 17, 2008                [Page 29]  Schoenebeck               Expires April 8, 2011                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1682    
1683    
1684        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck              Expires April 17, 2008                [Page 30]  Schoenebeck               Expires April 8, 2011                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1738    
1739    
1740     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck              Expires April 17, 2008                [Page 31]  Schoenebeck               Expires April 8, 2011                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1794    
1795    
1796  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck              Expires April 17, 2008                [Page 32]  Schoenebeck               Expires April 8, 2011                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1850    
1851    
1852  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck              Expires April 17, 2008                [Page 33]  Schoenebeck               Expires April 8, 2011                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1906    
1907    
1908        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck              Expires April 17, 2008                [Page 34]  Schoenebeck               Expires April 8, 2011                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
1962    
1963    
1964           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck              Expires April 17, 2008                [Page 35]  Schoenebeck               Expires April 8, 2011                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2018    
2019    
2020        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck              Expires April 17, 2008                [Page 36]  Schoenebeck               Expires April 8, 2011                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2074    
2075    
2076           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck              Expires April 17, 2008                [Page 37]  Schoenebeck               Expires April 8, 2011                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2130    
2131    
2132  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck              Expires April 17, 2008                [Page 38]  Schoenebeck               Expires April 8, 2011                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2186    
2187    
2188           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck              Expires April 17, 2008                [Page 39]  Schoenebeck               Expires April 8, 2011                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2242    
2243    
2244     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 2236  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck              Expires April 17, 2008                [Page 40]  Schoenebeck               Expires April 8, 2011                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2298    
2299    
2300        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck              Expires April 17, 2008                [Page 41]  Schoenebeck               Expires April 8, 2011                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2354    
2355    
2356           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck              Expires April 17, 2008                [Page 42]  Schoenebeck               Expires April 8, 2011                [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2410    
2411    
2412        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck              Expires April 17, 2008                [Page 43]  Schoenebeck               Expires April 8, 2011                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
2466    
2467    
2468     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 2431  Internet-Draft        LinuxSampler Contr Line 2487  Internet-Draft        LinuxSampler Contr
2487           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2488           error message           error message
2489    
2490     Example:     Example (Unix):
2491    
2492          C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
2493    
2494          S: OK
2495    
2496       Example (Windows):
2497    
2498          C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
2499    
2500          S: OK
2501    
2502  6.4.2.  Loading a sampler engine  6.4.2.  Loading a sampler engine
2503    
# Line 2449  Internet-Draft        LinuxSampler Contr Line 2513  Internet-Draft        LinuxSampler Contr
2513     be assigned to.  This command should be issued after adding a new     be assigned to.  This command should be issued after adding a new
2514     sampler channel and before any other control commands on the new     sampler channel and before any other control commands on the new
2515     sampler channel.  It can also be used to change the engine type of a     sampler channel.  It can also be used to change the engine type of a
    sampler channel.  This command has (currently) no way to define or  
    force if a new engine instance should be created and assigned to the  
    given sampler channel or if an already existing instance of that  
    engine type, shared with other sampler channels, should be used.  
   
    Possible Answers:  
2516    
2517    
2518    
2519    Schoenebeck               Expires April 8, 2011                [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol         October 2010
2522    
2523    
2524  Schoenebeck              Expires April 17, 2008                [Page 44]     sampler channel.  This command has (currently) no way to define or
2525       force if a new engine instance should be created and assigned to the
2526  Internet-Draft        LinuxSampler Control Protocol         October 2007     given sampler channel or if an already existing instance of that
2527       engine type, shared with other sampler channels, should be used.
2528    
2529       Possible Answers:
2530    
2531        "OK" -        "OK" -
2532    
# Line 2503  Internet-Draft        LinuxSampler Contr Line 2566  Internet-Draft        LinuxSampler Contr
2566    
2567        S: "12"        S: "12"
2568    
2569    
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck               Expires April 8, 2011                [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol         October 2010
2578    
2579    
2580  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2581    
2582     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
# Line 2513  Internet-Draft        LinuxSampler Contr Line 2587  Internet-Draft        LinuxSampler Contr
2587    
2588     Possible Answers:     Possible Answers:
2589    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2590        LinuxSampler will answer by returning a comma separated list with        LinuxSampler will answer by returning a comma separated list with
2591        all sampler channels numerical IDs.        all sampler channels numerical IDs.
2592    
# Line 2558  Internet-Draft        LinuxSampler Contr Line 2624  Internet-Draft        LinuxSampler Contr
2624    
2625        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck               Expires April 8, 2011                [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol         October 2010
2634    
2635    
2636           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2637           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2638           code and warning message           code and warning message
# Line 2571  Internet-Draft        LinuxSampler Contr Line 2646  Internet-Draft        LinuxSampler Contr
2646    
2647    
2648    
   
 Schoenebeck              Expires April 17, 2008                [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
   
   
2649  6.4.6.  Removing a sampler channel  6.4.6.  Removing a sampler channel
2650    
2651     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
# Line 2611  Internet-Draft        LinuxSampler Contr Line 2678  Internet-Draft        LinuxSampler Contr
2678    
2679    
2680    
2681    
2682    
2683    
2684    
2685    
2686    
2687    Schoenebeck               Expires April 8, 2011                [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol         October 2010
2690    
2691    
2692  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
2693    
2694     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
# Line 2625  Internet-Draft        LinuxSampler Contr Line 2703  Internet-Draft        LinuxSampler Contr
2703    
2704     Example:     Example:
2705    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2706        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2707    
2708        S: "4"        S: "4"
# Line 2667  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
2737     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2738     AVAILABLE_ENGINES" (Section 6.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2739    
2740    
2741    
2742    
2743    Schoenebeck               Expires April 8, 2011                [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol         October 2010
2746    
2747    
2748     Possible Answers:     Possible Answers:
2749    
2750        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 2682  Internet-Draft        LinuxSampler Contr Line 2760  Internet-Draft        LinuxSampler Contr
2760              arbitrary description text about the engine (note that the              arbitrary description text about the engine (note that the
2761              character string may contain escape sequences (Section 7.1))              character string may contain escape sequences (Section 7.1))
2762    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2763           VERSION -           VERSION -
2764    
2765              arbitrary character string regarding the engine's version              arbitrary character string regarding the engine's version
# Line 2722  Internet-Draft        LinuxSampler Contr Line 2793  Internet-Draft        LinuxSampler Contr
2793        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
2794        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
2795        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2796    
2797    
2798    
2799    Schoenebeck               Expires April 8, 2011                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol         October 2010
2802    
2803    
2804        following categories are defined:        following categories are defined:
2805    
2806    
# Line 2736  Internet-Draft        LinuxSampler Contr Line 2815  Internet-Draft        LinuxSampler Contr
2815    
2816              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2817              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2818              signal, "NONE" if there's no device connected to this              signal, "-1" if there's no device connected to this sampler
2819                channel
   
   
 Schoenebeck              Expires April 17, 2008                [Page 49]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
             sampler channel  
2820    
2821           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2822    
# Line 2770  Internet-Draft        LinuxSampler Contr Line 2841  Internet-Draft        LinuxSampler Contr
2841    
2842           INSTRUMENT_NR -           INSTRUMENT_NR -
2843    
2844              the instrument index number of the loaded instrument              the instrument index number of the loaded instrument, "-1"
2845                if there's no instrument loaded for this sampler channel
2846    
2847           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2848    
# Line 2778  Internet-Draft        LinuxSampler Contr Line 2850  Internet-Draft        LinuxSampler Contr
2850              LSCP 1.2 this character string may contain escape sequences              LSCP 1.2 this character string may contain escape sequences
2851              (Section 7.1))              (Section 7.1))
2852    
2853    
2854    
2855    Schoenebeck               Expires April 8, 2011                [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol         October 2010
2858    
2859    
2860           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2861    
2862              integer values 0 to 100 indicating loading progress              Integer values 0 to 100 indicating loading progress
2863              percentage for the instrument.  Negative value indicates a              percentage for the instrument.  Negative value indicates a
2864              loading exception.  Value of 100 indicates that the              loading exception (also returns "-1" in case no instrument
2865              instrument is fully loaded.              was yet to be loaded on the sampler channel).  Value of 100
2866                indicates that the instrument is fully loaded.
2867    
2868           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2869    
2870              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
2871              connected to this sampler channel to deliver MIDI input              connected to this sampler channel to deliver MIDI input
2872              commands, "NONE" if there's no device connected to this              commands, "-1" if there's no device connected to this
2873              sampler channel              sampler channel
2874    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2875           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2876    
2877              port number of the MIDI input device              port number of the MIDI input device (in case a MIDI device
2878                was already assigned to the sampler channel)
2879    
2880           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2881    
# Line 2833  Internet-Draft        LinuxSampler Contr Line 2905  Internet-Draft        LinuxSampler Contr
2905    
2906              Determines to which MIDI instrument map this sampler channel              Determines to which MIDI instrument map this sampler channel
2907              is assigned to.  Read chapter "SET CHANNEL              is assigned to.  Read chapter "SET CHANNEL
2908    
2909    
2910    
2911    Schoenebeck               Expires April 8, 2011                [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol         October 2010
2914    
2915    
2916              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2917              values.              values.
2918    
# Line 2848  Internet-Draft        LinuxSampler Contr Line 2928  Internet-Draft        LinuxSampler Contr
2928    
2929           "AUDIO_OUTPUT_DEVICE: 0"           "AUDIO_OUTPUT_DEVICE: 0"
2930    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
2931           "AUDIO_OUTPUT_CHANNELS: 2"           "AUDIO_OUTPUT_CHANNELS: 2"
2932    
2933           "AUDIO_OUTPUT_ROUTING: 0,1"           "AUDIO_OUTPUT_ROUTING: 0,1"
# Line 2890  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961     The front-end can ask for the current number of active voices on a     The front-end can ask for the current number of active voices on a
2962     sampler channel by sending the following command:     sampler channel by sending the following command:
2963    
2964    
2965    
2966    
2967    Schoenebeck               Expires April 8, 2011                [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol         October 2010
2970    
2971    
2972        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2973    
2974     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
# Line 2905  Internet-Draft        LinuxSampler Contr Line 2984  Internet-Draft        LinuxSampler Contr
2984    
2985    
2986    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
   
   
2987  6.4.12.  Current number of active disk streams  6.4.12.  Current number of active disk streams
2988    
2989     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
# Line 2946  Internet-Draft        LinuxSampler Contr Line 3015  Internet-Draft        LinuxSampler Contr
3015    
3016     to get the fill state in bytes or     to get the fill state in bytes or
3017    
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck               Expires April 8, 2011                [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol         October 2010
3026    
3027    
3028        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
3029    
3030     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
# Line 2961  Internet-Draft        LinuxSampler Contr Line 3040  Internet-Draft        LinuxSampler Contr
3040        "NA" for *not available* in case the engine which is deployed        "NA" for *not available* in case the engine which is deployed
3041        doesn't support disk streaming.  Each entry in the answer list        doesn't support disk streaming.  Each entry in the answer list
3042        will begin with the stream's ID in brackets followed by the        will begin with the stream's ID in brackets followed by the
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3043        numerical representation of the fill size (either in bytes or        numerical representation of the fill size (either in bytes or
3044        percentage).  Note: due to efficiency reasons the fill states in        percentage).  Note: due to efficiency reasons the fill states in
3045        the response are not in particular order, thus the front-end has        the response are not in particular order, thus the front-end has
# Line 3003  Internet-Draft        LinuxSampler Contr Line 3074  Internet-Draft        LinuxSampler Contr
3074     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
3075     command.     command.
3076    
3077    
3078    
3079    Schoenebeck               Expires April 8, 2011                [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol         October 2010
3082    
3083    
3084     Possible Answers:     Possible Answers:
3085    
3086        "OK" -        "OK" -
# Line 3015  Internet-Draft        LinuxSampler Contr Line 3093  Internet-Draft        LinuxSampler Contr
3093           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3094           warning message           warning message
3095    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3096        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3097    
3098           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3059  Internet-Draft        LinuxSampler Contr Line 3127  Internet-Draft        LinuxSampler Contr
3127           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3128           message           message
3129    
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck               Expires April 8, 2011                [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol         October 2010
3138    
3139    
3140        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3141    
3142           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3073  Internet-Draft        LinuxSampler Contr Line 3151  Internet-Draft        LinuxSampler Contr
3151     The front-end can alter the audio output channel on a specific     The front-end can alter the audio output channel on a specific
3152     sampler channel by sending the following command:     sampler channel by sending the following command:
3153    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3154        SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>        SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>
3155        <audio-in>        <audio-in>
3156    
# Line 3112  Internet-Draft        LinuxSampler Contr Line 3182  Internet-Draft        LinuxSampler Contr
3182    
3183    
3184    
3185    
3186    
3187    
3188    
3189    
3190    
3191    Schoenebeck               Expires April 8, 2011                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol         October 2010
3194    
3195    
3196  6.4.17.  Setting MIDI input device  6.4.17.  Setting MIDI input device
3197    
3198     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
# Line 3127  Internet-Draft        LinuxSampler Contr Line 3208  Internet-Draft        LinuxSampler Contr
3208    
3209     Possible Answers:     Possible Answers:
3210    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3211        "OK" -        "OK" -
3212    
3213           on success           on success
# Line 3170  Internet-Draft        LinuxSampler Contr Line 3241  Internet-Draft        LinuxSampler Contr
3241    
3242     Possible Answers:     Possible Answers:
3243    
3244    
3245    
3246    
3247    Schoenebeck               Expires April 8, 2011                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol         October 2010
3250    
3251    
3252        "OK" -        "OK" -
3253    
3254           on success           on success
# Line 3185  Internet-Draft        LinuxSampler Contr Line 3264  Internet-Draft        LinuxSampler Contr
3264           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3265           error message           error message
3266    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3267     Examples:     Examples:
3268    
3269    
# Line 3228  Internet-Draft        LinuxSampler Contr Line 3299  Internet-Draft        LinuxSampler Contr
3299    
3300    
3301    
3302    
3303    Schoenebeck               Expires April 8, 2011                [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol         October 2010
3306    
3307    
3308    
3309    
3310  6.4.20.  Setting MIDI input channel  6.4.20.  Setting MIDI input channel
3311    
3312     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
# Line 3241  Internet-Draft        LinuxSampler Contr Line 3320  Internet-Draft        LinuxSampler Contr
3320    
3321     Possible Answers:     Possible Answers:
3322    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 58]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3323        "OK" -        "OK" -
3324    
3325           on success           on success
# Line 3282  Internet-Draft        LinuxSampler Contr Line 3353  Internet-Draft        LinuxSampler Contr
3353    
3354     Possible Answers:     Possible Answers:
3355    
3356    
3357    
3358    
3359    Schoenebeck               Expires April 8, 2011                [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol         October 2010
3362    
3363    
3364        "OK" -        "OK" -
3365    
3366           on success           on success
# Line 3297  Internet-Draft        LinuxSampler Contr Line 3376  Internet-Draft        LinuxSampler Contr
3376           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3377           error message           error message
3378    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3379     Examples:     Examples:
3380    
3381    
# Line 3338  Internet-Draft        LinuxSampler Contr Line 3409  Internet-Draft        LinuxSampler Contr
3409           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3410           error message           error message
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires April 8, 2011                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol         October 2010
3418    
3419    
3420     Examples:     Examples:
3421    
3422    
# Line 3354  Internet-Draft        LinuxSampler Contr Line 3433  Internet-Draft        LinuxSampler Contr
3433     (Section 6.4.4) command and <solo> should be replaced either by "1"     (Section 6.4.4) command and <solo> should be replaced either by "1"
3434     to solo the channel or "0" to unsolo the channel.     to solo the channel or "0" to unsolo the channel.
3435    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3436     Possible Answers:     Possible Answers:
3437    
3438        "OK" -        "OK" -
# Line 3394  Internet-Draft        LinuxSampler Contr Line 3466  Internet-Draft        LinuxSampler Contr
3466     (Section 6.4.4) command and <map> can have the following     (Section 6.4.4) command and <map> can have the following
3467     possibilites:     possibilites:
3468    
3469    
3470    
3471    Schoenebeck               Expires April 8, 2011                [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol         October 2010
3474    
3475    
3476        "NONE" -        "NONE" -
3477    
3478           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
# Line 3409  Internet-Draft        LinuxSampler Contr Line 3488  Internet-Draft        LinuxSampler Contr
3488    
3489           You can assign a specific MIDI instrument map by replacing           You can assign a specific MIDI instrument map by replacing
3490           <map> with the respective numeric ID of the MIDI instrument map           <map> with the respective numeric ID of the MIDI instrument map
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3491           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)           as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3492           command.  Once that map will be deleted, the sampler channel           command.  Once that map will be deleted, the sampler channel
3493           would fall back to "NONE".           would fall back to "NONE".
# Line 3450  Internet-Draft        LinuxSampler Contr Line 3521  Internet-Draft        LinuxSampler Contr
3521     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3522     (Section 6.4.4) command, that is the sampler channel on which the     (Section 6.4.4) command, that is the sampler channel on which the
3523     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3524    
3525    
3526    
3527    Schoenebeck               Expires April 8, 2011                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol         October 2010
3530    
3531    
3532     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3533     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3534     effect send entity.  The name does not have to be unique, but MUST be     effect send entity.  The name does not have to be unique, but MUST be
# Line 3466  Internet-Draft        LinuxSampler Contr Line 3545  Internet-Draft        LinuxSampler Contr
3545     can alter the destination channels however with "SET FX_SEND     can alter the destination channels however with "SET FX_SEND
3546     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3547    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3548     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3549     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
3550     runtime performance, because for implementing channel effect sends,     runtime performance, because for implementing channel effect sends,
# Line 3504  Internet-Draft        LinuxSampler Contr Line 3576  Internet-Draft        LinuxSampler Contr
3576    
3577        C: "CREATE FX_SEND 0 93"        C: "CREATE FX_SEND 0 93"
3578    
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires April 8, 2011                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol         October 2010
3586    
3587    
3588        S: "OK[1]"        S: "OK[1]"
3589    
3590  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
# Line 3522  Internet-Draft        LinuxSampler Contr Line 3603  Internet-Draft        LinuxSampler Contr
3603    
3604     Possible Answers:     Possible Answers:
3605    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3606        "OK" -        "OK" -
3607    
3608           on success           on success
# Line 3557  Internet-Draft        LinuxSampler Contr Line 3631  Internet-Draft        LinuxSampler Contr
3631    
3632     Possible Answers:     Possible Answers:
3633    
3634    
3635    
3636    
3637    
3638    
3639    Schoenebeck               Expires April 8, 2011                [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol         October 2010
3642    
3643    
3644        The sampler will answer by returning the number of effect sends on        The sampler will answer by returning the number of effect sends on
3645        the given sampler channel.        the given sampler channel.
3646    
# Line 3577  Internet-Draft        LinuxSampler Contr Line 3661  Internet-Draft        LinuxSampler Contr
3661     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3662     (Section 6.4.4) command.     (Section 6.4.4) command.
3663    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 64]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3664     Possible Answers:     Possible Answers:
3665    
3666        The sampler will answer by returning a comma separated list with        The sampler will answer by returning a comma separated list with
# Line 3613  Internet-Draft        LinuxSampler Contr Line 3689  Internet-Draft        LinuxSampler Contr
3689     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3690     FX_SENDS" (Section 6.4.28) command.     FX_SENDS" (Section 6.4.28) command.
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires April 8, 2011                [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol         October 2010
3698    
3699    
3700     Possible Answers:     Possible Answers:
3701    
3702        The sampler will answer by sending a <CRLF> separated list.  Each        The sampler will answer by sending a <CRLF> separated list.  Each
# Line 3633  Internet-Draft        LinuxSampler Contr Line 3717  Internet-Draft        LinuxSampler Contr
3717              a value between 0 and 127 reflecting the MIDI controller              a value between 0 and 127 reflecting the MIDI controller
3718              which is able to modify the effect send's send level              which is able to modify the effect send's send level
3719    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
3720           LEVEL -           LEVEL -
3721    
3722              optionally dotted number reflecting the effect send's              optionally dotted number reflecting the effect send's
# Line 3655  Internet-Draft        LinuxSampler Contr Line 3731  Internet-Draft        LinuxSampler Contr
3731              send's output channel 0 is routed to channel 0 of the audio              send's output channel 0 is routed to channel 0 of the audio
3732              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
3733              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3734              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details),
3735                if an internal send effect is assigned to the effect send,
3736                then this setting defines the audio channel routing to that
3737                effect instance respectively
3738    
3739             EFFECT -
3740    
3741                destination send effect chain ID and destination effect
3742                chain position, separated by comma in the form "<effect-
3743                chain>,<chain-pos>" or "NONE" if there is no send effect
3744                assigned to the effect send
3745    
3746     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires April 8, 2011                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol         October 2010
3754    
3755    
3756     Example:     Example:
3757    
3758        C: "GET FX_SEND INFO 0 0"        C: "GET FX_SEND INFO 0 0"
# Line 3671  Internet-Draft        LinuxSampler Contr Line 3765  Internet-Draft        LinuxSampler Contr
3765    
3766           "AUDIO_OUTPUT_ROUTING: 2,3"           "AUDIO_OUTPUT_ROUTING: 2,3"
3767    
3768             "EFFECT: NONE"
3769    
3770             "."
3771    
3772          C: "GET FX_SEND INFO 0 1"
3773    
3774          S: "NAME: Delay Send (Internal)"
3775    
3776             "MIDI_CONTROLLER: 93"
3777    
3778             "LEVEL: 0.51"
3779    
3780             "AUDIO_OUTPUT_ROUTING: 1,2"
3781    
3782             "EFFECT: 2,0"
3783    
3784           "."           "."
3785    
3786  6.4.30.  Changing effect send's name  6.4.30.  Changing effect send's name
# Line 3690  Internet-Draft        LinuxSampler Contr Line 3800  Internet-Draft        LinuxSampler Contr
3800     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
3801     (Section 7.1)").     (Section 7.1)").
3802    
3803       Possible Answers:
3804    
3805    
3806    
3807  Schoenebeck              Expires April 17, 2008                [Page 66]  Schoenebeck               Expires April 8, 2011                [Page 68]
3808    
3809  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
   
3810    
    Possible Answers:  
3811    
3812        "OK" -        "OK" -
3813    
# Line 3730  Internet-Draft        LinuxSampler Contr Line 3840  Internet-Draft        LinuxSampler Contr
3840     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3841     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
3842     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
3843     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.  If an
3844       internal send effect is assigned to the effect send, then this
3845       setting defines the audio channel routing to that effect instance
3846       respectively.
3847    
3848     Note that effect sends can only route audio to the same audio output     Note that effect sends can only route audio to the same audio output
3849     device as assigned to the effect send's sampler channel.  Also note     device as assigned to the effect send's sampler channel.  Also note
# Line 3744  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857     send into a mono one by simply altering its audio routing     send into a mono one by simply altering its audio routing
3858     appropriately.     appropriately.
3859    
    Possible Answers:  
3860    
3861    
3862    
3863  Schoenebeck              Expires April 17, 2008                [Page 67]  Schoenebeck               Expires April 8, 2011                [Page 69]
3864    
3865  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
3866    
3867    
3868       Possible Answers:
3869    
3870        "OK" -        "OK" -
3871    
3872           on success           on success
# Line 3774  Internet-Draft        LinuxSampler Contr Line 3888  Internet-Draft        LinuxSampler Contr
3888    
3889        S: "OK"        S: "OK"
3890    
3891  6.4.32.  Altering effect send's MIDI controller  6.4.32.  Assigning destination effect to an effect send
3892    
3893       The front-end can (re-)assign a destination effect to an effect send
3894       by sending the following command:
3895    
3896          SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain>
3897          <chain-pos>
3898    
3899       Where <sampler-chan> is the sampler channel number as returned by the
3900       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3901       command, <fx-send-id> reflects the numerical ID of the effect send
3902       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3903       FX_SENDS" (Section 6.4.28) command, <effect-chain> by the numerical
3904       ID of the destination effect chain as returned by the "ADD
3905       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
3906       (Section 6.11.13) command and <chain-pos> reflects the exact effect
3907       chain position in the effect chain which hosts the actual destination
3908       effect.
3909    
3910       Possible Answers:
3911    
3912          "OK" -
3913    
3914             on success
3915    
3916    
3917    
3918    
3919    Schoenebeck               Expires April 8, 2011                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol         October 2010
3922    
3923    
3924          "ERR:<error-code>:<error-message>" -
3925    
3926             in case it failed, providing an appropriate error code and
3927             error message
3928    
3929       Example:
3930    
3931          C: "SET FX_SEND EFFECT 0 0 2 5"
3932    
3933          S: "OK"
3934    
3935    6.4.33.  Removing destination effect from an effect send
3936    
3937       The front-end can (re-)assign a destination effect to an effect send
3938       by sending the following command:
3939    
3940          REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id>
3941    
3942       Where <sampler-chan> is the sampler channel number as returned by the
3943       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3944       command, <fx-send-id> reflects the numerical ID of the effect send
3945       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3946       FX_SENDS" (Section 6.4.28) command.
3947    
3948       After the destination effect has been removed from the effect send,
3949       the audio signal of the effect send will be routed directly to the
3950       audio output device, according to the audio channel routing setting
3951       of the effect send.
3952    
3953       Possible Answers:
3954    
3955          "OK" -
3956    
3957             on success
3958    
3959          "ERR:<error-code>:<error-message>" -
3960    
3961             in case it failed, providing an appropriate error code and
3962             error message
3963    
3964       Example:
3965    
3966          C: "REMOVE FX_SEND EFFECT 0 0"
3967    
3968          S: "OK"
3969    
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires April 8, 2011                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol         October 2010
3978    
3979    
3980    6.4.34.  Altering effect send's MIDI controller
3981    
3982     The front-end can alter the MIDI controller of an effect send entity     The front-end can alter the MIDI controller of an effect send entity
3983     by sending the following command:     by sending the following command:
# Line 3802  Internet-Draft        LinuxSampler Contr Line 4005  Internet-Draft        LinuxSampler Contr
4005           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4006           message           message
4007    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4008        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4009    
4010           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3820  Internet-Draft        LinuxSampler Contr Line 4016  Internet-Draft        LinuxSampler Contr
4016    
4017        S: "OK"        S: "OK"
4018    
4019  6.4.33.  Altering effect send's send level  6.4.35.  Altering effect send's send level
4020    
4021     The front-end can alter the current send level of an effect send     The front-end can alter the current send level of an effect send
4022     entity by sending the following command:     entity by sending the following command:
# Line 3829  Internet-Draft        LinuxSampler Contr Line 4025  Internet-Draft        LinuxSampler Contr
4025    
4026     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4027     "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)
4028    
4029    
4030    
4031    Schoenebeck               Expires April 8, 2011                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol         October 2010
4034    
4035    
4036     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4037     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
4038     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
# Line 3855  Internet-Draft        LinuxSampler Contr Line 4059  Internet-Draft        LinuxSampler Contr
4059    
4060     Example:     Example:
4061    
4062          C: "SET FX_SEND LEVEL 0 0 0.15"
4063    
4064          S: "OK"
4065    
4066    6.4.36.  Sending MIDI messages to sampler channel
4067    
4068       The front-end can send MIDI events to a specific sampler channel by
4069       sending the following command:
4070    
4071          SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>
4072    
4073       Where <sampler-chan> is the sampler channel number as returned by the
4074       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4075       command, <arg1> and <arg2> arguments depend on the <midi-msg>
4076       argument, which specifies the MIDI message type.  Currently, the
4077       following MIDI messages are supported:
4078    
4079          "NOTE_ON" -
4080    
4081             For turning on MIDI notes, where <arg1> specifies the key
4082             number and <arg2> the velocity as described in the MIDI
4083             specification.
4084    
4085    
4086    
4087  Schoenebeck              Expires April 17, 2008                [Page 69]  Schoenebeck               Expires April 8, 2011                [Page 73]
4088    
4089  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
4090    
4091    
4092        C: "SET FX_SEND LEVEL 0 0 0.15"        "NOTE_OFF" -
4093    
4094             For turning a currently playing MIDI note off, where <arg1>
4095             specifies the key number and <arg2> the velocity as described
4096             in the MIDI specification.
4097    
4098          "CC" -
4099    
4100             For changing a MIDI controller, where <arg1> specifies the
4101             controller number and <arg2> the new value of the controller as
4102             described in the Control Change section of the MIDI
4103             specification.
4104    
4105       CAUTION: This command is provided for implementations of virtual MIDI
4106       keyboards and no realtime guarantee whatsoever will be made!
4107    
4108       Possible Answers:
4109    
4110          "OK" -
4111    
4112             on success
4113    
4114          "ERR:<error-code>:<error-message>" -
4115    
4116             in case it failed, providing an appropriate error code and
4117             error message
4118    
4119       Example:
4120    
4121          C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
4122    
4123        S: "OK"        S: "OK"
4124    
4125  6.4.34.  Resetting a sampler channel  6.4.37.  Resetting a sampler channel
4126    
4127     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
4128     following command:     following command:
# Line 3883  Internet-Draft        LinuxSampler Contr Line 4136  Internet-Draft        LinuxSampler Contr
4136    
4137     Possible Answers:     Possible Answers:
4138    
4139    
4140    
4141    
4142    
4143    Schoenebeck               Expires April 8, 2011                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol         October 2010
4146    
4147    
4148        "OK" -        "OK" -
4149    
4150           on success           on success
# Line 3912  Internet-Draft        LinuxSampler Contr Line 4174  Internet-Draft        LinuxSampler Contr
4174     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
4175     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
4176    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4177        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
4178    
4179     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
# Line 3938  Internet-Draft        LinuxSampler Contr Line 4191  Internet-Draft        LinuxSampler Contr
4191           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4192           message           message
4193    
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck               Expires April 8, 2011                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol         October 2010
4202    
4203    
4204        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4205    
4206           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3969  Internet-Draft        LinuxSampler Contr Line 4232  Internet-Draft        LinuxSampler Contr
4232           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4233           message           message
4234    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4235        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4236    
4237           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3994  Internet-Draft        LinuxSampler Contr Line 4249  Internet-Draft        LinuxSampler Contr
4249        SET ECHO <value>        SET ECHO <value>
4250    
4251     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
4252    
4253    
4254    
4255    Schoenebeck               Expires April 8, 2011                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol         October 2010
4258    
4259    
4260     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
4261     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
4262     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 4024  Internet-Draft        LinuxSampler Contr Line 4287  Internet-Draft        LinuxSampler Contr
4287     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4288     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4289    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4290  6.6.  Global commands  6.6.  Global commands
4291    
4292     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
# Line 4049  Internet-Draft        LinuxSampler Contr Line 4303  Internet-Draft        LinuxSampler Contr
4303        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4304        voices on the sampler.        voices on the sampler.
4305    
4306    
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires April 8, 2011                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol         October 2010
4314    
4315    
4316  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
4317    
4318     The front-end can ask for the maximum number of active voices by     The front-end can ask for the maximum number of active voices by
# Line 4061  Internet-Draft        LinuxSampler Contr Line 4325  Internet-Draft        LinuxSampler Contr
4325        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4326        voices.        voices.
4327    
4328  6.6.3.  Reset sampler  6.6.3.  Current number of active disk streams
4329    
4330       The front-end can ask for the current number of active disk streams
4331       on the sampler by sending the following command:
4332    
4333          GET TOTAL_STREAM_COUNT
4334    
4335       Possible Answers:
4336    
4337          LinuxSampler will answer by returning the number of all active
4338          disk streams on the sampler.
4339    
4340    6.6.4.  Reset sampler
4341    
4342     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
4343     command:     command:
# Line 4078  Internet-Draft        LinuxSampler Contr Line 4354  Internet-Draft        LinuxSampler Contr
4354    
4355    
4356    
4357    6.6.5.  General sampler informations
4358    
4359       The client can ask for general informations about the LinuxSampler
4360       instance by sending the following command:
4361    
4362    
4363    
4364    
4365    
 Schoenebeck              Expires April 17, 2008                [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
4366    
4367  6.6.4.  General sampler informations  Schoenebeck               Expires April 8, 2011                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol         October 2010
4370    
    The client can ask for general informations about the LinuxSampler  
    instance by sending the following command:  
4371    
4372        GET SERVER INFO        GET SERVER INFO
4373    
# Line 4129  Internet-Draft        LinuxSampler Contr Line 4404  Internet-Draft        LinuxSampler Contr
4404     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4405     Other fields might be added in future.     Other fields might be added in future.
4406    
4407  6.6.5.  Getting global volume attenuation  6.6.6.  Getting global volume attenuation
4408    
4409     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
4410     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4138  Internet-Draft        LinuxSampler Contr Line 4413  Internet-Draft        LinuxSampler Contr
4413    
4414     Possible Answers:     Possible Answers:
4415    
4416          The sampler will always answer by returning the optional dotted
4417          floating point coefficient, reflecting the current global volume
4418          attenuation.
4419    
4420    
 Schoenebeck              Expires April 17, 2008                [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
4421    
4422    
4423        The sampler will always answer by returning the optional dotted  Schoenebeck               Expires April 8, 2011                [Page 79]
4424        floating point coefficient, reflecting the current global volume  
4425        attenuation.  Internet-Draft        LinuxSampler Control Protocol         October 2010
4426    
4427    
4428     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4429     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
4430     this parameter.     this parameter.
4431    
4432  6.6.6.  Setting global volume attenuation  6.6.7.  Setting global volume attenuation
4433    
4434     The client can alter the current global sampler-wide volume     The client can alter the current global sampler-wide volume
4435     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4182  Internet-Draft        LinuxSampler Contr Line 4458  Internet-Draft        LinuxSampler Contr
4458           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4459           error message           error message
4460    
4461    6.6.8.  Getting global voice limit
4462    
4463       The client can ask for the current global sampler-wide limit for
4464       maximum voices by sending the following command:
4465    
4466          GET VOICES
4467    
4468       Possible Answers:
4469    
4470          LinuxSampler will answer by returning the number for the current
4471          limit of maximum voices.
4472    
4473       The voice limit setting defines how many voices should maximum be
4474       processed by the sampler at the same time.  If the user triggers new
4475       notes which would exceed that voice limit, the sampler engine will
4476    
4477    
4478    
4479    Schoenebeck               Expires April 8, 2011                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol         October 2010
4482    
4483    
4484       react by stealing old voices for those newly triggered notes.  Note
4485       that the amount of voices triggered by a new note can be larger than
4486       one and is dependent to the respective instrument and probably
4487       further criterias.
4488    
4489    6.6.9.  Setting global voice limit
4490    
4491       The client can alter the current global sampler-wide limit for
4492       maximum voices by sending the following command:
4493    
4494          SET VOICES <max-voices>
4495    
4496       Where <max-voices> should be replaced by the integer value,
4497       reflecting the new global amount limit of maximum voices.  This value
4498       has to be larger than 0.
4499    
4500       Possible Answers:
4501    
4502          "OK" -
4503    
4504             on success
4505    
4506          "WRN:<warning-code>:<warning-message>" -
4507    
4508             if the voice limit was set, but there are noteworthy issue(s)
4509             related, providing an appropriate warning code and warning
4510             message
4511    
4512          "ERR:<error-code>:<error-message>" -
4513    
4514             in case it failed, providing an appropriate error code and
4515             error message
4516    
4517       Note: the given value will be passed to all sampler engine instances.
4518       The total amount of maximum voices on the running system might thus
4519       be as big as the given value multiplied by the current amount of
4520       engine instances.
4521    
4522       Caution: when adjusting the voice limit, you SHOULD also adjust the
4523       disk stream limit respectively and vice versa.
4524    
4525    6.6.10.  Getting global disk stream limit
4526    
4527       The client can ask for the current global sampler-wide limit for
4528       maximum disk streams by sending the following command:
4529    
4530    
4531    
4532    
4533    
4534    
4535    Schoenebeck               Expires April 8, 2011                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol         October 2010
4538    
4539    
4540          GET STREAMS
4541    
4542       Possible Answers:
4543    
4544          LinuxSampler will answer by returning the number for the current
4545          limit of maximum disk streams.
4546    
4547       The disk stream limit setting defines how many disk streams should
4548       maximum be processed by a sampler engine at the same time.  The
4549       higher this value, the more memory (RAM) will be occupied, since
4550       every disk streams allocates a certain buffer size for being able to
4551       perform its streaming operations.
4552    
4553    6.6.11.  Setting global disk stream limit
4554    
4555       The client can alter the current global sampler-wide limit for
4556       maximum disk streams by sending the following command:
4557    
4558          SET STREAMS <max-streams>
4559    
4560       Where <max-streams> should be replaced by the integer value,
4561       reflecting the new global amount limit of maximum disk streams.  This
4562       value has to be positive.
4563    
4564       Possible Answers:
4565    
4566          "OK" -
4567    
4568             on success
4569    
4570          "WRN:<warning-code>:<warning-message>" -
4571    
4572             if the disk stream limit was set, but there are noteworthy
4573             issue(s) related, providing an appropriate warning code and
4574             warning message
4575    
4576          "ERR:<error-code>:<error-message>" -
4577    
4578             in case it failed, providing an appropriate error code and
4579             error message
4580    
4581       Note: the given value will be passed to all sampler engine instances.
4582       The total amount of maximum disk streams on the running system might
4583       thus be as big as the given value multiplied by the current amount of
4584       engine instances.
4585    
4586       Caution: when adjusting the disk stream limit, you SHOULD also adjust
4587       the voice limit respectively and vice versa.
4588    
4589    
4590    
4591    Schoenebeck               Expires April 8, 2011                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol         October 2010
4594    
4595    
4596  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4597    
4598     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 4194  Internet-Draft        LinuxSampler Contr Line 4605  Internet-Draft        LinuxSampler Contr
4605     maps which define which instrument to load on which MIDI program     maps which define which instrument to load on which MIDI program
4606     change message.     change message.
4607    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4608     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,
4609     thus the sampler will simply ignore all program change messages.  The     thus the sampler will simply ignore all program change messages.  The
4610     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
# Line 4236  Internet-Draft        LinuxSampler Contr Line 4640  Internet-Draft        LinuxSampler Contr
4640    
4641        "OK[<map>]" -        "OK[<map>]" -
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires April 8, 2011                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol         October 2010
4650    
4651    
4652           in case a new MIDI instrument map could be added, where <map>           in case a new MIDI instrument map could be added, where <map>
4653           reflects the unique ID of the newly created MIDI instrument map           reflects the unique ID of the newly created MIDI instrument map
4654    
# Line 4248  Internet-Draft        LinuxSampler Contr Line 4661  Internet-Draft        LinuxSampler Contr
4661    
4662        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4663    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4664        S: "OK[0]"        S: "OK[0]"
4665    
4666        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
# Line 4294  Internet-Draft        LinuxSampler Contr Line 4698  Internet-Draft        LinuxSampler Contr
4698    
4699     Examples:     Examples:
4700    
       C: "REMOVE MIDI_INSTRUMENT_MAP 0"  
   
       S: "OK"  
   
       C: "REMOVE MIDI_INSTRUMENT_MAP ALL"  
   
       S: "OK"  
   
4701    
4702    
4703    Schoenebeck               Expires April 8, 2011                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol         October 2010
4706    
4707    
4708          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4709    
4710          S: "OK"
4711    
4712  Schoenebeck              Expires April 17, 2008                [Page 77]        C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
4713    
4714          S: "OK"
4715    
4716  6.7.3.  Get amount of existing MIDI instrument maps  6.7.3.  Get amount of existing MIDI instrument maps
4717    
# Line 4350  Internet-Draft        LinuxSampler Contr Line 4750  Internet-Draft        LinuxSampler Contr
4750    
4751        S: "0,1,5,12"        S: "0,1,5,12"
4752    
4753    
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires April 8, 2011                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol         October 2010
4762    
4763    
4764  6.7.5.  Getting MIDI instrument map information  6.7.5.  Getting MIDI instrument map information
4765    
4766     The front-end can ask for the current settings of a MIDI instrument     The front-end can ask for the current settings of a MIDI instrument
# Line 4361  Internet-Draft        LinuxSampler Contr Line 4772  Internet-Draft        LinuxSampler Contr
4772     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4773     (Section 6.7.4) command.     (Section 6.7.4) command.
4774    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4775     Possible Answers:     Possible Answers:
4776    
4777        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 4402  Internet-Draft        LinuxSampler Contr Line 4805  Internet-Draft        LinuxSampler Contr
4805    
4806           "."           "."
4807    
4808    
4809    
4810    
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires April 8, 2011                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol         October 2010
4818    
4819    
4820  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
4821    
4822     The front-end can alter the custom name of a MIDI instrument map by     The front-end can alter the custom name of a MIDI instrument map by
# Line 4417  Internet-Draft        LinuxSampler Contr Line 4832  Internet-Draft        LinuxSampler Contr
4832    
4833     Possible Answers:     Possible Answers:
4834    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4835        "OK" -        "OK" -
4836    
4837           on success           on success
# Line 4458  Internet-Draft        LinuxSampler Contr Line 4865  Internet-Draft        LinuxSampler Contr
4865     supporting escape sequences as described in chapter "Character Set     supporting escape sequences as described in chapter "Character Set
4866     and Escape Sequences (Section 7.1)"), <instrument_index> the index     and Escape Sequences (Section 7.1)"), <instrument_index> the index
4867     (integer value) of the instrument within the given file,     (integer value) of the instrument within the given file,
4868    
4869    
4870    
4871    Schoenebeck               Expires April 8, 2011                [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol         October 2010
4874    
4875    
4876     <volume_value> reflects the master volume of the instrument as     <volume_value> reflects the master volume of the instrument as
4877     optionally dotted number (where a value < 1.0 means attenuation and a     optionally dotted number (where a value < 1.0 means attenuation and a
4878     value > 1.0 means amplification).  This parameter easily allows to     value > 1.0 means amplification).  This parameter easily allows to
# Line 4474  Internet-Draft        LinuxSampler Contr Line 4889  Internet-Draft        LinuxSampler Contr
4889           be freed from memory when not needed by any sampler channel           be freed from memory when not needed by any sampler channel
4890           anymore.           anymore.
4891    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4892        "ON_DEMAND_HOLD" -        "ON_DEMAND_HOLD" -
4893    
4894           The instrument will be loaded when needed, that is when           The instrument will be loaded when needed, that is when
# Line 4513  Internet-Draft        LinuxSampler Contr Line 4921  Internet-Draft        LinuxSampler Contr
4921     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
4922     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
4923     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
4924    
4925    
4926    
4927    Schoenebeck               Expires April 8, 2011                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol         October 2010
4930    
4931    
4932     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4933     supported by the respective sampler engine (which is technically the     supported by the respective sampler engine (which is technically the
4934     case when the engine provides an InstrumentManager for its format).     case when the engine provides an InstrumentManager for its format).
# Line 4529  Internet-Draft        LinuxSampler Contr Line 4945  Internet-Draft        LinuxSampler Contr
4945     "Character Set and Escape Sequences (Section 7.1)") for the mapping     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4946     entry, useful for frontends for displaying an appropriate name for     entry, useful for frontends for displaying an appropriate name for
4947     mapped instruments (using "GET MIDI_INSTRUMENT INFO"     mapped instruments (using "GET MIDI_INSTRUMENT INFO"
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
4948     (Section 6.7.11)).     (Section 6.7.11)).
4949    
4950     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
# Line 4567  Internet-Draft        LinuxSampler Contr Line 4975  Internet-Draft        LinuxSampler Contr
4975    
4976     Examples:     Examples:
4977    
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires April 8, 2011                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol         October 2010
4986    
4987    
4988        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
4989        0.8 PERSISTENT"        0.8 PERSISTENT"
4990    
# Line 4585  Internet-Draft        LinuxSampler Contr Line 5003  Internet-Draft        LinuxSampler Contr
5003        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
5004        'Silent Piano'"        'Silent Piano'"
5005    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5006        S: "OK"        S: "OK"
5007    
5008        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
# Line 4623  Internet-Draft        LinuxSampler Contr Line 5033  Internet-Draft        LinuxSampler Contr
5033    
5034        S: "234"        S: "234"
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires April 8, 2011                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol         October 2010
5042    
5043    
5044        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
5045    
5046        S: "954"        S: "954"
# Line 4639  Internet-Draft        LinuxSampler Contr Line 5057  Internet-Draft        LinuxSampler Contr
5057     The front-end can query a list of all currently existing entries of     The front-end can query a list of all currently existing entries of
5058     all MIDI instrument maps by sending the following command:     all MIDI instrument maps by sending the following command:
5059    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5060        LIST MIDI_INSTRUMENTS ALL        LIST MIDI_INSTRUMENTS ALL
5061    
5062     Possible Answers:     Possible Answers:
# Line 4681  Internet-Draft        LinuxSampler Contr Line 5089  Internet-Draft        LinuxSampler Contr
5089    
5090     Possible Answers:     Possible Answers:
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires April 8, 2011                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol         October 2010
5098    
5099    
5100        "OK" -        "OK" -
5101    
5102           usually           usually
# Line 4695  Internet-Draft        LinuxSampler Contr Line 5111  Internet-Draft        LinuxSampler Contr
5111    
5112        S: "OK"        S: "OK"
5113    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5114  6.7.11.  Get current settings of MIDI instrument map entry  6.7.11.  Get current settings of MIDI instrument map entry
5115    
5116     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
# Line 4739  Internet-Draft        LinuxSampler Contr Line 5145  Internet-Draft        LinuxSampler Contr
5145    
5146           Name of the engine to be deployed for this instrument.           Name of the engine to be deployed for this instrument.
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires April 8, 2011                [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol         October 2010
5154    
5155    
5156        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
5157    
5158           File name of the instrument (note that this path may contain           File name of the instrument (note that this path may contain
# Line 4753  Internet-Draft        LinuxSampler Contr Line 5167  Internet-Draft        LinuxSampler Contr
5167           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
5168           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
5169           cannot be changed (note that this character string may contain           cannot be changed (note that this character string may contain
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 85]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5170           escape sequences (Section 7.1)).           escape sequences (Section 7.1)).
5171    
5172        "LOAD_MODE" -        "LOAD_MODE" -
# Line 4794  Internet-Draft        LinuxSampler Contr Line 5200  Internet-Draft        LinuxSampler Contr
5200    
5201           "VOLUME: 1.0"           "VOLUME: 1.0"
5202    
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires April 8, 2011                [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol         October 2010
5210    
5211    
5212           "."           "."
5213    
5214  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
# Line 4808  Internet-Draft        LinuxSampler Contr Line 5223  Internet-Draft        LinuxSampler Contr
5223     The front-end can clear all MIDI instrument maps, that is delete all     The front-end can clear all MIDI instrument maps, that is delete all
5224     entries of all maps by sending the following command:     entries of all maps by sending the following command:
5225    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5226        CLEAR MIDI_INSTRUMENTS ALL        CLEAR MIDI_INSTRUMENTS ALL
5227    
5228     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
# Line 4850  Internet-Draft        LinuxSampler Contr Line 5256  Internet-Draft        LinuxSampler Contr
5256        name support escape sequences as described in chapter "Character        name support escape sequences as described in chapter "Character
5257        Set and Escape Sequences (Section 7.1)".        Set and Escape Sequences (Section 7.1)".
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires April 8, 2011                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol         October 2010
5266    
5267    
5268        All occurrences of a forward slash in instrument and directory        All occurrences of a forward slash in instrument and directory
5269        names are escaped with its hex (\x2f) or octal (\057) escape        names are escaped with its hex (\x2f) or octal (\057) escape
5270        sequence.        sequence.
# Line 4866  Internet-Draft        LinuxSampler Contr Line 5281  Internet-Draft        LinuxSampler Contr
5281    
5282     Possible Answers:     Possible Answers:
5283    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5284        "OK" -        "OK" -
5285    
5286           on success           on success
# Line 4904  Internet-Draft        LinuxSampler Contr Line 5312  Internet-Draft        LinuxSampler Contr
5312    
5313        "OK" -        "OK" -
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires April 8, 2011                [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol         October 2010
5322    
5323    
5324           if the directory is deleted successfully           if the directory is deleted successfully
5325    
5326        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 4917  Internet-Draft        LinuxSampler Contr Line 5334  Internet-Draft        LinuxSampler Contr
5334    
5335        S: "OK"        S: "OK"
5336    
   
   
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5337  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
5338    
5339     The front-end can retrieve the current amount of directories in a     The front-end can retrieve the current amount of directories in a
# Line 4964  Internet-Draft        LinuxSampler Contr Line 5369  Internet-Draft        LinuxSampler Contr
5369        LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>        LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
5370    
5371     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5372    
5373    
5374    
5375    Schoenebeck               Expires April 8, 2011                [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol         October 2010
5378    
5379    
5380     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
5381     directories, including those located in subdirectories of the     directories, including those located in subdirectories of the
5382     specified directory, will be returned.     specified directory, will be returned.
# Line 4977  Internet-Draft        LinuxSampler Contr Line 5390  Internet-Draft        LinuxSampler Contr
5390    
5391           if the given directory does not exist.           if the given directory does not exist.
5392    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5393     Example:     Example:
5394    
5395        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
# Line 5021  Internet-Draft        LinuxSampler Contr Line 5426  Internet-Draft        LinuxSampler Contr
5426              A brief description of the directory content.  Note that the              A brief description of the directory content.  Note that the
5427              character string may contain escape sequences (Section 7.1).              character string may contain escape sequences (Section 7.1).
5428    
5429    
5430    
5431    Schoenebeck               Expires April 8, 2011                [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol         October 2010
5434    
5435    
5436           CREATED -           CREATED -
5437    
5438              The creation date and time of the directory, represented in              The creation date and time of the directory, represented in
# Line 5033  Internet-Draft        LinuxSampler Contr Line 5445  Internet-Draft        LinuxSampler Contr
5445    
5446     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5447    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5448     Example:     Example:
5449    
5450        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
# Line 5077  Internet-Draft        LinuxSampler Contr Line 5481  Internet-Draft        LinuxSampler Contr
5481    
5482     Example:     Example:
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires April 8, 2011                [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol         October 2010
5490    
5491    
5492        C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'        C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5493        'Acoustic'"        'Acoustic'"
5494    
# Line 5087  Internet-Draft        LinuxSampler Contr Line 5499  Internet-Draft        LinuxSampler Contr
5499     The front-end can move a specific instrument directory by sending the     The front-end can move a specific instrument directory by sending the
5500     following command:     following command:
5501    
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5502        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>        MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5503    
5504     Where <dir> is the absolute path name of the directory to move and     Where <dir> is the absolute path name of the directory to move and
# Line 5134  Internet-Draft        LinuxSampler Contr Line 5536  Internet-Draft        LinuxSampler Contr
5536    
5537     Possible Answers:     Possible Answers:
5538    
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires April 8, 2011                [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol         October 2010
5546    
5547    
5548        "OK" -        "OK" -
5549    
5550           on success           on success
# Line 5145  Internet-Draft        LinuxSampler Contr Line 5556  Internet-Draft        LinuxSampler Contr
5556           exists in the destination directory.  Error is also thrown when           exists in the destination directory.  Error is also thrown when
5557           trying to copy a directory to a subdirectory of itself.           trying to copy a directory to a subdirectory of itself.
5558    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5559     Example:     Example:
5560    
5561        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
# Line 5189  Internet-Draft        LinuxSampler Contr Line 5592  Internet-Draft        LinuxSampler Contr
5592    
5593        S: "OK"        S: "OK"
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck               Expires April 8, 2011               [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol         October 2010
5602    
5603    
5604  6.8.10.  Finding directories  6.8.10.  Finding directories
5605    
5606     The front-end can search for directories in specific directory by     The front-end can search for directories in specific directory by
# Line 5201  Internet-Draft        LinuxSampler Contr Line 5613  Internet-Draft        LinuxSampler Contr
5613     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5614     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5615     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5616     form of "key1=val1 key2=val2 ...".  The following criterias are     form of "key1=val1 key2=val2 ...".  The following criterias are
5617     allowed:     allowed:
5618    
# Line 5245  Internet-Draft        LinuxSampler Contr Line 5649  Internet-Draft        LinuxSampler Contr
5649        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
5650        "Character Set and Escape Sequences (Section 7.1)").        "Character Set and Escape Sequences (Section 7.1)").
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires April 8, 2011               [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol         October 2010
5658    
5659    
5660     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5661     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
5662    
# Line 5256  Internet-Draft        LinuxSampler Contr Line 5668  Internet-Draft        LinuxSampler Contr
5668    
5669        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5670    
   
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5671           if the given directory does not exist.           if the given directory does not exist.
5672    
5673     Example:     Example:
# Line 5283  Internet-Draft        LinuxSampler Contr Line 5686  Internet-Draft        LinuxSampler Contr
5686     The front-end can add one or more instruments to the instruments     The front-end can add one or more instruments to the instruments
5687     database by sending the following command:     database by sending the following command:
5688    
5689        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir>
5690        [<instr_index>]        <file_path> [<instr_index>]
5691    
5692     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5693     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
# Line 5300  Internet-Draft        LinuxSampler Contr Line 5703  Internet-Draft        LinuxSampler Contr
5703     is provided as <file_path> and specifies how the scanning will be     is provided as <file_path> and specifies how the scanning will be
5704     done and has exactly the following possibilities:     done and has exactly the following possibilities:
5705    
       "RECURSIVE" -  
5706    
          All instruments will be processed, including those in the  
          subdirectories, and the respective subdirectory tree structure  
          will be recreated in the instruments database  
5707    
       "NON_RECURSIVE" -  
5708    
          Only the instruments in the specified directory will be added,  
          the instruments in the subdirectories will not be processed.  
5709    
5710    
5711    Schoenebeck               Expires April 8, 2011               [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol         October 2010
5714    
5715    
5716          "RECURSIVE" -
5717    
5718             All instruments will be processed, including those in the
5719             subdirectories, and the respective subdirectory tree structure
5720             will be recreated in the instruments database
5721    
5722  Schoenebeck              Expires April 17, 2008                [Page 95]        "NON_RECURSIVE" -
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
5723    
5724             Only the instruments in the specified directory will be added,
5725             the instruments in the subdirectories will not be processed.
5726    
5727        "FLAT" -        "FLAT" -
5728    
# Line 5328  Internet-Draft        LinuxSampler Contr Line 5731  Internet-Draft        LinuxSampler Contr
5731           not be recreated in the instruments database.  All instruments           not be recreated in the instruments database.  All instruments
5732           will be added directly in the specified database directory.           will be added directly in the specified database directory.
5733    
5734       If FILE_AS_DIR argument is supplied, all instruments in an instrument
5735       file will be added to a separate directory in the instruments
5736       database, which name will be the name of the instrument file with the
5737       file extension stripped off.
5738    
5739     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
5740     is that the regular command returns when the scanning is finished     is that the regular command returns when the scanning is finished
5741     while NON_MODAL version returns immediately and a background process     while NON_MODAL version returns immediately and a background process
# Line 5352  Internet-Draft        LinuxSampler Contr Line 5760  Internet-Draft        LinuxSampler Contr
5760    
5761     Examples:     Examples:
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck               Expires April 8, 2011               [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol         October 2010
5770    
5771    
5772        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5773        Bosendorfer 290.gig' 0"        Bosendorfer 290.gig' 0"
5774    
# Line 5369  Internet-Draft        LinuxSampler Contr Line 5786  Internet-Draft        LinuxSampler Contr
5786    
5787     Possible Answers:     Possible Answers:
5788    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 96]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5789        "OK" -        "OK" -
5790    
5791           if the instrument is removed successfully           if the instrument is removed successfully
# Line 5407  Internet-Draft        LinuxSampler Contr Line 5816  Internet-Draft        LinuxSampler Contr
5816    
5817        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5818    
5819    
5820    
5821    
5822    
5823    Schoenebeck               Expires April 8, 2011               [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol         October 2010
5826    
5827    
5828        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5829    
5830           if the given directory does not exist.           if the given directory does not exist.
# Line 5425  Internet-Draft        LinuxSampler Contr Line 5843  Internet-Draft        LinuxSampler Contr
5843        LIST DB_INSTRUMENTS [RECURSIVE] <dir>        LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5844    
5845     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5846     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
5847     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5848     specified directory, will be returned.     specified directory, will be returned.
# Line 5462  Internet-Draft        LinuxSampler Contr Line 5872  Internet-Draft        LinuxSampler Contr
5872     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
5873     sending the following command:     sending the following command:
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires April 8, 2011               [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol         October 2010
5882    
5883    
5884        GET DB_INSTRUMENT INFO <instr_path>        GET DB_INSTRUMENT INFO <instr_path>
5885    
5886     Where <instr_path> should be replaced by the absolute path name of     Where <instr_path> should be replaced by the absolute path name of
# Line 5482  Internet-Draft        LinuxSampler Contr Line 5901  Internet-Draft        LinuxSampler Contr
5901              File name of the instrument.  Note that the character string              File name of the instrument.  Note that the character string
5902              may contain escape sequences (Section 7.1).              may contain escape sequences (Section 7.1).
5903    
   
   
 Schoenebeck              Expires April 17, 2008                [Page 98]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5904           INSTRUMENT_NR -           INSTRUMENT_NR -
5905    
5906              Index of the instrument within the file.              Index of the instrument within the file.
# Line 5517  Internet-Draft        LinuxSampler Contr Line 5929  Internet-Draft        LinuxSampler Contr
5929              instrument's database settings, represented in "YYYY-MM-DD              instrument's database settings, represented in "YYYY-MM-DD
5930              HH:MM:SS" format              HH:MM:SS" format
5931    
5932    
5933    
5934    
5935    Schoenebeck               Expires April 8, 2011               [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol         October 2010
5938    
5939    
5940           DESCRIPTION -           DESCRIPTION -
5941    
5942              A brief description of the instrument.  Note that the              A brief description of the instrument.  Note that the
# Line 5537  Internet-Draft        LinuxSampler Contr Line 5957  Internet-Draft        LinuxSampler Contr
5957              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5958              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5959    
   
   
   
 Schoenebeck              Expires April 17, 2008                [Page 99]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
5960           KEYWORDS -           KEYWORDS -
5961    
5962              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
# Line 5572  Internet-Draft        LinuxSampler Contr Line 5984  Internet-Draft        LinuxSampler Contr
5984    
5985           "MODIFIED: 2007-04-07 12:50:21"           "MODIFIED: 2007-04-07 12:50:21"
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck               Expires April 8, 2011               [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol         October 2010
5994    
5995    
5996           "DESCRIPTION: "           "DESCRIPTION: "
5997    
5998           "IS_DRUM: false"           "IS_DRUM: false"
# Line 5594  Internet-Draft        LinuxSampler Contr Line 6015  Internet-Draft        LinuxSampler Contr
6015     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
6016     is the new name for that instrument.     is the new name for that instrument.
6017    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6018     Possible Answers:     Possible Answers:
6019    
6020        "OK" -        "OK" -
# Line 5627  Internet-Draft        LinuxSampler Contr Line 6041  Internet-Draft        LinuxSampler Contr
6041        MOVE DB_INSTRUMENT <instr> <dst>        MOVE DB_INSTRUMENT <instr> <dst>
6042    
6043     Where <instr> is the absolute path name of the instrument to move and     Where <instr> is the absolute path name of the instrument to move and
6044    
6045    
6046    
6047    Schoenebeck               Expires April 8, 2011               [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol         October 2010
6050    
6051    
6052     <dst> is the directory where the instrument will be moved to.     <dst> is the directory where the instrument will be moved to.
6053    
6054     Possible Answers:     Possible Answers:
# Line 5648  Internet-Draft        LinuxSampler Contr Line 6070  Internet-Draft        LinuxSampler Contr
6070    
6071        S: "OK"        S: "OK"
6072    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 101]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6073  6.8.18.  Copying instruments  6.8.18.  Copying instruments
6074    
6075     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 5684  Internet-Draft        LinuxSampler Contr Line 6097  Internet-Draft        LinuxSampler Contr
6097        C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'        C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
6098        '/Acoustic/Pianos/'"        '/Acoustic/Pianos/'"
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires April 8, 2011               [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol         October 2010
6106    
6107    
6108        S: "OK"        S: "OK"
6109    
6110  6.8.19.  Changing the description of instrument  6.8.19.  Changing the description of instrument
# Line 5704  Internet-Draft        LinuxSampler Contr Line 6125  Internet-Draft        LinuxSampler Contr
6125    
6126           on success           on success
6127    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6128        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6129    
6130           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5740  Internet-Draft        LinuxSampler Contr Line 6152  Internet-Draft        LinuxSampler Contr
6152    
6153     NAME='<search-string>'     NAME='<search-string>'
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck               Expires April 8, 2011               [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol         October 2010
6162    
6163    
6164        Restricts the search to instruments, which names satisfy the        Restricts the search to instruments, which names satisfy the
6165        supplied search string (encapsulated into apostrophes, supporting        supplied search string (encapsulated into apostrophes, supporting
6166        escape sequences as described in chapter "Character Set and Escape        escape sequences as described in chapter "Character Set and Escape
# Line 5762  Internet-Draft        LinuxSampler Contr Line 6183  Internet-Draft        LinuxSampler Contr
6183        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
6184        instruments created after <date-after>.        instruments created after <date-after>.
6185    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 103]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6186     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
6187    
6188        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 5795  Internet-Draft        LinuxSampler Contr Line 6209  Internet-Draft        LinuxSampler Contr
6209    
6210     ARTISTS='<search-string>'     ARTISTS='<search-string>'
6211    
6212    
6213    
6214    
6215    Schoenebeck               Expires April 8, 2011               [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol         October 2010
6218    
6219    
6220        Restricts the search to instruments with artists info that        Restricts the search to instruments with artists info that
6221        satisfies the supplied search string (encapsulated into        satisfies the supplied search string (encapsulated into
6222        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 5818  Internet-Draft        LinuxSampler Contr Line 6240  Internet-Draft        LinuxSampler Contr
6240        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
6241        families.        families.
6242    
   
   
 Schoenebeck              Expires April 17, 2008               [Page 104]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6243     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
6244     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
6245    
# Line 5851  Internet-Draft        LinuxSampler Contr Line 6266  Internet-Draft        LinuxSampler Contr
6266        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
6267        Steinway D'"        Steinway D'"
6268    
6269    
6270    
6271    Schoenebeck               Expires April 8, 2011               [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol         October 2010
6274    
6275    
6276  6.8.21.  Getting job status information  6.8.21.  Getting job status information
6277    
6278     The front-end can ask for the current status of a particular database     The front-end can ask for the current status of a particular database
# Line 5873  Internet-Draft        LinuxSampler Contr Line 6295  Internet-Draft        LinuxSampler Contr
6295    
6296           FILES_TOTAL -           FILES_TOTAL -
6297    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 105]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
6298              The total number of files scheduled for scanning              The total number of files scheduled for scanning
6299    
6300           FILES_SCANNED -           FILES_SCANNED -
# Line 5906  Internet-Draft        LinuxSampler Contr Line 6320  Internet-Draft        LinuxSampler Contr
6320    
6321        S: "FILES_TOTAL: 12"        S: "FILES_TOTAL: 12"
6322    
6323    
6324    
6325    
6326    
6327    Schoenebeck               Expires April 8, 2011               [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol         October 2010
6330    
6331    
6332           "FILES_SCANNED: 7"           "FILES_SCANNED: 7"
6333    
6334           "SCANNING: /home/me/gigs/Bosendorfer 290.gig"           "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
# Line 5928  Internet-Draft        LinuxSampler Contr Line 6351  Internet-Draft        LinuxSampler Contr
6351    
6352           on success           on success
6353    
6354          "ERR:<error-code>:<error-message>" -
6355    
6356             If the formatting of the instruments database failed.
6357    
6358    6.8.23.  Checking for lost instrument files
6359    
6360       The front-end can retrieve the list of all instrument files in the
6361       instruments database that don't exist in the filesystem by sending
6362       the following command:
6363    
6364          FIND LOST DB_INSTRUMENT_FILES
6365    
6366       Possible Answers:
6367    
6368  Schoenebeck              Expires April 17, 2008               [Page 106]        A comma separated list with the absolute path names (encapsulated
6369          into apostrophes) of all lost instrument files.
6370    
6371          "ERR:<error-code>:<error-message>" -
6372    
6373             in case it failed, providing an appropriate error code and
6374             error message.
6375    
6376       Example:
6377    
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck               Expires April 8, 2011               [Page 114]
6384    
6385  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
6386    
6387    
6388          C: "FIND LOST DB_INSTRUMENT_FILES"
6389    
6390          S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
6391          Piano.gig'"
6392    
6393    6.8.24.  Replacing an instrument file
6394    
6395       The front-end can substitute all occurrences of an instrument file in
6396       the instruments database with a new one by sending the following
6397       command:
6398    
6399          SET DB_INSTRUMENT FILE_PATH <old_path> <new_path>
6400    
6401       Where <old_path> is the absolute path name of the instrument file to
6402       substitute with <new_path>.
6403    
6404       Possible Answers:
6405    
6406          "OK" -
6407    
6408             on success
6409    
6410        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6411    
6412           If the formatting of the instruments database failed.           in case it failed, providing an appropriate error code and
6413             error message.
6414    
6415       Example:
6416    
6417          C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig'
6418          '/gigs/pianos/Bosendorfer 290.gig'"
6419    
6420          S: "OK"
6421    
6422  6.9.  Editing Instruments  6.9.  Editing Instruments
6423    
# Line 5953  Internet-Draft        LinuxSampler Contr Line 6431  Internet-Draft        LinuxSampler Contr
6431     At the moment there is only one command for this feature set, but     At the moment there is only one command for this feature set, but
6432     this will most probably change in future.     this will most probably change in future.
6433    
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck               Expires April 8, 2011               [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol         October 2010
6442    
6443    
6444  6.9.1.  Opening an appropriate instrument editor application  6.9.1.  Opening an appropriate instrument editor application
6445    
6446     The front-end can request to open an appropriate instrument editor     The front-end can request to open an appropriate instrument editor
# Line 5984  Internet-Draft        LinuxSampler Contr Line 6472  Internet-Draft        LinuxSampler Contr
6472    
6473           when an appropriate instrument editor was launched           when an appropriate instrument editor was launched
6474    
6475          "WRN:<warning-code>:<warning-message>" -
6476    
6477             when an appropriate instrument editor was launched, but there
6478             are noteworthy issues
6479    
6480          "ERR:<error-code>:<error-message>" -
6481    
6482             when an appropriate instrument editor could not be launched
6483    
6484       Examples:
6485    
6486          C: "EDIT CHANNEL INSTRUMENT 0"
6487    
6488          S: "OK"
6489    
6490    
6491    
6492    
6493    
6494    
6495    Schoenebeck               Expires April 8, 2011               [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol         October 2010
6498    
6499    
6500    6.10.  Managing Files
6501    
6502       You can query detailed informations about files located at the same
6503       system where the sampler instance is running on.  Using this command
6504       set allows to retrieve file informations even remotely from another
6505       machine.
6506    
6507    6.10.1.  Retrieving amount of instruments of a file
6508    
6509       The front-end can retrieve the amount of instruments within a given
6510       instrument file by sending the following command:
6511    
6512          GET FILE INSTRUMENTS <filename>
6513    
6514       Where <filename> is the name of the instrument file (encapsulated
6515       into apostrophes, supporting escape sequences as described in chapter
6516       "Character Set and Escape Sequences (Section 7.1)").
6517    
6518       The sampler will try to ask all sampler engines, whether they support
6519       the given file and ask the first engine with a positive answer for
6520       the amount of instruments.
6521    
6522       Possible Answers:
6523    
6524          On success, the sampler will answer by returning the amount of
6525          instruments.
6526    
6527          "ERR:<error-code>:<error-message>" -
6528    
6529             if the file could not be handled
6530    
6531       Examples:
6532    
6533          C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6534    
6535          S: "10"
6536    
6537    6.10.2.  Retrieving all instruments of a file
6538    
6539       The front-end can retrieve a list of all instruments within a given
6540       instrument file by sending the following command:
6541    
6542          LIST FILE INSTRUMENTS <filename>
6543    
6544       Where <filename> is the name of the instrument file (encapsulated
6545       into apostrophes, supporting escape sequences as described in chapter
6546       "Character Set and Escape Sequences (Section 7.1)").
6547    
6548    
6549    
6550    
6551    Schoenebeck               Expires April 8, 2011               [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol         October 2010
6554    
6555    
6556       The sampler will try to ask all sampler engines, whether they support
6557       the given file and ask the first engine with a positive answer for a
6558       list of IDs for the instruments in the given file.
6559    
6560       Possible Answers:
6561    
6562          On success, the sampler will answer by returning a comma separated
6563          list of instrument IDs.
6564    
6565          "ERR:<error-code>:<error-message>" -
6566    
6567             if the file could not be handled
6568    
6569       Examples:
6570    
6571          C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6572    
6573          S: "0,1,2,3,4,5,6,7,8,9"
6574    
6575    6.10.3.  Retrieving informations about one instrument in a file
6576    
6577       The front-end can retrieve detailed informations about a specific
6578       instrument within a given instrument file by sending the following
6579       command:
6580    
6581          GET FILE INSTRUMENT INFO <filename> <instr-id>
6582    
6583       Where <filename> is the name of the instrument file (encapsulated
6584       into apostrophes, supporting escape sequences as described in chapter
6585       "Character Set and Escape Sequences (Section 7.1)") and <instr-id> is
6586       the numeric instrument ID as returned by the "LIST FILE INSTRUMENTS"
6587       (Section 6.10.2) command.
6588    
6589       The sampler will try to ask all sampler engines, whether they support
6590       the given file and ask the first engine with a positive answer for
6591       informations about the specific instrument in the given file.
6592    
6593       Possible Answers:
6594    
6595          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6596          answer line begins with the settings category name followed by a
6597          colon and then a space character <SP> and finally the info
6598          character string to that setting category.  At the moment the
6599          following categories are defined:
6600    
6601    
6602    
6603    
6604    
6605    
6606    
6607    Schoenebeck               Expires April 8, 2011               [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol         October 2010
6610    
6611    
6612             NAME -
6613    
6614                name of the instrument as stored in the instrument file
6615    
6616             FORMAT_FAMILY -
6617    
6618                name of the sampler format of the given instrument
6619    
6620             FORMAT_VERSION -
6621    
6622                version of the sampler format the instrumen is stored as
6623    
6624             PRODUCT -
6625    
6626                official product name of the instrument as stored in the
6627                file
6628    
6629             ARTISTS -
6630    
6631                artists / sample library vendor of the instrument
6632    
6633             KEY_BINDINGS -
6634    
6635                comma separated list of integer values representing the
6636                instrument's key mapping in the range between 0 .. 127,
6637                reflecting the analog meaning of the MIDI specification.
6638    
6639             KEYSWITCH_BINDINGS -
6640    
6641                comma separated list of integer values representing the
6642                instrument's keyswitch mapping in the range between 0 ..
6643                127, reflecting the analog meaning of the MIDI
6644                specification.
6645    
6646       The mentioned fields above don't have to be in particular order.
6647    
6648       Example:
6649    
6650          C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
6651    
6652          S: "NAME: Lunatic Loops"
6653    
6654             "FORMAT_FAMILY: GIG"
6655    
6656             "FORMAT_VERSION: 3"
6657    
6658             "PRODUCT: The Backbone Bongo Beats"
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires April 8, 2011               [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol         October 2010
6666    
6667    
6668             "ARTISTS: Jimmy the Fish"
6669    
6670             "."
6671    
6672    6.11.  Managing Effects
6673    
6674       Audio effects (e.g. reverb, delay, compression) can be applied to the
6675       audio signals generated by the sampler.  The sampler usually provides
6676       a set of internal audio effects for this task.  The exact set of
6677       effects depends on the availability of third party effect plugins
6678       installed on the system where the sampler runs on.
6679    
6680       At the moment only "send effects" are supported.  Support for "insert
6681       effects" and "master effects" is planned to be added at a later
6682       point.
6683    
6684       The following commands allow to retrieve the set of internal effects
6685       available to the sampler, detailed informations about those effects
6686       and to create and destroy instances of such effects.  After an
6687       instance of an effect is created, the effect instance can be inserted
6688       into the audio signal path of the sampler, e.g. as send effect.
6689    
6690       The sampler allows to create an arbitrary amount of so called send
6691       effect chains.  Each effect chain can host an arbitrary amount of
6692       effect instances.  The output of the first effect instance in an
6693       effect chain is fed to the input of the second effect instance of the
6694       chain and so on.  So effects in one chain are processed sequentially.
6695       Send effect chains however are processed in parallel to other send
6696       effect chains.  Audio signals of sampler channels are fed to send
6697       effects by creating FX sends to the respective sampler channel and
6698       assigning a destination send effect to that FX by using the "SET
6699       FX_SEND EFFECT" (Section 6.4.32) command.  The latter allows to route
6700       the FX send to the beginning of a send effect chain, as well as
6701       directly to any other position of the send effect chain.
6702    
6703    6.11.1.  Retrieve amount of available effects
6704    
6705       The front-end can retrieve the amount of internal effects, available
6706       to the sampler by sending the following command:
6707    
6708          GET AVAILABLE_EFFECTS
6709    
6710       Possible Answers:
6711    
6712          The sampler will answer by returning the current number of effects
6713          available to the sampler.
6714    
6715       Examples:
6716    
6717    
6718    
6719    Schoenebeck               Expires April 8, 2011               [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol         October 2010
6722    
6723    
6724          C: "GET AVAILABLE_EFFECTS"
6725    
6726          S: "129"
6727    
6728    6.11.2.  Get list of available effects
6729    
6730       The set of available internal effects can change at runtime.  The
6731       front-end can retrieve the list of internal effects, available to the
6732       sampler by sending the following command:
6733    
6734          LIST AVAILABLE_EFFECTS
6735    
6736       Possible Answers:
6737    
6738          The sampler will answer by returning a comma separated list with
6739          numerical IDs of effects.  Note: the numercial ID of an effect is
6740          generated by the sampler for the current moment.  The numerical ID
6741          of the same effect can change at runtime, e.g. when the user
6742          requests a rescan of available effect plugins.
6743    
6744       Example:
6745    
6746          C: "LIST AVAILABLE_EFFECTS"
6747    
6748          S: "5,6,7,120,121,122,123,124"
6749    
6750    6.11.3.  Retrieving general information about an effect
6751    
6752       The front-end can ask for general informations about an effect by
6753       sending the following command:
6754    
6755          GET EFFECT INFO <effect-index>
6756    
6757       Where <effect-index> is the numerical ID of an effect as returned by
6758       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
6759    
6760       Possible Answers:
6761    
6762          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6763          answer line begins with the effect information category name,
6764          followed by a colon and then a space character <SP> and finally
6765          the info character string to that effect information category.  At
6766          the moment the following categories are defined:
6767    
6768    
6769  Schoenebeck              Expires April 17, 2008               [Page 107]  
6770             SYSTEM -
6771    
6772    
6773    
6774    
6775    Schoenebeck               Expires April 8, 2011               [Page 121]
6776    
6777  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
6778    
6779    
6780                name of the effect plugin system the effect is based on
6781                (e.g.  "LADSPA")
6782    
6783             MODULE -
6784    
6785                module of the effect plugin system that contains this
6786                effect, the module is usually the dynamic-linked library
6787                (DLL) filename of the effect plugin, including full path
6788                (note that this filename may contain escape sequences
6789                (Section 7.1))
6790    
6791             NAME -
6792    
6793                character string defining the unique name of the effect
6794                within its module (note that the character string may
6795                contain escape sequences (Section 7.1))
6796    
6797             DESCRIPTION -
6798    
6799                human readable name of the effect, intended to be displayed
6800                in user interfaces (note that the character string may
6801                contain escape sequences (Section 7.1))
6802    
6803       The mentioned fields above don't have to be in particular order.
6804    
6805       Example:
6806    
6807          C: "GET EFFECT INFO 121"
6808    
6809          S: "SYSTEM: LADSPA"
6810    
6811             "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"
6812    
6813             "NAME: lowpass_iir"
6814    
6815             "DESCRIPTION: Glame Lowpass Filter"
6816    
6817             "."
6818    
6819    6.11.4.  Creating an instance of an effect by its portable ID
6820    
6821       The front-end can spawn an instance of the desired effect by sending
6822       the following command:
6823    
6824          CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name>
6825    
6826       Where <effect-system> is the "SYSTEM" field, <module> the "MODULE"
6827       field and <effect-name> the "NAME" field as returned by the "GET
6828    
6829    
6830    
6831    Schoenebeck               Expires April 8, 2011               [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol         October 2010
6834    
6835    
6836       EFFECT INFO" (Section 6.11.3) command.  The filename of argument
6837       <module> and the character string of argument <effect-name> may
6838       contain escape sequences (Section 7.1).
6839    
6840       The sampler will try to load the requested effect and to create an
6841       instance of it.  To allow loading the same effect on a different
6842       machine, probably even running a completely different operating
6843       system (e.g.  Linux vs. Windows), the sampler tries to match <module>
6844       "softly".  That means it first tries to find an effect that exactly
6845       matches the given <module> argument.  If there is no exact match, the
6846       sampler will try to lower the restrictions on matching the <module>
6847       argument more and more, e.g. by ignoring upper / lower case
6848       differences and by ignoring the path of the DLL filename and file
6849       extension.  If there is still no match at the end, the sampler will
6850       try to ignore the <module> argument completely and as a last resort
6851       search for an effect that only matches the given <effect-system> and
6852       <effect-name> arguments.
6853    
6854       Possible Answers:
6855    
6856          "OK[<effect-instance>]" -
6857    
6858             in case the effect instance was successfully created, where
6859             <effect-instance> is the numerical ID of the new effect
6860             instance
6861    
6862        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
6863    
6864           when an appropriate instrument editor was launched, but there           in case the effect instance was spawned successfully, but there
6865           are noteworthy issues           are noteworthy issue(s) related, providing an appropriate
6866             warning code and warning message
6867    
6868        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6869    
6870           when an appropriate instrument editor could not be launched           if the effect could not be instantiated
6871    
6872     Examples:     Examples:
6873    
6874        C: "EDIT CHANNEL INSTRUMENT 0"        C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/
6875          mod_delay_1419.so' 'modDelay'"
6876    
6877          S: "OK[0]"
6878    
6879    6.11.5.  Creating an instance of an effect by its numerical ID
6880    
6881       The front-end can spawn an instance of the desired effect by sending
6882       the following command:
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires April 8, 2011               [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol         October 2010
6890    
6891    
6892          CREATE EFFECT_INSTANCE <effect-index>
6893    
6894       Where <effect-index> is the numerical ID of the effect as returned by
6895       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
6896    
6897       The sampler will try to load the requested effect and to create an
6898       instance of it.
6899    
6900       Note: Since the numerical ID of a certain effect can change at any
6901       time, you should not use this command in LSCP files to restore a
6902       certain effect at a later time!  To store a sampler session including
6903       all its effects, use the portable text-based version of "CREATE
6904       EFFECT_INSTANCE" (Section 6.11.4) instead!  This allows to restore a
6905       sampler session with all its effects also on other machines, possibly
6906       even running a completely different operating system (e.g.  Linux vs.
6907       Windows), with different plugin directories or plugin DLL names.
6908    
6909       Possible Answers:
6910    
6911          "OK[<effect-instance>]" -
6912    
6913             in case the effect instance was successfully created, where
6914             <effect-instance> is the numerical ID of the new effect
6915             instance
6916    
6917          "WRN:<warning-code>:<warning-message>" -
6918    
6919             in case the effect instance was spawned successfully, but there
6920             are noteworthy issue(s) related, providing an appropriate
6921             warning code and warning message
6922    
6923          "ERR:<error-code>:<error-message>" -
6924    
6925             if the effect could not be instantiated
6926    
6927       Examples:
6928    
6929          C: "CREATE EFFECT_INSTANCE 72"
6930    
6931          S: "OK[5]"
6932    
6933    6.11.6.  Destroy an effect instance
6934    
6935       The front-end can destroy an unusued effect instance and thus freeing
6936       it from memory by sending the following command:
6937    
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck               Expires April 8, 2011               [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol         October 2010
6946    
6947    
6948          DESTROY EFFECT_INSTANCE <effect-instance>
6949    
6950       Where <effect-instance> is the numerical ID of the effect instance as
6951       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
6952       EFFECT_INSTANCES" (Section 6.11.8) command.
6953    
6954       The effect instance can only be destroyed if it's not used in any
6955       part of the sampler's audio signal path anymore.  If the effect
6956       instance is still in use somewhere, trying to destroy the effect
6957       instance will result in an error message.
6958    
6959       Possible Answers:
6960    
6961          "OK" -
6962    
6963             in case the effect instance was successfully destroyed
6964    
6965          "ERR:<error-code>:<error-message>" -
6966    
6967             in case it failed, providing an appropriate error code and
6968             error message
6969    
6970       Examples:
6971    
6972          C: "DESTROY EFFECT_INSTANCE 5"
6973    
6974          S: "OK"
6975    
6976    6.11.7.  Retrieve amount of effect instances
6977    
6978       The front-end can retrieve the current amount of effect instances by
6979       sending the following command:
6980    
6981          GET EFFECT_INSTANCES
6982    
6983       Possible Answers:
6984    
6985          The sampler will answer by returning the current number of effect
6986          instances created and not yet destroyed in the current sampler
6987          session.
6988    
6989       Examples:
6990    
6991          C: "GET EFFECT_INSTANCES"
6992    
6993          S: "14"
6994    
6995    
6996    
6997    
6998    
6999    Schoenebeck               Expires April 8, 2011               [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol         October 2010
7002    
7003    
7004    6.11.8.  Get list of effect instances
7005    
7006       The front-end can retrieve the current list of effect instances by
7007       sending the following command:
7008    
7009          LIST EFFECT_INSTANCES
7010    
7011       Possible Answers:
7012    
7013          The sampler will answer by returning a comma separated list with
7014          numerical IDs of effects instances.
7015    
7016       Example:
7017    
7018          C: "LIST EFFECT_INSTANCES"
7019    
7020          S: "9,11,14,15,16,17,25"
7021    
7022    6.11.9.  Retrieving current information about an effect instance
7023    
7024       The front-end can ask for the current informations about a particular
7025       effect instance by sending the following command:
7026    
7027          GET EFFECT_INSTANCE INFO <effect-instance>
7028    
7029       Where <effect-instance> is the numerical ID of an effect instance as
7030       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7031       EFFECT_INSTANCES" (Section 6.11.8) command.
7032    
7033       Possible Answers:
7034    
7035          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7036          answer line begins with the information category name, followed by
7037          a colon and then a space character <SP> and finally the info
7038          character string to that information category.  At the moment the
7039          following categories are defined:
7040    
7041    
7042    
7043             SYSTEM -
7044    
7045                name of the effect plugin system the effect is based on
7046                (e.g.  "LADSPA")
7047    
7048             MODULE -
7049    
7050                module of the effect plugin system that contains this
7051                effect, the module is usually the dynamic-linked library
7052    
7053    
7054    
7055    Schoenebeck               Expires April 8, 2011               [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol         October 2010
7058    
7059    
7060                (DLL) filename of the effect plugin, including full path
7061                (note that this filename may contain escape sequences
7062                (Section 7.1))
7063    
7064             NAME -
7065    
7066                character string defining the unique name of the effect
7067                within its module (note that the character string may
7068                contain escape sequences (Section 7.1))
7069    
7070             DESCRIPTION -
7071    
7072                human readable name of the effect, intended to be displayed
7073                in user interfaces (note that the character string may
7074                contain escape sequences (Section 7.1))
7075    
7076             INPUT_CONTROLS -
7077    
7078                amount of input controls the effect instance provides, to
7079                allow controlling the effect parameters in realtime
7080    
7081       The mentioned fields above don't have to be in particular order.
7082    
7083       Example:
7084    
7085          C: "GET EFFECT_INSTANCE INFO 3"
7086    
7087          S: "SYSTEM: LADSPA"
7088    
7089             "MODULE: /usr/lib/ladspa/mod_delay_1419.so"
7090    
7091             "NAME: modDelay"
7092    
7093             "DESCRIPTION: Modulatable delay"
7094    
7095             "INPUT_CONTROLS: 1"
7096    
7097             "."
7098    
7099    6.11.10.  Retrieving information about an effect parameter
7100    
7101       Effects typically provide a certain set of effect parameters which
7102       can be altered by the user in realtime (e.g. depth of a reverb
7103       effect, duration of a delay effect, dry / wet signal ratio).  Those
7104       controllable effect parameters are called "input controls".  The
7105       front-end can ask for the current informations of an effect
7106       instance's input control by sending the following command:
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires April 8, 2011               [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol         October 2010
7114    
7115    
7116          GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-
7117          control>
7118    
7119       Where <effect-instance> is the numerical ID of an effect instance as
7120       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7121       EFFECT_INSTANCES" (Section 6.11.8) command and <input-control> is the
7122       index of the input control within the numerical bounds as returned by
7123       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7124       (Section 6.11.9) command.
7125    
7126       Possible Answers:
7127    
7128          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7129          answer line begins with the information category name, followed by
7130          a colon and then a space character <SP> and finally the info
7131          character string to that information category.  There are
7132          information categories which are always returned, independent of
7133          the respective effect parameter and there are optional information
7134          categories which are only shown for certain effect parameters.  At
7135          the moment the following categories are defined:
7136    
7137    
7138    
7139             DESCRIPTION -
7140    
7141                (always returned) human readable name of the effect
7142                parameter, intended to be displayed in user interfaces (note
7143                that the character string may contain escape sequences
7144                (Section 7.1))
7145    
7146             VALUE -
7147    
7148                (always returned) current (optional dotted) floating point
7149                value of this effect parameter
7150    
7151             RANGE_MIN -
7152    
7153                (optionally returned) minimum allowed value for this effect
7154                parameter
7155    
7156             RANGE_MAX -
7157    
7158                (optionally returned) maximum allowed value for this effect
7159                parameter
7160    
7161             POSSIBILITIES -
7162    
7163    
7164    
7165    
7166    
7167    Schoenebeck               Expires April 8, 2011               [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol         October 2010
7170    
7171    
7172                (optionally returned) comma separated list of (optional
7173                dotted) floating point numbers, reflecting the exact set of
7174                possible values for this effect parameter
7175    
7176             DEFAULT -
7177    
7178                (optionally returned) default value of this effect parameter
7179    
7180       The mentioned fields above don't have to be in particular order.
7181    
7182       Example:
7183    
7184          C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"
7185    
7186          S: "SYSTEM: LADSPA"
7187    
7188             "DESCRIPTION: Base delay (s)"
7189    
7190             "VALUE: 0.500"
7191    
7192             "RANGE_MIN: 0.000"
7193    
7194             "."
7195    
7196    6.11.11.  Altering an effect parameter
7197    
7198       The front-end can alter the current value of an effect parameter by
7199       sending the following command:
7200    
7201          SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-
7202          control> <value>
7203    
7204       Where <effect-instance> is the numerical ID of the effect instance as
7205       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7206       EFFECT_INSTANCES" (Section 6.11.8) command, <input-control> is the
7207       index of the input control within the numerical bounds as returned by
7208       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7209       (Section 6.11.9) command and <value> is the new (optional dotted)
7210       floating point value for this effect parameter.
7211    
7212       Possible Answers:
7213    
7214          "OK" -
7215    
7216             in case the effect was altered successfully
7217    
7218    
7219    
7220    
7221    
7222    
7223    Schoenebeck               Expires April 8, 2011               [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol         October 2010
7226    
7227    
7228          "ERR:<error-code>:<error-message>" -
7229    
7230             in case it failed, providing an appropriate error code and
7231             error message
7232    
7233       Examples:
7234    
7235          C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"
7236    
7237          S: "OK"
7238    
7239    6.11.12.  Retrieve amount of send effect chains
7240    
7241       The front-end can retrieve the current amount of send effect chains
7242       of an audio output device by sending the following command:
7243    
7244          GET SEND_EFFECT_CHAINS <audio-device>
7245    
7246       Where <audio-device> should be replaced by the numerical ID of the
7247       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7248       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7249       command.
7250    
7251       Possible Answers:
7252    
7253          The sampler will answer by returning the current number of send
7254          effect chains of the supplied audio output device.
7255    
7256       Examples:
7257    
7258          C: "GET SEND_EFFECT_CHAINS 0"
7259    
7260          S: "4"
7261    
7262    6.11.13.  Retrieve list of send effect chains
7263    
7264       The front-end can retrieve the current list of send effect chains of
7265       an audio output device by sending the following command:
7266    
7267          LIST SEND_EFFECT_CHAINS <audio-device>
7268    
7269       Where <audio-device> should be replaced by the numerical ID of the
7270       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7271       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7272       command.
7273    
7274       Possible Answers:
7275    
7276    
7277    
7278    
7279    Schoenebeck               Expires April 8, 2011               [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol         October 2010
7282    
7283    
7284          The sampler will answer by returning a comma separated list with
7285          numerical IDs of send effect chains of the supplied audio output
7286          device.
7287    
7288       Examples:
7289    
7290          C: "LIST SEND_EFFECT_CHAINS 0"
7291    
7292          S: "3,4,7"
7293    
7294    6.11.14.  Add send effect chain
7295    
7296       The front-end can add a send effect chain by sending the following
7297       command:
7298    
7299          ADD SEND_EFFECT_CHAIN <audio-device>
7300    
7301       Where <audio-device> should be replaced by the numerical ID of the
7302       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7303       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7304       command.
7305    
7306       Possible Answers:
7307    
7308          "OK[<effect-chain>]" -
7309    
7310             in case the send effect chain was added successfully, where
7311             <effect-chain> is the numerical ID of the new send effect chain
7312    
7313          "ERR:<error-code>:<error-message>" -
7314    
7315             if the send effect chain could not be added
7316    
7317       Examples:
7318    
7319          C: "ADD SEND_EFFECT_CHAIN 0"
7320    
7321          S: "OK[2]"
7322    
7323    6.11.15.  Remove send effect chain
7324    
7325       The front-end can remove a send effect chain by sending the following
7326       command:
7327    
7328          REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain>
7329    
7330       Where <audio-device> should be replaced by the numerical ID of the
7331       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7332    
7333    
7334    
7335    Schoenebeck               Expires April 8, 2011               [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol         October 2010
7338    
7339    
7340       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7341       command and <effect-chain> by the numerical ID as returned by the
7342       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7343       SEND_EFFECT_CHAINS" (Section 6.11.13) command.
7344    
7345       Possible Answers:
7346    
7347          "OK" -
7348    
7349             in case the send effect chain was removed successfully
7350    
7351          "ERR:<error-code>:<error-message>" -
7352    
7353             if the send effect chain could not be removed
7354    
7355       Examples:
7356    
7357          C: "REMOVE SEND_EFFECT_CHAIN 0 2"
7358    
7359          S: "OK"
7360    
7361    6.11.16.  Retrieving information about a send effect chain
7362    
7363       The front-end can ask for informations of a send effect chain by
7364       sending the following command:
7365    
7366          GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain>
7367    
7368       Where <audio-device> should be replaced by the numerical ID of the
7369       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7370       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7371       command and <effect-chain> by the numerical ID as returned by the
7372       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7373       SEND_EFFECT_CHAINS" (Section 6.11.13) command.
7374    
7375       Possible Answers:
7376    
7377          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7378          answer line begins with the information category name, followed by
7379          a colon and then a space character <SP> and finally the info
7380          character string to that information category.  At the moment the
7381          following categories are defined:
7382    
7383    
7384    
7385             EFFECT_COUNT -
7386    
7387    
7388    
7389    
7390    
7391    Schoenebeck               Expires April 8, 2011               [Page 132]
7392    
7393    Internet-Draft        LinuxSampler Control Protocol         October 2010
7394    
7395    
7396                amount of effects in this send effect chain
7397    
7398             EFFECT_SEQUENCE -
7399    
7400                comma separated list of the numerical IDs of the effect
7401                instances in this send effect chain, in the order as they
7402                are procssed in the effect chain
7403    
7404       The mentioned fields above don't have to be in particular order.
7405    
7406       Example:
7407    
7408          C: "GET SEND_EFFECT_CHAIN INFO 0 2"
7409    
7410          S: "EFFECT_COUNT: 3"
7411    
7412             "EFFECT_SEQUENCE: 31,4,7"
7413    
7414             "."
7415    
7416    6.11.17.  Append effect instance to a send effect chain
7417    
7418       The front-end can add an unused effect instance to the end of a send
7419       effect chain by sending the following command:
7420    
7421          APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7422          <effect-instance>
7423    
7424       Where <audio-device> should be replaced by the numerical ID of the
7425       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7426       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7427       command and <effect-chain> by the numerical ID as returned by the
7428       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7429       SEND_EFFECT_CHAINS" (Section 6.11.13) command and <effect-instance>
7430       as returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7431       EFFECT_INSTANCES" (Section 6.11.8) command.
7432    
7433       Only unused effect instances can be added to the effect chain.
7434       Trying to add an effect instance which is already in use somewhere in
7435       the audio signal path of the sampler will result in an error.
7436    
7437       Possible Answers:
7438    
7439          "OK" -
7440    
7441             in case the effect instance was added successfully to the chain
7442    
7443    
7444    
7445    
7446    
7447    Schoenebeck               Expires April 8, 2011               [Page 133]
7448    
7449    Internet-Draft        LinuxSampler Control Protocol         October 2010
7450    
7451    
7452          "ERR:<error-code>:<error-message>" -
7453    
7454             if the effect instance could not be added
7455    
7456       Examples:
7457    
7458          C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"
7459    
7460        S: "OK"        S: "OK"
7461    
7462    6.11.18.  Insert effect instance to a send effect chain
7463    
7464       The front-end can add an unused effect instance to a certain position
7465       of a send effect chain by sending the following command:
7466    
7467          INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7468          <chain-pos> <effect-instance>
7469    
7470       Where <audio-device> should be replaced by the numerical ID of the
7471       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7472       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7473       command, <effect-chain> by the numerical ID as returned by the "ADD
7474       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7475       (Section 6.11.13) command, <effect-instance> as returned by the
7476       "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST EFFECT_INSTANCES"
7477       (Section 6.11.8) command and <chain-pos> the exact position of the
7478       effect chain where the supplied effect shall be inserted to.
7479    
7480       Only unused effect instances can be added to the effect chain.
7481       Trying to add an effect instance which is already in use somewhere in
7482       the audio signal path of the sampler will result in an error.
7483    
7484       Possible Answers:
7485    
7486          "OK" -
7487    
7488             in case the effect instance was added successfully to the chain
7489    
7490          "ERR:<error-code>:<error-message>" -
7491    
7492             if the effect instance could not be added
7493    
7494       Examples:
7495    
7496          C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"
7497    
7498          S: "OK"
7499    
7500    
7501    
7502    
7503    Schoenebeck               Expires April 8, 2011               [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol         October 2010
7506    
7507    
7508    6.11.19.  Remove effect instance from send effect chain
7509    
7510       The front-end can remove an effect instance from a certain position
7511       of a send effect chain by sending the following command:
7512    
7513          REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7514          <chain-pos>
7515    
7516       Where <audio-device> should be replaced by the numerical ID of the
7517       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7518       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7519       command, <effect-chain> by the numerical ID as returned by the "ADD
7520       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7521       (Section 6.11.13) command and <chain-pos> the exact position of the
7522       effect instance to be removed from the effect chain.
7523    
7524       Possible Answers:
7525    
7526          "OK" -
7527    
7528             in case the effect instance was removed successfully
7529    
7530          "ERR:<error-code>:<error-message>" -
7531    
7532             if the effect instance could not be removed
7533    
7534       Examples:
7535    
7536          C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"
7537    
7538          S: "OK"
7539    
7540    
7541    
# Line 6044  Internet-Draft        LinuxSampler Contr Line 7553  Internet-Draft        LinuxSampler Contr
7553    
7554    
7555    
7556  Schoenebeck              Expires April 17, 2008               [Page 108]  
7557    
7558    
7559    Schoenebeck               Expires April 8, 2011               [Page 135]
7560    
7561  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
7562    
7563    
7564  7.  Command Syntax  7.  Command Syntax
# Line 6100  Internet-Draft        LinuxSampler Contr Line 7612  Internet-Draft        LinuxSampler Contr
7612    
7613    
7614    
7615  Schoenebeck              Expires April 17, 2008               [Page 109]  Schoenebeck               Expires April 8, 2011               [Page 136]
7616    
7617  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
7618    
7619    
7620        / LIST SP list_instruction        / LIST SP list_instruction
# Line 6131  Internet-Draft        LinuxSampler Contr Line 7643  Internet-Draft        LinuxSampler Contr
7643    
7644        / FORMAT SP format_instruction        / FORMAT SP format_instruction
7645    
7646          / SEND SP send_instruction
7647    
7648          / APPEND SP append_instruction
7649    
7650          / INSERT SP insert_instruction
7651    
7652        / RESET        / RESET
7653    
7654        / QUIT        / QUIT
# Line 6143  Internet-Draft        LinuxSampler Contr Line 7661  Internet-Draft        LinuxSampler Contr
7661    
7662        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
7663    
7664        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP
7665          db_path SP filename
7666    
       / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename  
7667    
       / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP  
       instrument_index  
7668    
       / DB_INSTRUMENTS SP db_path SP filename  
7669    
7670    
7671    Schoenebeck               Expires April 8, 2011               [Page 137]
7672    
7673    Internet-Draft        LinuxSampler Control Protocol         October 2010
7674    
7675    
7676          / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
7677    
7678  Schoenebeck              Expires April 17, 2008               [Page 110]        / DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP
7679          filename
7680  Internet-Draft        LinuxSampler Control Protocol         October 2007  
7681          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
7682    
7683          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
7684          instrument_index
7685    
7686          / DB_INSTRUMENTS SP db_path SP filename
7687    
7688        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index        / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
7689    
# Line 6167  Internet-Draft        LinuxSampler Contr Line 7691  Internet-Draft        LinuxSampler Contr
7691    
7692        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
7693    
7694          / SEND_EFFECT_CHAIN SP device_index
7695    
7696     subscribe_event =     subscribe_event =
7697    
7698        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
# Line 6179  Internet-Draft        LinuxSampler Contr Line 7705  Internet-Draft        LinuxSampler Contr
7705    
7706        / CHANNEL_COUNT        / CHANNEL_COUNT
7707    
7708          / CHANNEL_MIDI
7709    
7710          / DEVICE_MIDI
7711    
7712        / VOICE_COUNT        / VOICE_COUNT
7713    
7714        / STREAM_COUNT        / STREAM_COUNT
# Line 6191  Internet-Draft        LinuxSampler Contr Line 7721  Internet-Draft        LinuxSampler Contr
7721    
7722        / FX_SEND_INFO        / FX_SEND_INFO
7723    
7724    
7725    
7726    
7727    Schoenebeck               Expires April 8, 2011               [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol         October 2010
7730    
7731    
7732        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
7733    
7734        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
# Line 6209  Internet-Draft        LinuxSampler Contr Line 7747  Internet-Draft        LinuxSampler Contr
7747    
7748        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
7749    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 111]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
7750        / MISCELLANEOUS        / MISCELLANEOUS
7751    
7752          / TOTAL_STREAM_COUNT
7753    
7754        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
7755    
7756        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6235  Internet-Draft        LinuxSampler Contr Line 7767  Internet-Draft        LinuxSampler Contr
7767    
7768        / CHANNEL_COUNT        / CHANNEL_COUNT
7769    
7770          / CHANNEL_MIDI
7771    
7772          / DEVICE_MIDI
7773    
7774        / VOICE_COUNT        / VOICE_COUNT
7775    
7776        / STREAM_COUNT        / STREAM_COUNT
7777    
7778        / BUFFER_FILL        / BUFFER_FILL
7779    
7780    
7781    
7782    
7783    Schoenebeck               Expires April 8, 2011               [Page 139]
7784    
7785    Internet-Draft        LinuxSampler Control Protocol         October 2010
7786    
7787    
7788        / CHANNEL_INFO        / CHANNEL_INFO
7789    
7790        / FX_SEND_COUNT        / FX_SEND_COUNT
# Line 6265  Internet-Draft        LinuxSampler Contr Line 7809  Internet-Draft        LinuxSampler Contr
7809    
7810        / DB_INSTRUMENTS_JOB_INFO        / DB_INSTRUMENTS_JOB_INFO
7811    
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 112]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
7812        / MISCELLANEOUS        / MISCELLANEOUS
7813    
7814          / TOTAL_STREAM_COUNT
7815    
7816        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
7817    
7818        / GLOBAL_INFO        / GLOBAL_INFO
# Line 6296  Internet-Draft        LinuxSampler Contr Line 7834  Internet-Draft        LinuxSampler Contr
7834        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
7835        instr_load_mode SP entry_name        instr_load_mode SP entry_name
7836    
7837    
7838    
7839    Schoenebeck               Expires April 8, 2011               [Page 140]
7840    
7841    Internet-Draft        LinuxSampler Control Protocol         October 2010
7842    
7843    
7844     unmap_instruction =     unmap_instruction =
7845    
7846        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
# Line 6308  Internet-Draft        LinuxSampler Contr Line 7853  Internet-Draft        LinuxSampler Contr
7853    
7854        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
7855    
7856          / SEND_EFFECT_CHAIN SP device_index SP effect_chain
7857    
7858          / SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
7859          chain_pos
7860    
7861          / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
7862    
7863        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
7864    
7865        / DB_INSTRUMENT_DIRECTORY SP db_path        / DB_INSTRUMENT_DIRECTORY SP db_path
# Line 6318  Internet-Draft        LinuxSampler Contr Line 7870  Internet-Draft        LinuxSampler Contr
7870    
7871        AVAILABLE_ENGINES        AVAILABLE_ENGINES
7872    
7873        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_EFFECTS
7874    
7875          / EFFECT_INSTANCES
7876    
7877          / EFFECT SP INFO SP effect_index
7878    
7879          / EFFECT_INSTANCE SP INFO SP effect_instance
7880    
7881          / EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP
7882          input_control
7883    
7884  Schoenebeck              Expires April 17, 2008               [Page 113]        / SEND_EFFECT_CHAINS SP device_index
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
7885    
7886          / SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
7887    
7888          / AVAILABLE_MIDI_INPUT_DRIVERS
7889    
7890        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
7891    
7892    
7893    
7894    
7895    Schoenebeck               Expires April 8, 2011               [Page 141]
7896    
7897    Internet-Draft        LinuxSampler Control Protocol         October 2010
7898    
7899    
7900        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
7901    
7902        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
# Line 6376  Internet-Draft        LinuxSampler Contr Line 7942  Internet-Draft        LinuxSampler Contr
7942    
7943        / SERVER SP INFO        / SERVER SP INFO
7944    
7945          / TOTAL_STREAM_COUNT
7946    
7947    
7948    
7949    
7950  Schoenebeck              Expires April 17, 2008               [Page 114]  
7951    Schoenebeck               Expires April 8, 2011               [Page 142]
7952    
7953  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
7954    
7955    
7956        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
# Line 6419  Internet-Draft        LinuxSampler Contr Line 7987  Internet-Draft        LinuxSampler Contr
7987    
7988        / VOLUME        / VOLUME
7989    
7990          / VOICES
7991    
7992          / STREAMS
7993    
7994          / FILE SP INSTRUMENTS SP filename
7995    
7996          / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
7997    
7998     set_instruction =     set_instruction =
7999    
8000        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
8001        param_val_list        param_val_list
8002    
       / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='  
       param_val_list  
8003    
       / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='  
       param_val_list  
8004    
       / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE  
8005    
8006    
8007    Schoenebeck               Expires April 8, 2011               [Page 143]
8008    
8009    Internet-Draft        LinuxSampler Control Protocol         October 2010
8010    
8011    
8012          / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='
8013          param_val_list
8014    
8015  Schoenebeck              Expires April 17, 2008               [Page 115]        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
8016          param_val_list
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
8017    
8018          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
8019    
8020        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
8021        param_val_list        param_val_list
8022    
8023          / EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP
8024          input_control SP control_value
8025    
8026        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
8027    
8028        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
# Line 6459  Internet-Draft        LinuxSampler Contr Line 8038  Internet-Draft        LinuxSampler Contr
8038        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
8039        volume_value        volume_value
8040    
8041          / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP
8042          effect_chain SP chain_pos
8043    
8044        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
8045    
8046        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP        / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
# Line 6468  Internet-Draft        LinuxSampler Contr Line 8050  Internet-Draft        LinuxSampler Contr
8050    
8051        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped        / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
8052    
8053          / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
8054    
8055        / ECHO SP boolean        / ECHO SP boolean
8056    
8057        / VOLUME SP volume_value        / VOLUME SP volume_value
8058    
8059    
8060    
8061    
8062    
8063    Schoenebeck               Expires April 8, 2011               [Page 144]
8064    
8065    Internet-Draft        LinuxSampler Control Protocol         October 2010
8066    
8067    
8068          / VOICES SP number
8069    
8070          / STREAMS SP number
8071    
8072     create_instruction =     create_instruction =
8073    
8074        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 6486  Internet-Draft        LinuxSampler Contr Line 8083  Internet-Draft        LinuxSampler Contr
8083    
8084        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
8085    
8086     reset_instruction =        / EFFECT_INSTANCE SP effect_index
   
   
   
8087    
8088          / EFFECT_INSTANCE SP effect_system SP module SP effect_name
8089    
8090  Schoenebeck              Expires April 17, 2008               [Page 116]     reset_instruction =
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
8091    
8092        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
8093    
# Line 6516  Internet-Draft        LinuxSampler Contr Line 8108  Internet-Draft        LinuxSampler Contr
8108    
8109        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list        / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
8110    
8111          / LOST SP DB_INSTRUMENT_FILES
8112    
8113     move_instruction =     move_instruction =
8114    
8115    
8116    
8117    
8118    
8119    Schoenebeck               Expires April 8, 2011               [Page 145]
8120    
8121    Internet-Draft        LinuxSampler Control Protocol         October 2010
8122    
8123    
8124        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8125    
8126        / DB_INSTRUMENT SP db_path SP db_path        / DB_INSTRUMENT SP db_path SP db_path
# Line 6536  Internet-Draft        LinuxSampler Contr Line 8139  Internet-Draft        LinuxSampler Contr
8139    
8140        / FX_SEND SP sampler_channel SP fx_send_id        / FX_SEND SP sampler_channel SP fx_send_id
8141    
8142          / EFFECT_INSTANCE SP number
8143    
8144     load_instruction =     load_instruction =
8145    
8146        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
8147    
8148        / ENGINE SP load_engine_args        / ENGINE SP load_engine_args
8149    
8150     set_chan_instruction =     append_instruction =
   
8151    
8152          SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8153          effect_instance
8154    
8155       insert_instruction =
8156    
8157          SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8158          chain_pos SP effect_instance
8159    
8160  Schoenebeck              Expires April 17, 2008               [Page 117]     set_chan_instruction =
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
8161    
8162        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
8163    
# Line 6563  Internet-Draft        LinuxSampler Contr Line 8169  Internet-Draft        LinuxSampler Contr
8169        / MIDI_INPUT SP sampler_channel SP device_index SP        / MIDI_INPUT SP sampler_channel SP device_index SP
8170        midi_input_port_index SP midi_input_channel_index        midi_input_port_index SP midi_input_channel_index
8171    
8172    
8173    
8174    
8175    Schoenebeck               Expires April 8, 2011               [Page 146]
8176    
8177    Internet-Draft        LinuxSampler Control Protocol         October 2010
8178    
8179    
8180        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index        / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
8181    
8182        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index        / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
# Line 6600  Internet-Draft        LinuxSampler Contr Line 8214  Internet-Draft        LinuxSampler Contr
8214    
8215     key_val_list =     key_val_list =
8216    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 118]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
8217        string '=' param_val_list        string '=' param_val_list
8218    
8219        / key_val_list SP string '=' param_val_list        / key_val_list SP string '=' param_val_list
# Line 6621  Internet-Draft        LinuxSampler Contr Line 8226  Internet-Draft        LinuxSampler Contr
8226    
8227     list_instruction =     list_instruction =
8228    
8229    
8230    
8231    Schoenebeck               Expires April 8, 2011               [Page 147]
8232    
8233    Internet-Draft        LinuxSampler Control Protocol         October 2010
8234    
8235    
8236        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
8237    
8238        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 6629  Internet-Draft        LinuxSampler Contr Line 8241  Internet-Draft        LinuxSampler Contr
8241    
8242        / AVAILABLE_ENGINES        / AVAILABLE_ENGINES
8243    
8244          / AVAILABLE_EFFECTS
8245    
8246          / EFFECT_INSTANCES
8247    
8248          / SEND_EFFECT_CHAINS SP number
8249    
8250        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
8251    
8252        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 6649  Internet-Draft        LinuxSampler Contr Line 8267  Internet-Draft        LinuxSampler Contr
8267    
8268        / DB_INSTRUMENTS SP db_path        / DB_INSTRUMENTS SP db_path
8269    
8270          / FILE SP INSTRUMENTS SP filename
8271    
8272       send_instruction =
8273    
8274          CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP
8275          number
8276    
8277     load_instr_args =     load_instr_args =
8278    
8279        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 6659  Internet-Draft        LinuxSampler Contr Line 8284  Internet-Draft        LinuxSampler Contr
8284    
8285    
8286    
8287    Schoenebeck               Expires April 8, 2011               [Page 148]
 Schoenebeck              Expires April 17, 2008               [Page 119]  
8288    
8289  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
8290    
8291    
8292        engine_name SP sampler_channel        engine_name SP sampler_channel
# Line 6675  Internet-Draft        LinuxSampler Contr Line 8299  Internet-Draft        LinuxSampler Contr
8299    
8300        / PERSISTENT        / PERSISTENT
8301    
8302       effect_instance =
8303    
8304          number
8305    
8306     device_index =     device_index =
8307    
8308        number        number
# Line 6709  Internet-Draft        LinuxSampler Contr Line 8337  Internet-Draft        LinuxSampler Contr
8337    
8338        number        number
8339    
    midi_prog =  
8340    
       number  
8341    
8342    
8343    Schoenebeck               Expires April 8, 2011               [Page 149]
8344    
8345    Internet-Draft        LinuxSampler Control Protocol         October 2010
8346    
8347    
8348  Schoenebeck              Expires April 17, 2008               [Page 120]     midi_prog =
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
8349    
8350          number
8351    
8352     midi_ctrl =     midi_ctrl =
8353    
# Line 6731  Internet-Draft        LinuxSampler Contr Line 8359  Internet-Draft        LinuxSampler Contr
8359    
8360        / number        / number
8361    
8362       control_value =
8363    
8364          real
8365    
8366     sampler_channel =     sampler_channel =
8367    
8368        number        number
# Line 6761  Internet-Draft        LinuxSampler Contr Line 8393  Internet-Draft        LinuxSampler Contr
8393    
8394     entry_name =     entry_name =
8395    
8396    
8397    
8398    
8399    Schoenebeck               Expires April 8, 2011               [Page 150]
8400    
8401    Internet-Draft        LinuxSampler Control Protocol         October 2010
8402    
8403    
8404        stringval_escaped        stringval_escaped
8405    
8406     fx_send_name =     fx_send_name =
8407    
8408        stringval_escaped        stringval_escaped
8409    
8410     param_val_list =     effect_name =
8411    
8412          stringval_escaped
8413    
8414       effect_index =
8415    
8416          number
8417    
8418       effect_chain =
8419    
8420  Schoenebeck              Expires April 17, 2008               [Page 121]        number
8421    
8422  Internet-Draft        LinuxSampler Control Protocol         October 2007     chain_pos =
8423    
8424          number
8425    
8426       input_control =
8427    
8428          number
8429    
8430       param_val_list =
8431    
8432        param_val        param_val
8433    
# Line 6797  Internet-Draft        LinuxSampler Contr Line 8449  Internet-Draft        LinuxSampler Contr
8449    
8450        / query_val_list SP string '=' query_val        / query_val_list SP string '=' query_val
8451    
8452    
8453    
8454    
8455    Schoenebeck               Expires April 8, 2011               [Page 151]
8456    
8457    Internet-Draft        LinuxSampler Control Protocol         October 2010
8458    
8459    
8460     query_val =     query_val =
8461    
8462        text_escaped        text_escaped
# Line 6811  Internet-Draft        LinuxSampler Contr Line 8471  Internet-Draft        LinuxSampler Contr
8471    
8472        / FLAT        / FLAT
8473    
8474       effect_system =
8475    
8476          string
8477    
8478       module =
8479    
8480          filename
8481    
8482  7.1.  Character Set and Escape Sequences  7.1.  Character Set and Escape Sequences
8483    
8484     Older versions of this protocol up to and including v1.1 only     Older versions of this protocol up to and including v1.1 only
# Line 6828  Internet-Draft        LinuxSampler Contr Line 8496  Internet-Draft        LinuxSampler Contr
8496    
8497    
8498    
8499  Schoenebeck              Expires April 17, 2008               [Page 122]  
8500    
8501    
8502    
8503    
8504    
8505    
8506    
8507    
8508    
8509    
8510    
8511    Schoenebeck               Expires April 8, 2011               [Page 152]
8512    
8513  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
8514    
8515    
8516     +------------------------+------------------------------------------+     +------------------------+------------------------------------------+
# Line 6884  Internet-Draft        LinuxSampler Contr Line 8564  Internet-Draft        LinuxSampler Contr
8564    
8565    
8566    
8567  Schoenebeck              Expires April 17, 2008               [Page 123]  Schoenebeck               Expires April 8, 2011               [Page 153]
8568    
8569  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
8570    
8571    
8572        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)        "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
# Line 6929  Internet-Draft        LinuxSampler Contr Line 8609  Internet-Draft        LinuxSampler Contr
8609    
8610        "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)        "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
8611    
8612          "FIND LOST DB_INSTRUMENT_FILES" (Section 6.8.23)
8613    
8614          "SET DB_INSTRUMENT FILE_PATH" (Section 6.8.24)
8615    
8616          "GET FILE INSTRUMENTS" (Section 6.10.1)
8617    
8618          "LIST FILE INSTRUMENTS" (Section 6.10.2)
8619    
8620    
8621    
8622    
8623    Schoenebeck               Expires April 8, 2011               [Page 154]
8624    
8625    Internet-Draft        LinuxSampler Control Protocol         October 2010
8626    
8627    
8628          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
8629    
8630          "GET EFFECT INFO" (Section 6.11.3)
8631    
8632          "GET EFFECT_INSTANCE INFO" (Section 6.11.9)
8633    
8634          "CREATE EFFECT_INSTANCE" (Section 6.11.4)
8635    
8636     Note that the forward slash character ('/') has a special meaning in     Note that the forward slash character ('/') has a special meaning in
8637     filename / path based arguments: it acts as separator of the nodes in     filename / path based arguments: it acts as separator of the nodes in
8638     the path, thus if a directory- or filename includes a forward slash     the path, thus if a directory- or filename includes a forward slash
# Line 6936  Internet-Draft        LinuxSampler Contr Line 8640  Internet-Draft        LinuxSampler Contr
8640     either with the respective hex escape sequence ("\x2f") or with the     either with the respective hex escape sequence ("\x2f") or with the
8641     respective octal escape sequence ("\057").     respective octal escape sequence ("\057").
8642    
8643     The following LSCP commands even support escape sequences as part of     Note for Windows: file path arguments in LSCP are expected to use
8644       forward slashes as directory node separator similar to Unix based
8645       operating systems.  In contrast to Unix however a Windows typical
8646       drive character is expected to be prefixed to the path.  That is an
8647  Schoenebeck              Expires April 17, 2008               [Page 124]     original Windows file path like "D:\Sounds\My.gig" would become in
8648       LSCP: "D:/Sounds/My.gig".
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
8649    
8650       The following LSCP commands even support escape sequences as part of
8651     at least one of their text-based arguments (i.e. entity name,     at least one of their text-based arguments (i.e. entity name,
8652     description) and / or may contain escape sequences in at least one of     description) and / or may contain escape sequences in at least one of
8653     their text-based fields in their response:     their text-based fields in their response:
8654    
8655        "GET SERVER INFO" (Section 6.6.4)        "GET SERVER INFO" (Section 6.6.5)
8656    
8657        "GET ENGINE INFO" (Section 6.4.9)        "GET ENGINE INFO" (Section 6.4.9)
8658    
# Line 6969  Internet-Draft        LinuxSampler Contr Line 8672  Internet-Draft        LinuxSampler Contr
8672    
8673        "MAP MIDI_INSTRUMENT" (Section 6.7.7)        "MAP MIDI_INSTRUMENT" (Section 6.7.7)
8674    
8675    
8676    
8677    
8678    
8679    Schoenebeck               Expires April 8, 2011               [Page 155]
8680    
8681    Internet-Draft        LinuxSampler Control Protocol         October 2010
8682    
8683    
8684        "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)        "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
8685    
8686        "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)        "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
# Line 6987  Internet-Draft        LinuxSampler Contr Line 8699  Internet-Draft        LinuxSampler Contr
8699    
8700        "FIND DB_INSTRUMENTS" (Section 6.8.20)        "FIND DB_INSTRUMENTS" (Section 6.8.20)
8701    
8702          "GET EFFECT INFO" (Section 6.11.3)
8703    
8704          "GET EFFECT_INSTANCE INFO" (Section 6.11.9)
8705    
8706          "CREATE EFFECT_INSTANCE" (Section 6.11.4)
8707    
8708     Please note that these lists are manually maintained.  If you find a     Please note that these lists are manually maintained.  If you find a
8709     command that also supports escape sequences we forgot to mention     command that also supports escape sequences we forgot to mention
8710     here, please report it!     here, please report it!
# Line 6996  Internet-Draft        LinuxSampler Contr Line 8714  Internet-Draft        LinuxSampler Contr
8714    
8715    
8716    
8717  Schoenebeck              Expires April 17, 2008               [Page 125]  
8718    
8719    
8720    
8721    
8722    
8723    
8724    
8725    
8726    
8727    
8728    
8729    
8730    
8731    
8732    
8733    
8734    
8735    Schoenebeck               Expires April 8, 2011               [Page 156]
8736    
8737  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
8738    
8739    
8740  8.  Events  8.  Events
# Line 7052  Internet-Draft        LinuxSampler Contr Line 8788  Internet-Draft        LinuxSampler Contr
8788    
8789    
8790    
8791  Schoenebeck              Expires April 17, 2008               [Page 126]  Schoenebeck               Expires April 8, 2011               [Page 157]
8792    
8793  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
8794    
8795    
8796        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 7095  Internet-Draft        LinuxSampler Contr Line 8831  Internet-Draft        LinuxSampler Contr
8831     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
8832     channels.     channels.
8833    
8834  8.6.  Number of active voices changed  8.6.  MIDI data on a sampler channel arrived
8835    
8836     Client may want to be notified when the number of voices on the back-     Client may want to be notified when MIDI data arrive on sampler
8837     end changes by issuing the following command:     channels on back-end side, by issuing the following command:
8838    
8839        SUBSCRIBE VOICE_COUNT        SUBSCRIBE CHANNEL_MIDI
8840    
8841     Server will start sending the following notification messages:     Server will start sending one of the the following notification
8842       messages:
8843    
8844    
8845    
8846    
8847    Schoenebeck               Expires April 8, 2011               [Page 158]
8848    
8849    Internet-Draft        LinuxSampler Control Protocol         October 2010
8850    
8851    
8852          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"
8853    
8854          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"
8855    
8856       where <channel-id> will be replaced by the ID of the sampler channel
8857       where the MIDI data arrived. <note> and <velocity> are integer values
8858       in the range between 0 .. 127, reflecting the analog meaning of the
8859       MIDI specification.
8860    
8861       CAUTION: no guarantee whatsoever will be made that MIDI events are
8862       actually all delivered by this mechanism!  With other words: events
8863       could be lost at any time!  This restriction was made to keep the RT-
8864       safeness of the backend's MIDI and audio thread unaffected by this
8865       feature.
8866    
8867    8.7.  MIDI data on a MIDI input device arrived
8868    
8869       Client may want to be notified when MIDI data arrive on MIDI input
8870       devices by issuing the following command:
8871    
8872          SUBSCRIBE DEVICE_MIDI
8873    
8874       Server will start sending one of the the following notification
8875       messages:
8876    
8877          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note>
8878          <velocity>"
8879    
8880          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note>
8881          <velocity>"
8882    
8883       where <device-id> <port-id> will be replaced by the IDs of the
8884       respective MIDI input device and the device's MIDI port where the
8885       MIDI data arrived. <note> and <velocity> are integer values in the
8886       range between 0 .. 127, reflecting the analog meaning of the MIDI
8887       specification.
8888    
8889       CAUTION: no guarantee whatsoever will be made that MIDI events are
8890       actually all delivered by this mechanism!  With other words: events
8891       could be lost at any time!  This restriction was made to keep the RT-
8892       safeness of the backend's MIDI and audio thread unaffected by this
8893       feature.
8894    
8895    8.8.  Number of active voices changed
8896    
8897  Schoenebeck              Expires April 17, 2008               [Page 127]     Client may want to be notified when the number of voices on the back-
8898       end changes by issuing the following command:
8899    
8900    
8901    
8902    
8903    Schoenebeck               Expires April 8, 2011               [Page 159]
8904    
8905  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
8906    
8907    
8908          SUBSCRIBE VOICE_COUNT
8909    
8910       Server will start sending the following notification messages:
8911    
8912        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
8913    
# Line 7119  Internet-Draft        LinuxSampler Contr Line 8915  Internet-Draft        LinuxSampler Contr
8915     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
8916     voices on that channel.     voices on that channel.
8917    
8918  8.7.  Number of active disk streams changed  8.9.  Number of active disk streams changed
8919    
8920     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
8921     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 7135  Internet-Draft        LinuxSampler Contr Line 8931  Internet-Draft        LinuxSampler Contr
8931     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
8932     active disk streams on that channel.     active disk streams on that channel.
8933    
8934  8.8.  Disk stream buffer fill state changed  8.10.  Disk stream buffer fill state changed
8935    
8936     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
8937     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 7152  Internet-Draft        LinuxSampler Contr Line 8948  Internet-Draft        LinuxSampler Contr
8948     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
8949     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
8950    
8951  8.9.  Channel information changed  8.11.  Channel information changed
8952    
8953     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
8954     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
8955    
       SUBSCRIBE CHANNEL_INFO  
8956    
    Server will start sending the following notification messages:  
8957    
8958    
8959    Schoenebeck               Expires April 8, 2011               [Page 160]
8960    
8961    Internet-Draft        LinuxSampler Control Protocol         October 2010
8962    
8963    
8964  Schoenebeck              Expires April 17, 2008               [Page 128]        SUBSCRIBE CHANNEL_INFO
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
8965    
8966       Server will start sending the following notification messages:
8967    
8968        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
8969    
# Line 7178  Internet-Draft        LinuxSampler Contr Line 8974  Internet-Draft        LinuxSampler Contr
8974     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
8975     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
8976    
8977  8.10.  Number of effect sends changed  8.12.  Number of effect sends changed
8978    
8979     Client may want to be notified when the number of effect sends on a     Client may want to be notified when the number of effect sends on a
8980     particular sampler channel is changed by issuing the following     particular sampler channel is changed by issuing the following
# Line 7195  Internet-Draft        LinuxSampler Contr Line 8991  Internet-Draft        LinuxSampler Contr
8991     sends> will be replaced by the new number of effect sends on that     sends> will be replaced by the new number of effect sends on that
8992     channel.     channel.
8993    
8994  8.11.  Effect send information changed  8.13.  Effect send information changed
8995    
8996     Client may want to be notified when changes were made to effect sends     Client may want to be notified when changes were made to effect sends
8997     on a a particular sampler channel by issuing the following command:     on a a particular sampler channel by issuing the following command:
# Line 7211  Internet-Draft        LinuxSampler Contr Line 9007  Internet-Draft        LinuxSampler Contr
9007     send-id> will be replaced by the numerical ID of the changed effect     send-id> will be replaced by the numerical ID of the changed effect
9008     send.     send.
9009    
 8.12.  Total number of active voices changed  
9010    
    Client may want to be notified when the total number of voices on the  
    back-end changes by issuing the following command:  
9011    
9012    
9013    
9014    
9015    Schoenebeck               Expires April 8, 2011               [Page 161]
 Schoenebeck              Expires April 17, 2008               [Page 129]  
9016    
9017  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
9018    
9019    
9020    8.14.  Total number of active voices changed
9021    
9022       Client may want to be notified when the total number of voices on the
9023       back-end changes by issuing the following command:
9024    
9025        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
9026    
# Line 7234  Internet-Draft        LinuxSampler Contr Line 9031  Internet-Draft        LinuxSampler Contr
9031     where <voices> will be replaced by the new number of all currently     where <voices> will be replaced by the new number of all currently
9032     active voices.     active voices.
9033    
9034  8.13.  Number of MIDI instrument maps changed  8.15.  Total number of active disk streams changed
9035    
9036       Client may want to be notified when the total number of disk streams
9037       on the back-end changes by issuing the following command:
9038    
9039          SUBSCRIBE TOTAL_STREAM_COUNT
9040    
9041       Server will start sending the following notification messages:
9042    
9043          "NOTIFY:TOTAL_STREAM_COUNT:<streams>"
9044    
9045       where <streams> will be replaced by the new number of all currently
9046       active disk streams.
9047    
9048    8.16.  Number of MIDI instrument maps changed
9049    
9050     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
9051     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 7248  Internet-Draft        LinuxSampler Contr Line 9059  Internet-Draft        LinuxSampler Contr
9059     where <maps> will be replaced by the new number of MIDI instrument     where <maps> will be replaced by the new number of MIDI instrument
9060     maps.     maps.
9061    
9062  8.14.  MIDI instrument map information changed  8.17.  MIDI instrument map information changed
9063    
9064     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
9065     instrument maps on the back-end by issuing the following command:     instrument maps on the back-end by issuing the following command:
9066    
9067    
9068    
9069    
9070    
9071    Schoenebeck               Expires April 8, 2011               [Page 162]
9072    
9073    Internet-Draft        LinuxSampler Control Protocol         October 2010
9074    
9075    
9076        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
9077    
9078     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7267  Internet-Draft        LinuxSampler Contr Line 9087  Internet-Draft        LinuxSampler Contr
9087     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
9088     message is sufficient here.     message is sufficient here.
9089    
9090  8.15.  Number of MIDI instruments changed  8.18.  Number of MIDI instruments changed
9091    
9092     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
9093     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
9094    
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 130]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
9095        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
9096    
9097     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7291  Internet-Draft        LinuxSampler Contr Line 9102  Internet-Draft        LinuxSampler Contr
9102     which the nuber of instruments has changed and <instruments> will be     which the nuber of instruments has changed and <instruments> will be
9103     replaced by the new number of MIDI instruments in the specified map.     replaced by the new number of MIDI instruments in the specified map.
9104    
9105  8.16.  MIDI instrument information changed  8.19.  MIDI instrument information changed
9106    
9107     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
9108     instruments on the back-end by issuing the following command:     instruments on the back-end by issuing the following command:
# Line 7311  Internet-Draft        LinuxSampler Contr Line 9122  Internet-Draft        LinuxSampler Contr
9122     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
9123     empty notification message is sufficient here.     empty notification message is sufficient here.
9124    
9125  8.17.  Global settings changed  
9126    
9127    Schoenebeck               Expires April 8, 2011               [Page 163]
9128    
9129    Internet-Draft        LinuxSampler Control Protocol         October 2010
9130    
9131    
9132    8.20.  Global settings changed
9133    
9134     Client may want to be notified when changes to the global settings of     Client may want to be notified when changes to the global settings of
9135     the sampler were made by issuing the following command:     the sampler were made by issuing the following command:
# Line 7326  Internet-Draft        LinuxSampler Contr Line 9144  Internet-Draft        LinuxSampler Contr
9144        by the optional dotted floating point value, reflecting the new        by the optional dotted floating point value, reflecting the new
9145        global volume parameter.        global volume parameter.
9146    
9147          "NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the
9148          golbal limit of the sampler for maximum voices is changed, where
9149          <max-voices> will be an integer value, reflecting the new global
9150          voice limit parameter.
9151    
9152          "NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the
9153          golbal limit of the sampler for maximum disk streams is changed,
9154          where <max-streams> will be an integer value, reflecting the new
9155          global disk streams limit parameter.
9156    
9157    8.21.  Number of database instrument directories changed
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 131]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
 8.18.  Number of database instrument directories changed  
9158    
9159     Client may want to be notified when the number of instrument     Client may want to be notified when the number of instrument
9160     directories in a particular directory in the instruments database is     directories in a particular directory in the instruments database is
# Line 7356  Internet-Draft        LinuxSampler Contr Line 9173  Internet-Draft        LinuxSampler Contr
9173     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
9174     sent for the subdirectories in that directory.     sent for the subdirectories in that directory.
9175    
9176  8.19.  Database instrument directory information changed  8.22.  Database instrument directory information changed
9177    
9178     Client may want to be notified when changes were made to directories     Client may want to be notified when changes were made to directories
9179     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
9180    
9181    
9182    
9183    Schoenebeck               Expires April 8, 2011               [Page 164]
9184    
9185    Internet-Draft        LinuxSampler Control Protocol         October 2010
9186    
9187    
9188        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
9189    
9190     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 7382  Internet-Draft        LinuxSampler Contr Line 9206  Internet-Draft        LinuxSampler Contr
9206     (encapsulated into apostrophes), which name is changes and <new-name>     (encapsulated into apostrophes), which name is changes and <new-name>
9207     is the new name of the directory, encapsulated into apostrophes.     is the new name of the directory, encapsulated into apostrophes.
9208    
9209    8.23.  Number of database instruments changed
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 132]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
 8.20.  Number of database instruments changed  
9210    
9211     Client may want to be notified when the number of instruments in a     Client may want to be notified when the number of instruments in a
9212     particular directory in the instruments database is changed by     particular directory in the instruments database is changed by
# Line 7412  Internet-Draft        LinuxSampler Contr Line 9225  Internet-Draft        LinuxSampler Contr
9225     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
9226     sent for the instruments in that directory.     sent for the instruments in that directory.
9227    
9228  8.21.  Database instrument information changed  8.24.  Database instrument information changed
9229    
9230     Client may want to be notified when changes were made to instruments     Client may want to be notified when changes were made to instruments
9231     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 7421  Internet-Draft        LinuxSampler Contr Line 9234  Internet-Draft        LinuxSampler Contr
9234    
9235     Server will start sending the following notification messages:     Server will start sending the following notification messages:
9236    
9237    
9238    
9239    Schoenebeck               Expires April 8, 2011               [Page 165]
9240    
9241    Internet-Draft        LinuxSampler Control Protocol         October 2010
9242    
9243    
9244        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
9245    
9246     where <instr-path> will be replaced by the absolute path name of the     where <instr-path> will be replaced by the absolute path name of the
# Line 7438  Internet-Draft        LinuxSampler Contr Line 9258  Internet-Draft        LinuxSampler Contr
9258     <new-name> is the new name of the instrument, encapsulated into     <new-name> is the new name of the instrument, encapsulated into
9259     apostrophes.     apostrophes.
9260    
9261    8.25.  Database job status information changed
   
   
   
   
   
 Schoenebeck              Expires April 17, 2008               [Page 133]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2007  
   
   
 8.22.  Database job status information changed  
9262    
9263     Client may want to be notified when the status of particular database     Client may want to be notified when the status of particular database
9264     instruments job is changed by issuing the following command:     instruments job is changed by issuing the following command:
# Line 7467  Internet-Draft        LinuxSampler Contr Line 9276  Internet-Draft        LinuxSampler Contr
9276     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
9277     empty notification message is sufficient here.     empty notification message is sufficient here.
9278    
9279  8.23.  Miscellaneous and debugging events  8.26.  Miscellaneous and debugging events
9280    
9281     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
9282     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 7480  Internet-Draft        LinuxSampler Contr Line 9289  Internet-Draft        LinuxSampler Contr
9289    
9290     where <string> will be replaced by whatever data server wants to send     where <string> will be replaced by whatever data server wants to send
9291     to the client.  Client MAY display this data to the user AS IS to     to the client.  Client MAY display this data to the user AS IS to
9292    
9293    
9294    
9295    Schoenebeck               Expires April 8, 2011               [Page 166]
9296    
9297    Internet-Draft        LinuxSampler Control Protocol         October 2010
9298    
9299    
9300     facilitate debugging.     facilitate debugging.
9301    
9302    
# Line 7500  Internet-Draft        LinuxSampler Contr Line 9317  Internet-Draft        LinuxSampler Contr
9317    
9318    
9319    
9320  Schoenebeck              Expires April 17, 2008               [Page 134]  
9321    
9322    
9323    
9324    
9325    
9326    
9327    
9328    
9329    
9330    
9331    
9332    
9333    
9334    
9335    
9336    
9337    
9338    
9339    
9340    
9341    
9342    
9343    
9344    
9345    
9346    
9347    
9348    
9349    
9350    
9351    Schoenebeck               Expires April 8, 2011               [Page 167]
9352    
9353  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
9354    
9355    
9356  9.  Security Considerations  9.  Security Considerations
# Line 7556  Internet-Draft        LinuxSampler Contr Line 9404  Internet-Draft        LinuxSampler Contr
9404    
9405    
9406    
9407  Schoenebeck              Expires April 17, 2008               [Page 135]  Schoenebeck               Expires April 8, 2011               [Page 168]
9408    
9409  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
9410    
9411    
9412  10.  Acknowledgments  10.  Acknowledgments
# Line 7612  Internet-Draft        LinuxSampler Contr Line 9460  Internet-Draft        LinuxSampler Contr
9460    
9461    
9462    
9463  Schoenebeck              Expires April 17, 2008               [Page 136]  Schoenebeck               Expires April 8, 2011               [Page 169]
9464    
9465  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
9466    
9467    
9468  11.  References  11.  References
# Line 7668  Internet-Draft        LinuxSampler Contr Line 9516  Internet-Draft        LinuxSampler Contr
9516    
9517    
9518    
9519  Schoenebeck              Expires April 17, 2008               [Page 137]  Schoenebeck               Expires April 8, 2011               [Page 170]
9520    
9521  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
9522    
9523    
9524  Author's Address  Author's Address
# Line 7724  Author's Address Line 9572  Author's Address
9572    
9573    
9574    
9575  Schoenebeck              Expires April 17, 2008               [Page 138]  Schoenebeck               Expires April 8, 2011               [Page 171]
9576    
9577  Internet-Draft        LinuxSampler Control Protocol         October 2007  Internet-Draft        LinuxSampler Control Protocol         October 2010
9578    
9579    
9580  Full Copyright Statement  Full Copyright Statement
9581    
9582     Copyright (C) The IETF Trust (2007).     Copyright (C) The IETF Trust (2010).
9583    
9584     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
9585     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 7771  Intellectual Property Line 9619  Intellectual Property
9619     ietf-ipr@ietf.org.     ietf-ipr@ietf.org.
9620    
9621    
 Acknowledgment  
9622    
    Funding for the RFC Editor function is provided by the IETF  
    Administrative Support Activity (IASA).  
9623    
9624    
9625    
9626    
9627    
 Schoenebeck              Expires April 17, 2008               [Page 139]  
   
9628    
9629    
9630    
9631    Schoenebeck               Expires April 8, 2011               [Page 172]
9632    
Legend:
Removed from v.1430  
changed lines
  Added in v.2141
  ViewVC Help
Powered by ViewVC