/[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 940 by schoenebeck, Sat Nov 25 17:18:12 2006 UTC revision 1028 by schoenebeck, Sun Jan 14 17:33:03 2007 UTC
# Line 3  Line 3 
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Expires: May 29, 2007                                  Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                         November 25, 2006  Expires: July 18, 2007                                  January 14, 2007
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.1                                  LSCP 1.2
12    
13  Status of this Memo  Status of this Memo
14    
15     This document is an Internet-Draft and is in full conformance with     By submitting this Internet-Draft, each author represents that any
16     all provisions of Section 10 of RFC 2026.     applicable patent or other IPR claims of which he or she is aware
17       have been or will be disclosed, and any of which he or she becomes
18       aware will be disclosed, in accordance with Section 6 of BCP 79.
19    
20     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
21     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF), its areas, and its working groups.  Note that
# Line 31  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on May 29, 2007.     This Internet-Draft will expire on July 18, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2006).  All Rights Reserved.     Copyright (C) The Internet Society (2007).
41    
 Abstract  
42    
    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.  
43    
44    
45    
# Line 52  Abstract Line 48  Abstract
48    
49    
50    
51  Schoenebeck               Expires May 29, 2007                  [Page 1]  
52    
53    
54    
55    Schoenebeck               Expires July 18, 2007                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
58    
59    
60    Abstract
61    
62       The LinuxSampler Control Protocol (LSCP) is an application-level
63       protocol primarily intended for local and remote controlling the
64       LinuxSampler backend application, which is a sophisticated server-
65       like console application essentially playing back audio samples and
66       manipulating the samples in real time to certain extent.
67    
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  4     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5
72     2.  Versioning of this specification . . . . . . . . . . . . . . .  5     2.  Versioning of this specification  . . . . . . . . . . . . . .   6
73     3.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  6     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7
74     4.  Focus of this protocol . . . . . . . . . . . . . . . . . . . .  7     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8
75     5.  Communication Overview . . . . . . . . . . . . . . . . . . . .  8     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9
76       5.1.  Request/response communication method  . . . . . . . . . .  8       5.1.  Request/response communication method . . . . . . . . . .   9
77         5.1.1.  Result format  . . . . . . . . . . . . . . . . . . . .  9         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10
78       5.2.  Subscribe/notify communication method  . . . . . . . . . . 11       5.2.  Subscribe/notify communication method . . . . . . . . . .  12
79     6.  Description for control commands . . . . . . . . . . . . . . . 13     6.  Description for control commands  . . . . . . . . . . . . . .  14
80       6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 13       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14
81       6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 13       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14
82         6.2.1.  Getting amount of available audio output drivers . . . 13         6.2.1.  Getting amount of available audio output drivers  . .  15
83         6.2.2.  Getting all available audio output drivers . . . . . . 14         6.2.2.  Getting all available audio output drivers  . . . . .  15
84         6.2.3.  Getting information about a specific audio output         6.2.3.  Getting information about a specific audio output
85                 driver . . . . . . . . . . . . . . . . . . . . . . . . 14                 driver  . . . . . . . . . . . . . . . . . . . . . . .  15
86         6.2.4.  Getting information about specific audio output         6.2.4.  Getting information about specific audio output
87                 driver parameter . . . . . . . . . . . . . . . . . . . 15                 driver parameter  . . . . . . . . . . . . . . . . . .  16
88         6.2.5.  Creating an audio output device  . . . . . . . . . . . 19         6.2.5.  Creating an audio output device . . . . . . . . . . .  20
89         6.2.6.  Destroying an audio output device  . . . . . . . . . . 20         6.2.6.  Destroying an audio output device . . . . . . . . . .  21
90         6.2.7.  Getting all created audio output device count  . . . . 21         6.2.7.  Getting all created audio output device count . . . .  22
91         6.2.8.  Getting all created audio output device list . . . . . 21         6.2.8.  Getting all created audio output device list  . . . .  22
92         6.2.9.  Getting current settings of an audio output device . . 21         6.2.9.  Getting current settings of an audio output device  .  22
93         6.2.10. Changing settings of audio output devices  . . . . . . 23         6.2.10. Changing settings of audio output devices . . . . . .  24
94         6.2.11. Getting information about an audio channel . . . . . . 23         6.2.11. Getting information about an audio channel  . . . . .  25
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter  . . . . . . . . . . . . . . . . . . . . . . 25                 parameter . . . . . . . . . . . . . . . . . . . . . .  26
97         6.2.13. Changing settings of audio output channels . . . . . . 27         6.2.13. Changing settings of audio output channels  . . . . .  28
98       6.3.  Configuring MIDI input drivers . . . . . . . . . . . . . . 28       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29
99         6.3.1.  Getting amount of available MIDI input drivers . . . . 29         6.3.1.  Getting amount of available MIDI input drivers  . . .  30
100         6.3.2.  Getting all available MIDI input drivers . . . . . . . 29         6.3.2.  Getting all available MIDI input drivers  . . . . . .  30
101         6.3.3.  Getting information about a specific MIDI input         6.3.3.  Getting information about a specific MIDI input
102                 driver . . . . . . . . . . . . . . . . . . . . . . . . 29                 driver  . . . . . . . . . . . . . . . . . . . . . . .  31
103         6.3.4.  Getting information about specific MIDI input         6.3.4.  Getting information about specific MIDI input
104                 driver parameter . . . . . . . . . . . . . . . . . . . 30                 driver parameter  . . . . . . . . . . . . . . . . . .  32
105         6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 33         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34
106         6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 34         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35
107         6.3.7.  Getting all created MIDI input device count  . . . . . 35         6.3.7.  Getting all created MIDI input device count . . . . .  36
108         6.3.8.  Getting all created MIDI input device list . . . . . . 35  
        6.3.9.  Getting current settings of a MIDI input device  . . . 35  
        6.3.10. Changing settings of MIDI input devices  . . . . . . . 37  
        6.3.11. Getting information about a MIDI port  . . . . . . . . 37  
        6.3.12. Getting information about specific MIDI port  
                parameter  . . . . . . . . . . . . . . . . . . . . . . 38  
        6.3.13. Changing settings of MIDI input ports  . . . . . . . . 40  
      6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 41  
        6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 41  
109    
110    
111    Schoenebeck               Expires July 18, 2007                 [Page 2]
112    
113    Internet-Draft        LinuxSampler Control Protocol         January 2007
114    
115    
116  Schoenebeck               Expires May 29, 2007                  [Page 2]         6.3.8.  Getting all created MIDI input device list  . . . . .  36
117           6.3.9.  Getting current settings of a MIDI input device . . .  37
118  Internet-Draft        LinuxSampler Control Protocol        November 2006         6.3.10. Changing settings of MIDI input devices . . . . . . .  38
119           6.3.11. Getting information about a MIDI port . . . . . . . .  38
120           6.3.12. Getting information about specific MIDI port
121         6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 42                 parameter . . . . . . . . . . . . . . . . . . . . . .  39
122         6.4.3.  Getting all created sampler channel count  . . . . . . 43         6.3.13. Changing settings of MIDI input ports . . . . . . . .  41
123         6.4.4.  Getting all created sampler channel list . . . . . . . 43       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42
124         6.4.5.  Adding a new sampler channel . . . . . . . . . . . . . 43         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42
125         6.4.6.  Removing a sampler channel . . . . . . . . . . . . . . 44         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43
126         6.4.7.  Getting amount of available engines  . . . . . . . . . 45         6.4.3.  Getting all created sampler channel count . . . . . .  44
127         6.4.8.  Getting all available engines  . . . . . . . . . . . . 45         6.4.4.  Getting all created sampler channel list  . . . . . .  44
128         6.4.9.  Getting information about an engine  . . . . . . . . . 46         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44
129         6.4.10. Getting sampler channel information  . . . . . . . . . 47         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45
130         6.4.11. Current number of active voices  . . . . . . . . . . . 50         6.4.7.  Getting amount of available engines . . . . . . . . .  46
131         6.4.12. Current number of active disk streams  . . . . . . . . 50         6.4.8.  Getting all available engines . . . . . . . . . . . .  46
132         6.4.13. Current fill state of disk stream buffers  . . . . . . 50         6.4.9.  Getting information about an engine . . . . . . . . .  47
133         6.4.14. Setting audio output device  . . . . . . . . . . . . . 51         6.4.10. Getting sampler channel information . . . . . . . . .  48
134         6.4.15. Setting audio output type  . . . . . . . . . . . . . . 52         6.4.11. Current number of active voices . . . . . . . . . . .  51
135         6.4.16. Setting audio output channel . . . . . . . . . . . . . 53         6.4.12. Current number of active disk streams . . . . . . . .  51
136         6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 54         6.4.13. Current fill state of disk stream buffers . . . . . .  52
137         6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 54         6.4.14. Setting audio output device . . . . . . . . . . . . .  53
138         6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 55         6.4.15. Setting audio output type . . . . . . . . . . . . . .  53
139         6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 56         6.4.16. Setting audio output channel  . . . . . . . . . . . .  54
140         6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 56         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  55
141         6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 57         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  56
142         6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 58         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56
143         6.4.24. Resetting a sampler channel  . . . . . . . . . . . . . 58         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57
144       6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 59         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58
145         6.5.1.  Register front-end for receiving event messages  . . . 59         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58
146           6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59
147           6.4.24. Assigning a MIDI instrument map to a sampler
148                   channel . . . . . . . . . . . . . . . . . . . . . . .  60
149           6.4.25. Adding an effect send to a sampler channel  . . . . .  61
150           6.4.26. Removing an effect send from a sampler channel  . . .  62
151           6.4.27. Getting amount of effect sends on a sampler channel .  63
152           6.4.28. Listing all effect sends on a sampler channel . . . .  63
153           6.4.29. Getting effect send information . . . . . . . . . . .  64
154           6.4.30. Altering effect send's audio routing  . . . . . . . .  65
155           6.4.31. Altering effect send's MIDI controller  . . . . . . .  66
156           6.4.32. Altering effect send's send level . . . . . . . . . .  67
157           6.4.33. Resetting a sampler channel . . . . . . . . . . . . .  68
158         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  68
159           6.5.1.  Register front-end for receiving event messages . . .  68
160         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
161                 messages . . . . . . . . . . . . . . . . . . . . . . . 60                 messages  . . . . . . . . . . . . . . . . . . . . . .  69
162         6.5.3.  Enable or disable echo of commands . . . . . . . . . . 61         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  70
163         6.5.4.  Close client connection  . . . . . . . . . . . . . . . 61         6.5.4.  Close client connection . . . . . . . . . . . . . . .  70
164       6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 61  
165         6.6.1.  Current number of active voices  . . . . . . . . . . . 61  
166         6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 62  
167         6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 62  Schoenebeck               Expires July 18, 2007                 [Page 3]
168         6.6.4.  General sampler informations . . . . . . . . . . . . . 62  
169     7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 64  Internet-Draft        LinuxSampler Control Protocol         January 2007
170     8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71  
171       8.1.  Number of sampler channels changed . . . . . . . . . . . . 71  
172       8.2.  Number of active voices changed  . . . . . . . . . . . . . 71       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  71
173       8.3.  Number of active disk streams changed  . . . . . . . . . . 71         6.6.1.  Current number of active voices . . . . . . . . . . .  71
174       8.4.  Disk stream buffer fill state changed  . . . . . . . . . . 72         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  71
175       8.5.  Channel information changed  . . . . . . . . . . . . . . . 72         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  71
176       8.6.  Total number of active voices changed  . . . . . . . . . . 72         6.6.4.  General sampler informations  . . . . . . . . . . . .  72
177       8.7.  Miscellaneous and debugging events . . . . . . . . . . . . 73         6.6.5.  Getting global volume attenuation . . . . . . . . . .  72
178     9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 74         6.6.6.  Setting global volume attenuation . . . . . . . . . .  73
179     10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 75       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  73
180     11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 75         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  74
181     Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 76         6.7.2.  Delete one particular or all MIDI instrument maps . .  75
182     Intellectual Property and Copyright Statements . . . . . . . . . . 77         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  75
183           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  76
184           6.7.5.  Getting MIDI instrument map information . . . . . . .  76
185           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  77
186           6.7.7.  Create or replace a MIDI instrument map entry . . . .  77
187           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  80
188           6.7.9.  Getting indeces of all entries of a MIDI
189                   instrument map  . . . . . . . . . . . . . . . . . . .  81
190           6.7.10. Remove an entry from the MIDI instrument map  . . . .  81
191           6.7.11. Get current settings of MIDI instrument map entry . .  82
192           6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  84
193       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  85
194       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  96
195         8.1.  Number of audio output devices changed  . . . . . . . . .  96
196         8.2.  Audio output device's settings changed  . . . . . . . . .  96
197         8.3.  Number of MIDI input devices changed  . . . . . . . . . .  96
198         8.4.  MIDI input device's settings changed  . . . . . . . . . .  97
199         8.5.  Number of sampler channels changed  . . . . . . . . . . .  97
200         8.6.  Number of active voices changed . . . . . . . . . . . . .  97
201         8.7.  Number of active disk streams changed . . . . . . . . . .  98
202         8.8.  Disk stream buffer fill state changed . . . . . . . . . .  98
203         8.9.  Channel information changed . . . . . . . . . . . . . . .  98
204         8.10. Total number of active voices changed . . . . . . . . . .  99
205         8.11. Number of MIDI instrument maps changed  . . . . . . . . .  99
206         8.12. MIDI instrument map information changed . . . . . . . . .  99
207         8.13. Number of MIDI instruments changed  . . . . . . . . . . . 100
208         8.14. MIDI instrument information changed . . . . . . . . . . . 100
209         8.15. Miscellaneous and debugging events  . . . . . . . . . . . 101
210       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 102
211       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 103
212       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 104
213       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 105
214       Intellectual Property and Copyright Statements  . . . . . . . . . 106
215    
216    
217    
218    
219    
220    
221  Schoenebeck               Expires May 29, 2007                  [Page 3]  
222    
223    Schoenebeck               Expires July 18, 2007                 [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
226    
227    
228  1.  Requirements notation  1.  Requirements notation
# Line 220  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck               Expires May 29, 2007                  [Page 4]  Schoenebeck               Expires July 18, 2007                 [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
282    
283    
284  2.  Versioning of this specification  2.  Versioning of this specification
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires May 29, 2007                  [Page 5]  Schoenebeck               Expires July 18, 2007                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
338    
339    
340  3.  Introduction  3.  Introduction
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires May 29, 2007                  [Page 6]  Schoenebeck               Expires July 18, 2007                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
394    
395    
396  4.  Focus of this protocol  4.  Focus of this protocol
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires May 29, 2007                  [Page 7]  Schoenebeck               Expires July 18, 2007                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
450    
451    
452  5.  Communication Overview  5.  Communication Overview
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires May 29, 2007                  [Page 8]  Schoenebeck               Expires July 18, 2007                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
506    
507    
508  5.1.1.  Result format  5.1.1.  Result format
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires May 29, 2007                  [Page 9]  Schoenebeck               Expires July 18, 2007                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
562    
563    
564     set has the following format:     set has the following format:
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires May 29, 2007                 [Page 10]  Schoenebeck               Expires July 18, 2007                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
618    
619    
620     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires May 29, 2007                 [Page 11]  Schoenebeck               Expires July 18, 2007                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
674    
675    
676         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires May 29, 2007                 [Page 12]  Schoenebeck               Expires July 18, 2007                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
730    
731    
732  6.  Description for control commands  6.  Description for control commands
# Line 718  Internet-Draft        LinuxSampler Contr Line 774  Internet-Draft        LinuxSampler Contr
774     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
775     possible values, etc.     possible values, etc.
776    
 6.2.1.  Getting amount of available audio output drivers  
777    
    Use the following command to get the number of audio output drivers  
778    
779    
780    
781  Schoenebeck               Expires May 29, 2007                 [Page 13]  
782    
783    Schoenebeck               Expires July 18, 2007                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
786    
787    
788    6.2.1.  Getting amount of available audio output drivers
789    
790       Use the following command to get the number of audio output drivers
791     currently available for the LinuxSampler instance:     currently available for the LinuxSampler instance:
792    
793        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 777  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839    Schoenebeck               Expires July 18, 2007                [Page 15]
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 14]  
840    
841  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
842    
843    
844        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires May 29, 2007                 [Page 15]  Schoenebeck               Expires July 18, 2007                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
898    
899    
900     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires May 29, 2007                 [Page 16]  Schoenebeck               Expires July 18, 2007                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
954    
955    
956        MULTIPLICITY -        MULTIPLICITY -
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires May 29, 2007                 [Page 17]  Schoenebeck               Expires July 18, 2007                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1010    
1011    
1012           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires May 29, 2007                 [Page 18]  Schoenebeck               Expires July 18, 2007                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1066    
1067    
1068           "TYPE: INT"           "TYPE: INT"
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires May 29, 2007                 [Page 19]  Schoenebeck               Expires July 18, 2007                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1122    
1123    
1124           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires May 29, 2007                 [Page 20]  Schoenebeck               Expires July 18, 2007                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1178    
1179    
1180        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires May 29, 2007                 [Page 21]  Schoenebeck               Expires July 18, 2007                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1234    
1235    
1236     Possible Answers:     Possible Answers:
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires May 29, 2007                 [Page 22]  Schoenebeck               Expires July 18, 2007                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1290    
1291    
1292           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1277  Internet-Draft        LinuxSampler Contr Line 1333  Internet-Draft        LinuxSampler Contr
1333    
1334        S: "OK"        S: "OK"
1335    
 6.2.11.  Getting information about an audio channel  
1336    
    Use the following command to get information about an audio channel:  
1337    
1338    
1339    
1340    
1341  Schoenebeck               Expires May 29, 2007                 [Page 23]  
1342    
1343    Schoenebeck               Expires July 18, 2007                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1346    
1347    
1348    6.2.11.  Getting information about an audio channel
1349    
1350       Use the following command to get information about an audio channel:
1351    
1352        GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>        GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
1353    
# Line 1334  Internet-Draft        LinuxSampler Contr Line 1394  Internet-Draft        LinuxSampler Contr
1394     driver.  Every audio channel might have its own, additional driver     driver.  Every audio channel might have its own, additional driver
1395     and channel specific parameters.     and channel specific parameters.
1396    
    Examples:  
1397    
1398    
1399    Schoenebeck               Expires July 18, 2007                [Page 25]
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 24]  
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1402    
1403    
1404       Examples:
1405    
1406        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
1407    
1408        S: "NAME: studio monitor left"        S: "NAME: studio monitor left"
# Line 1391  Internet-Draft        LinuxSampler Contr Line 1449  Internet-Draft        LinuxSampler Contr
1449     Where <dev-id> is the numerical ID of the audio output device as     Where <dev-id> is the numerical ID of the audio output device as
1450     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1451     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
    channel number and <param> a specific channel parameter name for  
    which information should be obtained (as returned by the "GET  
1452    
1453    
1454    
1455  Schoenebeck               Expires May 29, 2007                 [Page 25]  Schoenebeck               Expires July 18, 2007                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1458    
1459    
1460       channel number and <param> a specific channel parameter name for
1461       which information should be obtained (as returned by the "GET
1462     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
1463    
1464     Possible Answers:     Possible Answers:
# Line 1450  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511    Schoenebeck               Expires July 18, 2007                [Page 27]
   
 Schoenebeck               Expires May 29, 2007                 [Page 26]  
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1514    
1515    
1516           RANGE_MAX -           RANGE_MAX -
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires May 29, 2007                 [Page 27]  Schoenebeck               Expires July 18, 2007                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1570    
1571    
1572        "OK" -        "OK" -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires May 29, 2007                 [Page 28]  Schoenebeck               Expires July 18, 2007                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1626    
1627    
1628     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1613  Internet-Draft        LinuxSampler Contr Line 1669  Internet-Draft        LinuxSampler Contr
1669    
1670        S: "ALSA,JACK"        S: "ALSA,JACK"
1671    
 6.3.3.  Getting information about a specific MIDI input driver  
1672    
    Use the following command to get detailed information about a  
    specific MIDI input driver:  
1673    
1674    
1675    
1676  Schoenebeck               Expires May 29, 2007                 [Page 29]  
1677    
1678    
1679    Schoenebeck               Expires July 18, 2007                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1682    
1683    
1684    6.3.3.  Getting information about a specific MIDI input driver
1685    
1686       Use the following command to get detailed information about a
1687       specific MIDI input driver:
1688    
1689        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>
1690    
# Line 1668  Internet-Draft        LinuxSampler Contr Line 1729  Internet-Draft        LinuxSampler Contr
1729    
1730           "."           "."
1731    
 6.3.4.  Getting information about specific MIDI input driver parameter  
1732    
    Use the following command to get detailed information about a  
    specific parameter of a specific MIDI input driver:  
1733    
1734    
1735    Schoenebeck               Expires July 18, 2007                [Page 31]
1736    
1737    Internet-Draft        LinuxSampler Control Protocol         January 2007
1738    
1739    
1740  Schoenebeck               Expires May 29, 2007                 [Page 30]  6.3.4.  Getting information about specific MIDI input driver parameter
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
1741    
1742       Use the following command to get detailed information about a
1743       specific parameter of a specific MIDI input driver:
1744    
1745        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
1746    
# Line 1725  Internet-Draft        LinuxSampler Contr Line 1786  Internet-Draft        LinuxSampler Contr
1786           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1787           matter which driver parameter)           matter which driver parameter)
1788    
       FIX -  
   
          either true or false, if false then this parameter can be  
          changed at any time, once the device is created by the 'CREATE  
   
1789    
1790    
1791  Schoenebeck               Expires May 29, 2007                 [Page 31]  Schoenebeck               Expires July 18, 2007                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1794    
1795    
1796          FIX -
1797    
1798             either true or false, if false then this parameter can be
1799             changed at any time, once the device is created by the 'CREATE
1800           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1801           matter which driver parameter)           matter which driver parameter)
1802    
# Line 1781  Internet-Draft        LinuxSampler Contr Line 1841  Internet-Draft        LinuxSampler Contr
1841           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
1842           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1843           this parameter is often used in conjunction with RANGE_MIN, but           this parameter is often used in conjunction with RANGE_MIN, but
          may also appear without (optionally returned, dependent to  
          driver parameter)  
1844    
1845    
1846    
1847    Schoenebeck               Expires July 18, 2007                [Page 33]
   
 Schoenebeck               Expires May 29, 2007                 [Page 32]  
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1850    
1851    
1852             may also appear without (optionally returned, dependent to
1853             driver parameter)
1854    
1855        POSSIBILITIES -        POSSIBILITIES -
1856    
# Line 1837  Internet-Draft        LinuxSampler Contr Line 1896  Internet-Draft        LinuxSampler Contr
1896    
1897     Possible Answers:     Possible Answers:
1898    
       "OK[<device-id>]" -  
1899    
          in case the device was successfully created, where <device-id>  
          is the numerical ID of the new device  
1900    
1901    
1902    
1903  Schoenebeck               Expires May 29, 2007                 [Page 33]  Schoenebeck               Expires July 18, 2007                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
1906    
1907    
1908          "OK[<device-id>]" -
1909    
1910             in case the device was successfully created, where <device-id>
1911             is the numerical ID of the new device
1912    
1913        "WRN[<device-id>]:<warning-code>:<warning-message>" -        "WRN[<device-id>]:<warning-code>:<warning-message>" -
1914    
# Line 1891  Internet-Draft        LinuxSampler Contr Line 1952  Internet-Draft        LinuxSampler Contr
1952    
1953        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1954    
          in case it failed, providing an appropriate error code and  
          error message  
1955    
    Example:  
1956    
1957    
1958    
1959    Schoenebeck               Expires July 18, 2007                [Page 35]
1960    
1961    Internet-Draft        LinuxSampler Control Protocol         January 2007
1962    
1963    
1964  Schoenebeck               Expires May 29, 2007                 [Page 34]           in case it failed, providing an appropriate error code and
1965             error message
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
1966    
1967       Example:
1968    
1969        C: "DESTROY MIDI_INPUT_DEVICE 0"        C: "DESTROY MIDI_INPUT_DEVICE 0"
1970    
# Line 1947  Internet-Draft        LinuxSampler Contr Line 2008  Internet-Draft        LinuxSampler Contr
2008    
2009        S: "1,3"        S: "1,3"
2010    
 6.3.9.  Getting current settings of a MIDI input device  
2011    
    Use the following command to get current settings of a specific,  
    created MIDI input device:  
2012    
2013    
2014    
2015    Schoenebeck               Expires July 18, 2007                [Page 36]
2016    
2017    Internet-Draft        LinuxSampler Control Protocol         January 2007
2018    
2019    
2020  Schoenebeck               Expires May 29, 2007                 [Page 35]  6.3.9.  Getting current settings of a MIDI input device
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2021    
2022       Use the following command to get current settings of a specific,
2023       created MIDI input device:
2024    
2025        GET MIDI_INPUT_DEVICE INFO <device-id>        GET MIDI_INPUT_DEVICE INFO <device-id>
2026    
# Line 2004  Internet-Draft        LinuxSampler Contr Line 2065  Internet-Draft        LinuxSampler Contr
2065    
2066        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
2067    
          "ACTIVE: true"  
   
          "."  
2068    
2069    
2070    
2071    Schoenebeck               Expires July 18, 2007                [Page 37]
2072    
2073    Internet-Draft        LinuxSampler Control Protocol         January 2007
2074    
2075    
2076  Schoenebeck               Expires May 29, 2007                 [Page 36]           "ACTIVE: true"
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2077    
2078             "."
2079    
2080  6.3.10.  Changing settings of MIDI input devices  6.3.10.  Changing settings of MIDI input devices
2081    
# Line 2061  Internet-Draft        LinuxSampler Contr Line 2121  Internet-Draft        LinuxSampler Contr
2121    
2122     Where <device-id> is the numerical ID of the MIDI input device as     Where <device-id> is the numerical ID of the MIDI input device as
2123     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
    MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI  
    input port number.  
   
    Possible Answers:  
2124    
2125    
2126    
2127  Schoenebeck               Expires May 29, 2007                 [Page 37]  Schoenebeck               Expires July 18, 2007                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2130    
2131    
2132       MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
2133       input port number.
2134    
2135       Possible Answers:
2136    
2137        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2138        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2139        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 2116  Internet-Draft        LinuxSampler Contr Line 2177  Internet-Draft        LinuxSampler Contr
2177        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2178        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2179        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
       character string to that info category.  There is information  
       which is always returned, independently of the given channel  
       parameter and there is optional information which are only shown  
       dependently to the given MIDI port.  At the moment the following  
       information categories are defined:  
2180    
2181    
2182    
2183  Schoenebeck               Expires May 29, 2007                 [Page 38]  Schoenebeck               Expires July 18, 2007                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2186    
2187    
2188          character string to that info category.  There is information
2189          which is always returned, independently of the given channel
2190          parameter and there is optional information which are only shown
2191          dependently to the given MIDI port.  At the moment the following
2192          information categories are defined:
2193    
2194        TYPE -        TYPE -
2195    
# Line 2171  Internet-Draft        LinuxSampler Contr Line 2233  Internet-Draft        LinuxSampler Contr
2233    
2234           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
2235           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
          returned, dependent to device and port parameter)  
2236    
    The mentioned fields above don't have to be in particular order.  
2237    
    Example:  
2238    
2239    Schoenebeck               Expires July 18, 2007                [Page 40]
2240    
2241    Internet-Draft        LinuxSampler Control Protocol         January 2007
2242    
2243    
2244             returned, dependent to device and port parameter)
2245    
2246  Schoenebeck               Expires May 29, 2007                 [Page 39]     The mentioned fields above don't have to be in particular order.
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2247    
2248       Example:
2249    
2250        C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"        C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
2251    
# Line 2226  Internet-Draft        LinuxSampler Contr Line 2288  Internet-Draft        LinuxSampler Contr
2288    
2289        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2290    
          in case it failed, providing an appropriate error code and  
          error message  
   
    Example:  
2291    
2292    
2293    
2294    
2295    Schoenebeck               Expires July 18, 2007                [Page 41]
2296    
2297    Internet-Draft        LinuxSampler Control Protocol         January 2007
2298    
2299    
2300  Schoenebeck               Expires May 29, 2007                 [Page 40]           in case it failed, providing an appropriate error code and
2301             error message
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2302    
2303       Example:
2304    
2305    
2306    
# Line 2284  Internet-Draft        LinuxSampler Contr Line 2345  Internet-Draft        LinuxSampler Contr
2345    
2346           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2347           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
          or more patch parameters provided by the loaded instrument  
          file), providing an appropriate warning code and warning  
          message  
2348    
2349    
2350    
2351    Schoenebeck               Expires July 18, 2007                [Page 42]
   
 Schoenebeck               Expires May 29, 2007                 [Page 41]  
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2354    
2355    
2356             or more patch parameters provided by the loaded instrument
2357             file), providing an appropriate warning code and warning
2358             message
2359    
2360        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2361    
# Line 2342  Internet-Draft        LinuxSampler Contr Line 2402  Internet-Draft        LinuxSampler Contr
2402           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2403           error message           error message
2404    
    Example:  
   
   
2405    
2406    
2407    Schoenebeck               Expires July 18, 2007                [Page 43]
 Schoenebeck               Expires May 29, 2007                 [Page 42]  
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2410    
2411    
2412       Example:
2413    
2414    
2415    
2416  6.4.3.  Getting all created sampler channel count  6.4.3.  Getting all created sampler channel count
# Line 2398  Internet-Draft        LinuxSampler Contr Line 2456  Internet-Draft        LinuxSampler Contr
2456     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2457     list by sending the following command:     list by sending the following command:
2458    
       ADD CHANNEL  
2459    
    This will increment the sampler channel count by one and the new  
2460    
2461    
2462    
2463  Schoenebeck               Expires May 29, 2007                 [Page 43]  Schoenebeck               Expires July 18, 2007                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2466    
2467    
2468          ADD CHANNEL
2469    
2470       This will increment the sampler channel count by one and the new
2471     sampler channel will be appended to the end of the sampler channel     sampler channel will be appended to the end of the sampler channel
2472     list.  The front-end should send the respective, related commands     list.  The front-end should send the respective, related commands
2473     right after to e.g. load an engine, load an instrument and setting     right after to e.g. load an engine, load an instrument and setting
# Line 2457  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519    Schoenebeck               Expires July 18, 2007                [Page 45]
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 44]  
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2522    
2523    
2524        "OK" -        "OK" -
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck               Expires May 29, 2007                 [Page 45]  Schoenebeck               Expires July 18, 2007                [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2578    
2579    
2580        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires May 29, 2007                 [Page 46]  Schoenebeck               Expires July 18, 2007                [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2634    
2635    
2636           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires May 29, 2007                 [Page 47]  Schoenebeck               Expires July 18, 2007                [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2690    
2691    
2692              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires May 29, 2007                 [Page 48]  Schoenebeck               Expires July 18, 2007                [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
2746    
2747    
2748           MUTE -           MUTE -
# Line 2702  Internet-Draft        LinuxSampler Contr Line 2758  Internet-Draft        LinuxSampler Contr
2758              Determines whether this is a solo channel, "true" if the              Determines whether this is a solo channel, "true" if the
2759              channel is a solo channel; "false" otherwise              channel is a solo channel; "false" otherwise
2760    
2761             MIDI_INSTRUMENT_MAP -
2762    
2763                Determines to which MIDI instrument map this sampler channel
2764                is assigned to.  Read chapter "SET CHANNEL
2765                MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2766                values.
2767    
2768     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2769    
2770     Example:     Example:
# Line 2730  Internet-Draft        LinuxSampler Contr Line 2793  Internet-Draft        LinuxSampler Contr
2793    
2794           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2795    
          "MIDI_INPUT_CHANNEL: 5"  
2796    
          "."  
2797    
2798    
2799    Schoenebeck               Expires July 18, 2007                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol         January 2007
2802    
2803    
2804             "MIDI_INPUT_CHANNEL: 5"
2805    
2806             "VOLUME: 1.0"
2807    
2808             "MUTE: false"
2809    
2810             "SOLO: false"
2811    
2812  Schoenebeck               Expires May 29, 2007                 [Page 49]           "MIDI_INSTRUMENT_MAP: NONE"
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2813    
2814             "."
2815    
2816  6.4.11.  Current number of active voices  6.4.11.  Current number of active voices
2817    
# Line 2781  Internet-Draft        LinuxSampler Contr Line 2849  Internet-Draft        LinuxSampler Contr
2849        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
2850        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
2851        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
       return "NA" for not available.  
   
    Example:  
2852    
2853    
2854    
2855  6.4.13.  Current fill state of disk stream buffers  Schoenebeck               Expires July 18, 2007                [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol         January 2007
2858    
    The front-end can ask for the current fill state of all disk streams  
    on a sampler channel by sending the following command:  
2859    
2860          return "NA" for not available.
2861    
2862       Example:
2863    
2864    
2865    
2866  Schoenebeck               Expires May 29, 2007                 [Page 50]  6.4.13.  Current fill state of disk stream buffers
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2867    
2868       The front-end can ask for the current fill state of all disk streams
2869       on a sampler channel by sending the following command:
2870    
2871        GET CHANNEL BUFFER_FILL BYTES <sampler-channel>        GET CHANNEL BUFFER_FILL BYTES <sampler-channel>
2872    
# Line 2837  Internet-Draft        LinuxSampler Contr Line 2904  Internet-Draft        LinuxSampler Contr
2904    
2905        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2906    
2907    
2908    
2909    
2910    
2911    Schoenebeck               Expires July 18, 2007                [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol         January 2007
2914    
2915    
2916        S: ""        S: ""
2917    
2918  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 2849  Internet-Draft        LinuxSampler Contr Line 2925  Internet-Draft        LinuxSampler Contr
2925    
2926     Where <sampler-channel> is the respective sampler channel number as     Where <sampler-channel> is the respective sampler channel number as
2927     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
2928     (Section 6.4.4) command and <audio-device-id> is the numerical ID of     (Section 6.4.4) command and <audio-device-id> is the numerical ID of
2929     the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"     the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
2930     (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)
# Line 2893  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
2962        type>        type>
2963    
2964    
2965    
2966    
2967    Schoenebeck               Expires July 18, 2007                [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol         January 2007
2970    
2971    
2972     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
2973     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
2974    
# Line 2904  Internet-Draft        LinuxSampler Contr Line 2980  Internet-Draft        LinuxSampler Contr
2980    
2981        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2982    
   
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
2983           if audio output type was set, but there are noteworthy issue(s)           if audio output type was set, but there are noteworthy issue(s)
2984           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
2985           message           message
# Line 2949  Internet-Draft        LinuxSampler Contr Line 3016  Internet-Draft        LinuxSampler Contr
3016    
3017        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck               Expires July 18, 2007                [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol         January 2007
3026    
3027    
3028           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3029           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3030           warning message           warning message
# Line 2962  Internet-Draft        LinuxSampler Contr Line 3038  Internet-Draft        LinuxSampler Contr
3038    
3039    
3040    
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
   
   
3041  6.4.17.  Setting MIDI input device  6.4.17.  Setting MIDI input device
3042    
3043     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 3005  Internet-Draft        LinuxSampler Contr Line 3072  Internet-Draft        LinuxSampler Contr
3072    
3073    
3074    
3075    
3076    
3077    
3078    
3079    Schoenebeck               Expires July 18, 2007                [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol         January 2007
3082    
3083    
3084  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
3085    
3086     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 3017  Internet-Draft        LinuxSampler Contr Line 3093  Internet-Draft        LinuxSampler Contr
3093     Where <midi-input-type> is currently only "ALSA" and <sampler-     Where <midi-input-type> is currently only "ALSA" and <sampler-
3094     channel> is the respective sampler channel number.     channel> is the respective sampler channel number.
3095    
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3096     Possible Answers:     Possible Answers:
3097    
3098        "OK" -        "OK" -
# Line 3060  Internet-Draft        LinuxSampler Contr Line 3128  Internet-Draft        LinuxSampler Contr
3128    
3129        "OK" -        "OK" -
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck               Expires July 18, 2007                [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol         January 2007
3138    
3139    
3140           on success           on success
3141    
3142        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3073  Internet-Draft        LinuxSampler Contr Line 3150  Internet-Draft        LinuxSampler Contr
3150           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3151           error message           error message
3152    
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3153     Examples:     Examples:
3154    
3155    
# Line 3117  Internet-Draft        LinuxSampler Contr Line 3186  Internet-Draft        LinuxSampler Contr
3186    
3187    
3188    
3189    
3190    
3191    Schoenebeck               Expires July 18, 2007                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol         January 2007
3194    
3195    
3196    
3197    
3198  6.4.21.  Setting channel volume  6.4.21.  Setting channel volume
3199    
3200     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
# Line 3129  Internet-Draft        LinuxSampler Contr Line 3207  Internet-Draft        LinuxSampler Contr
3207     means amplification) and <sampler-channel> defines the sampler     means amplification) and <sampler-channel> defines the sampler
3208     channel where this volume factor should be set.     channel where this volume factor should be set.
3209    
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3210     Possible Answers:     Possible Answers:
3211    
3212        "OK" -        "OK" -
# Line 3172  Internet-Draft        LinuxSampler Contr Line 3242  Internet-Draft        LinuxSampler Contr
3242    
3243     Possible Answers:     Possible Answers:
3244    
3245    
3246    
3247    Schoenebeck               Expires July 18, 2007                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol         January 2007
3250    
3251    
3252        "OK" -        "OK" -
3253    
3254           on success           on success
# Line 3184  Internet-Draft        LinuxSampler Contr Line 3261  Internet-Draft        LinuxSampler Contr
3261    
3262        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3263    
   
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
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    
# Line 3229  Internet-Draft        LinuxSampler Contr Line 3297  Internet-Draft        LinuxSampler Contr
3297           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3298           error message           error message
3299    
3300    
3301    
3302    
3303    Schoenebeck               Expires July 18, 2007                [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol         January 2007
3306    
3307    
3308     Examples:     Examples:
3309    
3310    
3311    
3312  6.4.24.  Resetting a sampler channel  6.4.24.  Assigning a MIDI instrument map to a sampler channel
3313    
3314     The front-end can reset a particular sampler channel by sending the     The front-end can assign a MIDI instrument map to a specific sampler
3315     following command:     channel by sending the following command:
3316    
3317        RESET CHANNEL <sampler-channel>        SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3318    
3319     Where <sampler-channel> defines the sampler channel to be reset.     Where <sampler-channel> is the respective sampler channel number as
3320       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3321       (Section 6.4.4) command and <map> can have the following
3322       possibilites:
3323    
3324          "NONE" -
3325    
3326             This is the default setting.  In this case the sampler channel
3327             is not assigned any MIDI instrument map and thus will ignore
3328             all MIDI program change messages.
3329    
3330          "DEFAULT" -
3331    
3332             The sampler channel will always use the default MIDI instrument
3333             map to handle MIDI program change messages.
3334    
3335          numeric ID -
3336    
3337             You can assign a specific MIDI instrument map by replacing
3338             <map> with the respective numeric ID of the MIDI instrument map
3339             as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3340             command.  Once that map will be deleted, the sampler channel
3341             would fall back to "NONE".
3342    
3343       Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3344       regarding MIDI instrument mapping.
3345    
3346       Possible Answers:
3347    
3348          "OK" -
3349    
3350             on success
3351    
3352          "ERR:<error-code>:<error-message>" -
3353    
3354             in case it failed, providing an appropriate error code and
3355             error message
3356    
3357    
3358  Schoenebeck               Expires May 29, 2007                 [Page 58]  
3359    Schoenebeck               Expires July 18, 2007                [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol         January 2007
3362    
3363    
3364       Examples:
3365    
3366    
3367    
3368    6.4.25.  Adding an effect send to a sampler channel
3369    
3370       The front-end can create an additional effect send on a specific
3371       sampler channel by sending the following command:
3372    
3373          CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3374    
3375       Where <sampler-channel> is the respective sampler channel number as
3376       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3377       (Section 6.4.4) command, that is the sampler channel on which the
3378       effect send should be created on, <midi-ctrl> is a number between
3379       0..127 defining the MIDI controller which can alter the effect send
3380       level and <name> is an optional argument defining a name for the
3381       effect send entity.  The name does not have to be unique.
3382    
3383       By default, that is as initial routing, the effect send's audio
3384       channels are automatically routed to the last audio channels of the
3385       sampler channel's audio output device, that way you can i.e. first
3386       increase the amount of audio channels on the audio output device for
3387       having dedicated effect send output channels and when "CREATE
3388       FX_SEND" is called, those channels will automatically be picked.  You
3389       can alter the destination channels however with "SET FX_SEND
3390       AUDIO_OUTPUT_CHANNEL" (Section 6.4.30).
3391    
3392       Note: Create effect sends on a sampler channel only when needed,
3393       because having effect sends on a sampler channel will decrease
3394       runtime performance, because for implementing channel effect sends,
3395       separate (sampler channel local) audio buffers are needed to render
3396       and mix the voices and route the audio signal afterwards to the
3397       master outputs and effect send outputs (along with their respective
3398       effect send levels).  A sampler channel without effect sends however
3399       can mix its voices directly into the audio output devices's audio
3400       buffers and is thus faster.
3401    
3402       Possible Answers:
3403    
3404          "OK[<fx-send-id>]" -
3405    
3406             in case a new effect send could be added to the sampler
3407             channel, where <fx-send-id> reflects the unique ID of the newly
3408             created effect send entity
3409    
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires July 18, 2007                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol         January 2007
3418    
3419    
3420          "ERR:<error-code>:<error-message>" -
3421    
3422             when a new effect send could not be added, i.e. due to invalid
3423             parameters
3424    
3425       Examples:
3426    
3427          C: "CREATE FX_SEND 0 91 'Reverb Send'"
3428    
3429          S: "OK[0]"
3430    
3431          C: "CREATE FX_SEND 0 93"
3432    
3433          S: "OK[1]"
3434    
3435    6.4.26.  Removing an effect send from a sampler channel
3436    
3437       The front-end can remove an existing effect send on a specific
3438       sampler channel by sending the following command:
3439    
3440          DESTROY FX_SEND <sampler-channel> <fx-send-id>
3441    
3442       Where <sampler-channel> is the respective sampler channel number as
3443       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3444       (Section 6.4.4) command, that is the sampler channel from which the
3445       effect send should be removed from and <fx-send-id> is the respective
3446       effect send number as returned by the "CREATE FX_SEND"
3447       (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3448    
3449       Possible Answers:
3450    
3451          "OK" -
3452    
3453             on success
3454    
3455          "ERR:<error-code>:<error-message>" -
3456    
3457             in case it failed, providing an appropriate error code and
3458             error message
3459    
3460       Example:
3461    
3462          C: "DESTROY FX_SEND 0 0"
3463    
3464          S: "OK"
3465    
3466    
3467    
3468    
3469    
3470    
3471    Schoenebeck               Expires July 18, 2007                [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol         January 2007
3474    
3475    
3476    6.4.27.  Getting amount of effect sends on a sampler channel
3477    
3478       The front-end can ask for the amount of effect sends on a specific
3479       sampler channel by sending the following command:
3480    
3481          GET FX_SENDS <sampler-channel>
3482    
3483       Where <sampler-channel> is the respective sampler channel number as
3484       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3485       (Section 6.4.4) command.
3486    
3487       Possible Answers:
3488    
3489          The sampler will answer by returning the number of effect sends on
3490          the given sampler channel.
3491    
3492       Example:
3493    
3494          C: "GET FX_SENDS 0"
3495    
3496          S: "2"
3497    
3498    6.4.28.  Listing all effect sends on a sampler channel
3499    
3500       The front-end can ask for a list of effect sends on a specific
3501       sampler channel by sending the following command:
3502    
3503          LIST FX_SENDS <sampler-channel>
3504    
3505       Where <sampler-channel> is the respective sampler channel number as
3506       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3507       (Section 6.4.4) command.
3508    
3509       Possible Answers:
3510    
3511          The sampler will answer by returning a comma separated list with
3512          all effect sends' numerical IDs on the given sampler channel.
3513    
3514       Examples:
3515    
3516          C: "LIST FX_SENDS 0"
3517    
3518          S: "0,1"
3519    
3520          C: "LIST FX_SENDS 1"
3521    
3522          S: ""
3523    
3524    
3525    
3526    
3527    Schoenebeck               Expires July 18, 2007                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol         January 2007
3530    
3531    
3532    6.4.29.  Getting effect send information
3533    
3534       The front-end can ask for the current settings of an effect send
3535       entity by sending the following command:
3536    
3537          GET FX_SEND INFO <sampler-channel> <fx-send-id>
3538    
3539       Where <sampler-channel> is the sampler channel number as returned by
3540       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3541       command and <fx-send-id> reflects the numerical ID of the effect send
3542       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3543       FX_SENDS" (Section 6.4.28) command.
3544    
3545       Possible Answers:
3546    
3547          The sampler will answer by sending a <CRLF> separated list.  Each
3548          answer line begins with the settings category name followed by a
3549          colon and then a space character <SP> and finally the info
3550          character string to that setting category.  At the moment the
3551          following categories are defined:
3552    
3553    
3554    
3555             NAME -
3556    
3557                name of the effect send entity
3558    
3559             MIDI_CONTROLLER -
3560    
3561                a value between 0 and 127 reflecting the MIDI controller
3562                which is able to modify the effect send's send level
3563    
3564             LEVEL -
3565    
3566                optionally dotted number reflecting the effect send's
3567                current send level (where a value < 1.0 means attenuation
3568                and a value > 1.0 means amplification)
3569    
3570             AUDIO_OUTPUT_ROUTING -
3571    
3572                comma separated list which reflects to which audio channel
3573                of the selected audio output device each effect send output
3574                channel is routed to, e.g. "0,3" would mean the effect
3575                send's output channel 0 is routed to channel 0 of the audio
3576                output device and the effect send's output channel 1 is
3577                routed to the channel 3 of the audio output device (see "SET
3578                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires July 18, 2007                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol         January 2007
3586    
3587    
3588       The mentioned fields above don't have to be in particular order.
3589    
3590       Example:
3591    
3592          C: "GET FX_SEND INFO 0 0"
3593    
3594          S: "NAME: Reverb Send"
3595    
3596             "MIDI_CONTROLLER: 91"
3597    
3598             "LEVEL: 0.3"
3599    
3600             "AUDIO_OUTPUT_ROUTING: 2,3"
3601    
3602             "."
3603    
3604    6.4.30.  Altering effect send's audio routing
3605    
3606       The front-end can alter the destination of an effect send's audio
3607       channel on a specific sampler channel by sending the following
3608       command:
3609    
3610          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3611          <audio-src> <audio-dst>
3612    
3613       Where <sampler-chan> is the sampler channel number as returned by the
3614       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3615       command, <fx-send-id> reflects the numerical ID of the effect send
3616       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3617       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3618       of the effect send's audio channel which should be rerouted and
3619       <audio-dst> is the numerical ID of the audio channel of the selected
3620       audio output device where <audio-src> should be routed to.
3621    
3622       Note that effect sends can only route audio to the same audio output
3623       device as assigned to the effect send's sampler channel.  Also note
3624       that an effect send entity does always have exactly as much audio
3625       channels as its sampler channel.  So if the sampler channel is
3626       stereo, the effect send does have two audio channels as well.  Also
3627       keep in mind that the amount of audio channels on a sampler channel
3628       might be dependant not only to the deployed sampler engine on the
3629       sampler channel, but also dependant to the instrument currently
3630       loaded.  However you can (effectively) turn an i.e. stereo effect
3631       send into a mono one by simply altering its audio routing
3632       appropriately.
3633    
3634       Possible Answers:
3635    
3636    
3637    
3638    
3639    Schoenebeck               Expires July 18, 2007                [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol         January 2007
3642    
3643    
3644          "OK" -
3645    
3646             on success
3647    
3648          "WRN:<warning-code>:<warning-message>" -
3649    
3650             if audio output channel was set, but there are noteworthy
3651             issue(s) related, providing an appropriate warning code and
3652             warning message
3653    
3654          "ERR:<error-code>:<error-message>" -
3655    
3656             in case it failed, providing an appropriate error code and
3657             error message
3658    
3659       Example:
3660    
3661          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3662    
3663          S: "OK"
3664    
3665    6.4.31.  Altering effect send's MIDI controller
3666    
3667       The front-end can alter the MIDI controller of an effect send entity
3668       by sending the following command:
3669    
3670          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3671          ctrl>
3672    
3673       Where <sampler-chan> is the sampler channel number as returned by the
3674       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3675       command, <fx-send-id> reflects the numerical ID of the effect send
3676       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3677       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3678       controller which shall be able to modify the effect send's send
3679       level.
3680    
3681       Possible Answers:
3682    
3683          "OK" -
3684    
3685             on success
3686    
3687          "WRN:<warning-code>:<warning-message>" -
3688    
3689             if MIDI controller was set, but there are noteworthy issue(s)
3690             related, providing an appropriate warning code and warning
3691             message
3692    
3693    
3694    
3695    Schoenebeck               Expires July 18, 2007                [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol         January 2007
3698    
3699    
3700          "ERR:<error-code>:<error-message>" -
3701    
3702             in case it failed, providing an appropriate error code and
3703             error message
3704    
3705       Example:
3706    
3707          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3708    
3709          S: "OK"
3710    
3711    6.4.32.  Altering effect send's send level
3712    
3713       The front-end can alter the current send level of an effect send
3714       entity by sending the following command:
3715    
3716          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3717    
3718       Where <sampler-chan> is the sampler channel number as returned by the
3719       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3720       command, <fx-send-id> reflects the numerical ID of the effect send
3721       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3722       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3723       dotted positive number (a value smaller than 1.0 means attenuation,
3724       whereas a value greater than 1.0 means amplification) reflecting the
3725       new send level.
3726    
3727       Possible Answers:
3728    
3729          "OK" -
3730    
3731             on success
3732    
3733          "WRN:<warning-code>:<warning-message>" -
3734    
3735             if new send level was set, but there are noteworthy issue(s)
3736             related, providing an appropriate warning code and warning
3737             message
3738    
3739          "ERR:<error-code>:<error-message>" -
3740    
3741             in case it failed, providing an appropriate error code and
3742             error message
3743    
3744       Example:
3745    
3746    
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires July 18, 2007                [Page 67]
3752    
3753  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
3754    
3755    
3756          C: "SET FX_SEND LEVEL 0 0 0.15"
3757    
3758          S: "OK"
3759    
3760    6.4.33.  Resetting a sampler channel
3761    
3762       The front-end can reset a particular sampler channel by sending the
3763       following command:
3764    
3765          RESET CHANNEL <sampler-channel>
3766    
3767       Where <sampler-channel> defines the sampler channel to be reset.
3768     This will cause the engine on that sampler channel, its voices and     This will cause the engine on that sampler channel, its voices and
3769     eventually disk streams and all control and status variables to be     eventually disk streams and all control and status variables to be
3770     reset.     reset.
# Line 3284  Internet-Draft        LinuxSampler Contr Line 3800  Internet-Draft        LinuxSampler Contr
3800     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3801     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3802    
       SUBSCRIBE <event-id>  
   
    where <event-id> will be replaced by the respective event that client  
    wants to subscribe to.  
3803    
    Possible Answers:  
3804    
       "OK" -  
3805    
          on success  
3806    
3807    Schoenebeck               Expires July 18, 2007                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol         January 2007
3810    
3811    
3812          SUBSCRIBE <event-id>
3813    
3814       where <event-id> will be replaced by the respective event that client
3815       wants to subscribe to.
3816    
3817       Possible Answers:
3818    
3819  Schoenebeck               Expires May 29, 2007                 [Page 59]        "OK" -
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3820    
3821             on success
3822    
3823        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3824    
# Line 3342  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3858           message           message
3859    
       "ERR:<error-code>:<error-message>" -  
   
          in case it failed, providing an appropriate error code and  
          error message  
   
    Examples:  
3860    
3861    
3862    
3863    Schoenebeck               Expires July 18, 2007                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol         January 2007
3866    
3867    
3868          "ERR:<error-code>:<error-message>" -
3869    
3870             in case it failed, providing an appropriate error code and
3871             error message
3872    
3873       Examples:
3874    
 Schoenebeck               Expires May 29, 2007                 [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3875    
3876    
3877  6.5.3.  Enable or disable echo of commands  6.5.3.  Enable or disable echo of commands
# Line 3399  Internet-Draft        LinuxSampler Contr Line 3912  Internet-Draft        LinuxSampler Contr
3912     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
3913     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
3914    
 6.6.  Global commands  
3915    
    The following commands have global impact on the sampler.  
3916    
 6.6.1.  Current number of active voices  
3917    
    The front-end can ask for the current number of active voices on the  
    sampler by sending the following command:  
3918    
3919    Schoenebeck               Expires July 18, 2007                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol         January 2007
3922    
3923    
3924    6.6.  Global commands
3925    
3926       The following commands have global impact on the sampler.
3927    
3928  Schoenebeck               Expires May 29, 2007                 [Page 61]  6.6.1.  Current number of active voices
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3929    
3930       The front-end can ask for the current number of active voices on the
3931       sampler by sending the following command:
3932    
3933        GET TOTAL_VOICE_COUNT        GET TOTAL_VOICE_COUNT
3934    
# Line 3453  Internet-Draft        LinuxSampler Contr Line 3966  Internet-Draft        LinuxSampler Contr
3966    
3967    
3968    
3969    
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires July 18, 2007                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol         January 2007
3978    
3979    
3980  6.6.4.  General sampler informations  6.6.4.  General sampler informations
3981    
3982     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
# Line 3465  Internet-Draft        LinuxSampler Contr Line 3989  Internet-Draft        LinuxSampler Contr
3989        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
3990        answer line begins with the information category name followed by        answer line begins with the information category name followed by
3991        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3992        character string to that information category.  At the moment the        character string to that information category.  At the moment the
3993        following categories are defined:        following categories are defined:
3994    
# Line 3494  Internet-Draft        LinuxSampler Contr Line 4010  Internet-Draft        LinuxSampler Contr
4010     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4011     Other fields might be added in future.     Other fields might be added in future.
4012    
4013    6.6.5.  Getting global volume attenuation
4014    
4015       The client can ask for the current global sampler-wide volume
4016       attenuation by sending the following command:
4017    
4018          GET VOLUME
4019    
4020       Possible Answers:
4021    
4022          The sampler will always answer by returning the optional dotted
4023          floating point coefficient, reflecting the current global volume
4024          attenuation.
4025    
4026       Note: it is up to the respective sampler engine whether to obey that
4027       global volume parameter or not, but in general all engines SHOULD use
4028    
4029    
4030    
4031    Schoenebeck               Expires July 18, 2007                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol         January 2007
4034    
4035    
4036       this parameter.
4037    
4038    6.6.6.  Setting global volume attenuation
4039    
4040       The client can alter the current global sampler-wide volume
4041       attenuation by sending the following command:
4042    
4043          SET VOLUME <volume>
4044    
4045       Where <volume> should be replaced by the optional dotted floating
4046       point value, reflecting the new global volume parameter.  This value
4047       might usually be in the range between 0.0 and 1.0, that is for
4048       attenuating the overall volume.
4049    
4050       Possible Answers:
4051    
4052          "OK" -
4053    
4054             on success
4055    
4056          "WRN:<warning-code>:<warning-message>" -
4057    
4058             if the global volume was set, but there are noteworthy issue(s)
4059             related, providing an appropriate warning code and warning
4060             message
4061    
4062          "ERR:<error-code>:<error-message>" -
4063    
4064             in case it failed, providing an appropriate error code and
4065             error message
4066    
4067    6.7.  MIDI Instrument Mapping
4068    
4069       The MIDI protocol provides a way to switch between instruments by
4070       sending so called MIDI bank select and MIDI program change messages
4071       which are essentially just numbers.  The following commands allow to
4072       actually map arbitrary MIDI bank select / program change numbers with
4073       real instruments.
4074    
4075       The sampler allows to manage an arbitrary amount of MIDI instrument
4076       maps which define which instrument to load on which MIDI program
4077       change message.
4078    
4079       By default, that is when the sampler is launched, there is no map,
4080       thus the sampler will simply ignore all program change messages.  The
4081       front-end has to explicitly create at least one map, add entries to
4082       the map and tell the respective sampler channel(s) which MIDI
4083       instrument map to use, so the sampler knows how to react on a given
4084    
4085    
4086    
4087    Schoenebeck               Expires July 18, 2007                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol         January 2007
4090    
4091    
4092       program change message on the respective sampler channel, that is by
4093       switching to the respectively defined engine type and loading the
4094       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4095       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4096       channel.
4097    
4098       Also note per MIDI specification a bank select message does not cause
4099       to switch to another instrument.  Instead when receiving a bank
4100       select message the bank value will be stored and a subsequent program
4101       change message (which may occur at any time) will finally cause the
4102       sampler to switch to the respective instrument as reflected by the
4103       current MIDI instrument map.
4104    
4105  Schoenebeck               Expires May 29, 2007                 [Page 63]  6.7.1.  Create a new MIDI instrument map
4106    
4107       The front-end can add a new MIDI instrument map by sending the
4108       following command:
4109    
4110          ADD MIDI_INSTRUMENT_MAP [<name>]
4111    
4112       Where <name> is an optional argument allowing to assign a custom name
4113       to the new map.  MIDI instrument Map names do not have to be unique.
4114    
4115       Possible Answers:
4116    
4117          "OK[<map>]" -
4118    
4119             in case a new MIDI instrument map could be added, where <map>
4120             reflects the unique ID of the newly created MIDI instrument map
4121    
4122          "ERR:<error-code>:<error-message>" -
4123    
4124             when a new map could not be created, which might never occur in
4125             practice
4126    
4127       Examples:
4128    
4129          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4130    
4131          S: "OK[0]"
4132    
4133          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4134    
4135          S: "OK[1]"
4136    
4137          C: "ADD MIDI_INSTRUMENT_MAP"
4138    
4139    
4140    
4141    
4142    
4143    Schoenebeck               Expires July 18, 2007                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol         January 2007
4146    
4147    
4148          S: "OK[5]"
4149    
4150    6.7.2.  Delete one particular or all MIDI instrument maps
4151    
4152       The front-end can delete a particular MIDI instrument map by sending
4153       the following command:
4154    
4155          REMOVE MIDI_INSTRUMENT_MAP <map>
4156    
4157       Where <map> reflects the unique ID of the map to delete as returned
4158       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4159    
4160       The front-end can delete all MIDI instrument maps by sending the
4161       following command:
4162    
4163          REMOVE MIDI_INSTRUMENT_MAP ALL
4164    
4165       Possible Answers:
4166    
4167          "OK" -
4168    
4169             in case the map(s) could be deleted
4170    
4171          "ERR:<error-code>:<error-message>" -
4172    
4173             when the given map does not exist
4174    
4175       Examples:
4176    
4177          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4178    
4179          S: "OK"
4180    
4181          C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
4182    
4183          S: "OK"
4184    
4185    6.7.3.  Get amount of existing MIDI instrument maps
4186    
4187       The front-end can retrieve the current amount of MIDI instrument maps
4188       by sending the following command:
4189    
4190          GET MIDI_INSTRUMENT_MAPS
4191    
4192       Possible Answers:
4193    
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck               Expires July 18, 2007                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol         January 2007
4202    
4203    
4204          The sampler will answer by returning the current number of MIDI
4205          instrument maps.
4206    
4207       Example:
4208    
4209          C: "GET MIDI_INSTRUMENT_MAPS"
4210    
4211          S: "2"
4212    
4213    6.7.4.  Getting all created MIDI instrument maps
4214    
4215       The number of MIDI instrument maps can change on runtime.  To get the
4216       current list of MIDI instrument maps, the front-end can send the
4217       following command:
4218    
4219          LIST MIDI_INSTRUMENT_MAPS
4220    
4221       Possible Answers:
4222    
4223          The sampler will answer by returning a comma separated list with
4224          all MIDI instrument maps' numerical IDs.
4225    
4226       Example:
4227    
4228          C: "LIST MIDI_INSTRUMENT_MAPS"
4229    
4230          S: "0,1,5,12"
4231    
4232    6.7.5.  Getting MIDI instrument map information
4233    
4234       The front-end can ask for the current settings of a MIDI instrument
4235       map by sending the following command:
4236    
4237          GET MIDI_INSTRUMENT_MAP INFO <map>
4238    
4239       Where <map> is the numerical ID of the map the front-end is
4240       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4241       (Section 6.7.4) command.
4242    
4243       Possible Answers:
4244    
4245          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4246          answer line begins with the settings category name followed by a
4247          colon and then a space character <SP> and finally the info
4248          character string to that setting category.  At the moment the
4249          following categories are defined:
4250    
4251    
4252    
4253    
4254    
4255    Schoenebeck               Expires July 18, 2007                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol         January 2007
4258    
4259    
4260    
4261    
4262             NAME -
4263    
4264                custom name of the given map, which does not have to be
4265                unique
4266    
4267       The mentioned fields above don't have to be in particular order.
4268    
4269       Example:
4270    
4271          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4272    
4273          S: "NAME: Standard Map"
4274    
4275             "."
4276    
4277    6.7.6.  Renaming a MIDI instrument map
4278    
4279       The front-end can alter the custom name of a MIDI instrument map by
4280       sending the following command:
4281    
4282          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4283    
4284       Where <map> is the numerical ID of the map and <name> the new custom
4285       name of the map, which does not have to be unique.
4286    
4287       Possible Answers:
4288    
4289          "OK" -
4290    
4291             on success
4292    
4293          "ERR:<error-code>:<error-message>" -
4294    
4295             in case the given map does not exist
4296    
4297       Example:
4298    
4299          C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4300    
4301          S: "OK"
4302    
4303    6.7.7.  Create or replace a MIDI instrument map entry
4304    
4305       The front-end can create a new or replace an existing entry in a
4306       sampler's MIDI instrument map by sending the following command:
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires July 18, 2007                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol         January 2007
4314    
4315    
4316          MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>
4317          <filename> <instrument_index> <volume_value> [<instr_load_mode>]
4318          [<name>]
4319    
4320       Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4321       integer value between 0..16383 reflecting the MIDI bank select index,
4322       <midi_prog> an integer value between 0..127 reflecting the MIDI
4323       program change index, <engine_name> a sampler engine name as returned
4324       by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4325       encapsulated into apostrophes), <filename> the name of the
4326       instrument's file to be deployed (encapsulated into apostrophes),
4327       <instrument_index> the index (integer value) of the instrument within
4328       the given file, <volume_value> reflects the master volume of the
4329       instrument as optionally dotted number (where a value < 1.0 means
4330       attenuation and a value > 1.0 means amplification).  This parameter
4331       easily allows to adjust the volume of all intruments within a custom
4332       instrument map without having to adjust their instrument files.  The
4333       OPTIONAL <instr_load_mode> argument defines the life time of the
4334       instrument, that is when the instrument should be loaded, when freed
4335       and has exactly the following possibilities:
4336    
4337          "ON_DEMAND" -
4338    
4339             The instrument will be loaded when needed, that is when
4340             demanded by at least one sampler channel.  It will immediately
4341             be freed from memory when not needed by any sampler channel
4342             anymore.
4343    
4344          "ON_DEMAND_HOLD" -
4345    
4346             The instrument will be loaded when needed, that is when
4347             demanded by at least one sampler channel.  It will be kept in
4348             memory even when not needed by any sampler channel anymore.
4349             Instruments with this mode are only freed when the sampler is
4350             reset or all mapping entries with this mode (and respective
4351             instrument) are explicitly changed to "ON_DEMAND" and no
4352             sampler channel is using the instrument anymore.
4353    
4354          "PERSISTENT" -
4355    
4356             The instrument will immediately be loaded into memory in the
4357             background when this mapping command is sent and the instrument
4358             is kept all the time.  Instruments with this mode are only
4359             freed when the sampler is reset or all mapping entries with
4360             this mode (and respective instrument) are explicitly changed to
4361             "ON_DEMAND" and no sampler channel is using the instrument
4362             anymore.
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires July 18, 2007                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol         January 2007
4370    
4371    
4372          not supplied -
4373    
4374             In case there is no <instr_load_mode> argument given, it will
4375             be up to the InstrumentManager to decide which mode to use.
4376             Usually it will use "ON_DEMAND" if an entry for the given
4377             instrument does not exist in the InstrumentManager's list yet,
4378             otherwise if an entry already exists, it will simply stick with
4379             the mode currently reflected by the already existing entry,
4380             that is it will not change the mode.
4381    
4382       The <instr_load_mode> argument thus allows to define an appropriate
4383       strategy (low memory consumption vs. fast instrument switching) for
4384       each instrument individually.  Note, the following restrictions apply
4385       to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4386       supported by the respective sampler engine (which is technically the
4387       case when the engine provides an InstrumentManager for its format).
4388       If this is not the case the argument will automatically fall back to
4389       the default value "ON_DEMAND".  Also the load mode of one instrument
4390       may automatically change the laod mode of other instrument(s), i.e.
4391       because the instruments are part of the same file and the engine does
4392       not allow a way to manage load modes for them individually.  Due to
4393       this, in case the frontend shows the load modes of entries, the
4394       frontend should retrieve the actual mode by i.e. sending "GET
4395       MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4396       OPTIONAL <name> argument allows to set a custom name (encapsulated
4397       into apostrophes) for the mapping entry, useful for frontends for
4398       displaying an appropriate name for mapped instruments (using "GET
4399       MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4400    
4401       The "MAP MIDI_INSTRUMENT" command will immediately return, thus it
4402       will not block when an instrument is to be loaded due to a
4403       "PERSISTENT" type entry as instruments are loaded in the background.
4404       As a consequence this command may not necessarily return an error
4405       i.e. when the given instrument file does not exist or may turn out to
4406       be corrupt.
4407    
4408       Possible Answers:
4409    
4410          "OK" -
4411    
4412             usually
4413    
4414          "ERR:<error-code>:<error-message>" -
4415    
4416             when the given map or engine does not exist or a value is out
4417             of range
4418    
4419       Examples:
4420    
4421    
4422    
4423    Schoenebeck               Expires July 18, 2007                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol         January 2007
4426    
4427    
4428          C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4429          0.8 PERSISTENT"
4430    
4431          S: "OK"
4432    
4433          C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
4434          1.0"
4435    
4436          S: "OK"
4437    
4438          C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0
4439          'Normal Piano'"
4440    
4441          S: "OK"
4442    
4443          C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4444          'Silent Piano'"
4445    
4446          S: "OK"
4447    
4448          C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0
4449          PERSISTENT 'Foo Drumkit'"
4450    
4451          S: "OK"
4452    
4453    6.7.8.  Getting ammount of MIDI instrument map entries
4454    
4455       The front-end can query the amount of currently existing entries in a
4456       MIDI instrument map by sending the following command:
4457    
4458          GET MIDI_INSTRUMENTS <map>
4459    
4460       The front-end can query the amount of currently existing entries in
4461       all MIDI instrument maps by sending the following command:
4462    
4463          GET MIDI_INSTRUMENTS ALL
4464    
4465       Possible Answers:
4466    
4467          The sampler will answer by sending the current number of entries
4468          in the MIDI instrument map(s).
4469    
4470       Example:
4471    
4472          C: "GET MIDI_INSTRUMENTS 0"
4473    
4474          S: "234"
4475    
4476    
4477    
4478    
4479    Schoenebeck               Expires July 18, 2007                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol         January 2007
4482    
4483    
4484          C: "GET MIDI_INSTRUMENTS ALL"
4485    
4486          S: "954"
4487    
4488    6.7.9.  Getting indeces of all entries of a MIDI instrument map
4489    
4490       The front-end can query a list of all currently existing entries in a
4491       certain MIDI instrument map by sending the following command:
4492    
4493          LIST MIDI_INSTRUMENTS <map>
4494    
4495       Where <map> is the numeric ID of the MIDI instrument map.
4496    
4497       The front-end can query a list of all currently existing entries of
4498       all MIDI instrument maps by sending the following command:
4499    
4500          LIST MIDI_INSTRUMENTS ALL
4501    
4502       Possible Answers:
4503    
4504          The sampler will answer by sending a comma separated list of map
4505          ID - MIDI bank - MIDI program triples, where each triple is
4506          encapsulated into curly braces.  The list is returned in one
4507          single line.  Each triple just reflects the key of the respective
4508          map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4509          (Section 6.7.11) command(s) are necessary to retrieve detailed
4510          informations about each entry.
4511    
4512       Example:
4513    
4514          C: "LIST MIDI_INSTRUMENTS 0"
4515    
4516          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4517    
4518    6.7.10.  Remove an entry from the MIDI instrument map
4519    
4520       The front-end can delete an entry from a MIDI instrument map by
4521       sending the following command:
4522    
4523          UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4524    
4525       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4526       is an integer value between 0..16383 reflecting the MIDI bank value
4527       and <midi_prog> an integer value between 0..127 reflecting the MIDI
4528       program value of the map's entrie's key index triple.
4529    
4530       Possible Answers:
4531    
4532    
4533    
4534    
4535    Schoenebeck               Expires July 18, 2007                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol         January 2007
4538    
4539    
4540          "OK" -
4541    
4542             usually
4543    
4544          "ERR:<error-code>:<error-message>" -
4545    
4546             when index out of bounds
4547    
4548       Example:
4549    
4550          C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4551    
4552          S: "OK"
4553    
4554    6.7.11.  Get current settings of MIDI instrument map entry
4555    
4556       The front-end can retrieve the current settings of a certain
4557       instrument map entry by sending the following command:
4558    
4559          GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
4560    
4561       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4562       is an integer value between 0..16383 reflecting the MIDI bank value,
4563       <midi_bank> and <midi_prog> an integer value between 0..127
4564       reflecting the MIDI program value of the map's entrie's key index
4565       triple.
4566    
4567       Possible Answers:
4568    
4569          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4570          answer line begins with the information category name followed by
4571          a colon and then a space character <SP> and finally the info
4572          character string to that info category.  At the moment the
4573          following categories are defined:
4574    
4575          "NAME" -
4576    
4577             Name for this MIDI instrument map entry (if defined).  This
4578             name shall be used by frontends for displaying a name for this
4579             mapped instrument.  It can be set and changed with the "MAP
4580             MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4581             be unique.
4582    
4583          "ENGINE_NAME" -
4584    
4585             Name of the engine to be deployed for this instrument.
4586    
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires July 18, 2007                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol         January 2007
4594    
4595    
4596          "INSTRUMENT_FILE" -
4597    
4598             File name of the instrument.
4599    
4600          "INSTRUMENT_NR" -
4601    
4602             Index of the instrument within the file.
4603    
4604          "INSTRUMENT_NAME" -
4605    
4606             Name of the loaded instrument as reflected by its file.  In
4607             contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4608             cannot be changed.
4609    
4610          "LOAD_MODE" -
4611    
4612             Life time of instrument (see "MAP MIDI_INSTRUMENT"
4613             (Section 6.7.7) for details about this setting).
4614    
4615          "VOLUME" -
4616    
4617             master volume of the instrument as optionally dotted number
4618             (where a value < 1.0 means attenuation and a value > 1.0 means
4619             amplification)
4620    
4621          The mentioned fields above don't have to be in particular order.
4622    
4623       Example:
4624    
4625          C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4626    
4627          S: "NAME: Drums for Foo Song"
4628    
4629             "ENGINE_NAME: GigEngine"
4630    
4631             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4632    
4633             "INSTRUMENT_NR: 0"
4634    
4635             "INSTRUMENT_NAME: Joe's Drumkit"
4636    
4637             "LOAD_MODE: PERSISTENT"
4638    
4639             "VOLUME: 1.0"
4640    
4641             "."
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires July 18, 2007                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol         January 2007
4650    
4651    
4652    6.7.12.  Clear MIDI instrument map
4653    
4654       The front-end can clear a whole MIDI instrument map, that is delete
4655       all its entries by sending the following command:
4656    
4657          CLEAR MIDI_INSTRUMENTS <map>
4658    
4659       Where <map> is the numeric ID of the map to clear.
4660    
4661       The front-end can clear all MIDI instrument maps, that is delete all
4662       entries of all maps by sending the following command:
4663    
4664          CLEAR MIDI_INSTRUMENTS ALL
4665    
4666       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4667       only their entries, thus the map's settings like custom name will be
4668       preservevd.
4669    
4670       Possible Answers:
4671    
4672          "OK" -
4673    
4674             always
4675    
4676       Examples:
4677    
4678          C: "CLEAR MIDI_INSTRUMENTS 0"
4679    
4680          S: "OK"
4681    
4682          C: "CLEAR MIDI_INSTRUMENTS ALL"
4683    
4684          S: "OK"
4685    
4686    
4687    
4688    
4689    
4690    
4691    
4692    
4693    
4694    
4695    
4696    
4697    
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires July 18, 2007                [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4706    
4707    
4708  7.  Command Syntax  7.  Command Syntax
# Line 3565  Internet-Draft        LinuxSampler Contr Line 4741  Internet-Draft        LinuxSampler Contr
4741    
4742     command =     command =
4743    
4744        ADD SP CHANNEL        ADD SP add_instruction
4745    
4746          / MAP SP map_instruction
4747    
4748          / UNMAP SP unmap_instruction
4749    
4750        / GET SP get_instruction        / GET SP get_instruction
4751    
# Line 3573  Internet-Draft        LinuxSampler Contr Line 4753  Internet-Draft        LinuxSampler Contr
4753    
4754        / DESTROY SP destroy_instruction        / DESTROY SP destroy_instruction
4755    
       / LIST SP list_instruction  
4756    
       / LOAD SP load_instruction  
4757    
4758    
4759    Schoenebeck               Expires July 18, 2007                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol         January 2007
4762    
4763    
4764  Schoenebeck               Expires May 29, 2007                 [Page 64]        / LIST SP list_instruction
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4765    
4766          / LOAD SP load_instruction
4767    
4768        / REMOVE SP CHANNEL SP sampler_channel        / REMOVE SP remove_instruction
4769    
4770        / SET SP set_instruction        / SET SP set_instruction
4771    
# Line 3595  Internet-Draft        LinuxSampler Contr Line 4775  Internet-Draft        LinuxSampler Contr
4775    
4776        / SELECT SP text        / SELECT SP text
4777    
4778        / RESET SP CHANNEL SP sampler_channel        / RESET SP reset_instruction
4779    
4780          / CLEAR SP clear_instruction
4781    
4782        / RESET        / RESET
4783    
4784        / QUIT        / QUIT
4785    
4786       add_instruction =
4787    
4788          CHANNEL
4789    
4790          / MIDI_INSTRUMENT_MAP
4791    
4792          / MIDI_INSTRUMENT_MAP SP map_name
4793    
4794     subscribe_event =     subscribe_event =
4795    
4796        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4797    
4798          / AUDIO_OUTPUT_DEVICE_INFO
4799    
4800          / MIDI_INPUT_DEVICE_COUNT
4801    
4802          / MIDI_INPUT_DEVICE_INFO
4803    
4804          / CHANNEL_COUNT
4805    
4806        / VOICE_COUNT        / VOICE_COUNT
4807    
# Line 3611  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809    
4810        / BUFFER_FILL        / BUFFER_FILL
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires July 18, 2007                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol         January 2007
4818    
4819    
4820        / CHANNEL_INFO        / CHANNEL_INFO
4821    
4822          / MIDI_INSTRUMENT_MAP_COUNT
4823    
4824          / MIDI_INSTRUMENT_MAP_INFO
4825    
4826          / MIDI_INSTRUMENT_COUNT
4827    
4828          / MIDI_INSTRUMENT_INFO
4829    
4830        / MISCELLANEOUS        / MISCELLANEOUS
4831    
4832        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4833    
4834     unsubscribe_event =     unsubscribe_event =
4835    
4836        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4837    
4838          / AUDIO_OUTPUT_DEVICE_INFO
4839    
4840          / MIDI_INPUT_DEVICE_COUNT
4841    
4842          / MIDI_INPUT_DEVICE_INFO
4843    
4844          / CHANNEL_COUNT
4845    
4846        / VOICE_COUNT        / VOICE_COUNT
4847    
# Line 3629  Internet-Draft        LinuxSampler Contr Line 4851  Internet-Draft        LinuxSampler Contr
4851    
4852        / CHANNEL_INFO        / CHANNEL_INFO
4853    
4854          / MIDI_INSTRUMENT_MAP_COUNT
4855    
4856          / MIDI_INSTRUMENT_MAP_INFO
4857    
4858          / MIDI_INSTRUMENT_COUNT
4859    
4860          / MIDI_INSTRUMENT_INFO
4861    
4862        / MISCELLANEOUS        / MISCELLANEOUS
4863    
4864        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4865    
4866       map_instruction =
4867    
4868    
4869    
4870  Schoenebeck               Expires May 29, 2007                 [Page 65]  
4871    Schoenebeck               Expires July 18, 2007                [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
4874    
4875    
4876          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4877          engine_name SP filename SP instrument_index SP volume_value
4878    
4879          / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4880          engine_name SP filename SP instrument_index SP volume_value SP
4881          instr_load_mode
4882    
4883          / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4884          engine_name SP filename SP instrument_index SP volume_value SP
4885          entry_name
4886    
4887          / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4888          engine_name SP filename SP instrument_index SP volume_value SP
4889          instr_load_mode SP entry_name
4890    
4891       unmap_instruction =
4892    
4893          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
4894    
4895       remove_instruction =
4896    
4897          CHANNEL SP sampler_channel
4898    
4899          / MIDI_INSTRUMENT_MAP SP midi_map
4900    
4901          / MIDI_INSTRUMENT_MAP SP ALL
4902    
4903     get_instruction =     get_instruction =
4904    
# Line 3663  Internet-Draft        LinuxSampler Contr Line 4922  Internet-Draft        LinuxSampler Contr
4922        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
4923        key_val_list        key_val_list
4924    
4925    
4926    
4927    Schoenebeck               Expires July 18, 2007                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol         January 2007
4930    
4931    
4932        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
4933    
4934        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 3688  Internet-Draft        LinuxSampler Contr Line 4954  Internet-Draft        LinuxSampler Contr
4954    
4955        / CHANNEL SP STREAM_COUNT SP sampler_channel        / CHANNEL SP STREAM_COUNT SP sampler_channel
4956    
4957          / CHANNEL SP VOICE_COUNT SP sampler_channel
4958    
4959          / ENGINE SP INFO SP engine_name
4960    
4961          / SERVER SP INFO
4962    
4963          / TOTAL_VOICE_COUNT
4964    
4965  Schoenebeck               Expires May 29, 2007                 [Page 66]        / TOTAL_VOICE_COUNT_MAX
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4966    
4967          / MIDI_INSTRUMENTS SP midi_map
4968    
4969        / CHANNEL SP VOICE_COUNT SP sampler_channel        / MIDI_INSTRUMENTS SP ALL
4970    
4971          / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
4972    
4973          / MIDI_INSTRUMENT_MAPS
4974    
4975          / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
4976    
4977          / FX_SENDS SP sampler_channel
4978    
       / ENGINE SP INFO SP engine_name  
4979    
       / SERVER SP INFO  
4980    
       / TOTAL_VOICE_COUNT  
4981    
4982        / TOTAL_VOICE_COUNT_MAX  
4983    Schoenebeck               Expires July 18, 2007                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol         January 2007
4986    
4987    
4988          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
4989    
4990          / VOLUME
4991    
4992     set_instruction =     set_instruction =
4993    
# Line 3723  Internet-Draft        LinuxSampler Contr Line 5005  Internet-Draft        LinuxSampler Contr
5005    
5006        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
5007    
5008          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5009    
5010          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
5011          SP audio_channel_index SP audio_channel_index
5012    
5013          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
5014          midi_ctrl
5015    
5016          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
5017          volume_value
5018    
5019        / ECHO SP boolean        / ECHO SP boolean
5020    
5021          / VOLUME SP volume_value
5022    
5023     create_instruction =     create_instruction =
5024    
5025        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 3735  Internet-Draft        LinuxSampler Contr Line 5030  Internet-Draft        LinuxSampler Contr
5030    
5031        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
5032    
5033     destroy_instruction =        / FX_SEND SP sampler_channel SP midi_ctrl
5034    
       AUDIO_OUTPUT_DEVICE SP number  
5035    
       / MIDI_INPUT_DEVICE SP number  
5036    
    load_instruction =  
5037    
       INSTRUMENT SP load_instr_args  
5038    
5039    Schoenebeck               Expires July 18, 2007                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol         January 2007
5042    
5043    
5044          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
5045    
5046  Schoenebeck               Expires May 29, 2007                 [Page 67]     reset_instruction =
5047    
5048  Internet-Draft        LinuxSampler Control Protocol        November 2006        CHANNEL SP sampler_channel
5049    
5050       clear_instruction =
5051    
5052          MIDI_INSTRUMENTS SP midi_map
5053    
5054          / MIDI_INSTRUMENTS SP ALL
5055    
5056       destroy_instruction =
5057    
5058          AUDIO_OUTPUT_DEVICE SP number
5059    
5060          / MIDI_INPUT_DEVICE SP number
5061    
5062          / FX_SEND SP sampler_channel SP fx_send_id
5063    
5064       load_instruction =
5065    
5066          INSTRUMENT SP load_instr_args
5067    
5068        / ENGINE SP load_engine_args        / ENGINE SP load_engine_args
5069    
# Line 3776  Internet-Draft        LinuxSampler Contr Line 5088  Internet-Draft        LinuxSampler Contr
5088    
5089        / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name        / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires July 18, 2007                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol         January 2007
5098    
5099    
5100        / VOLUME SP sampler_channel SP volume_value        / VOLUME SP sampler_channel SP volume_value
5101    
5102        / MUTE SP sampler_channel SP boolean        / MUTE SP sampler_channel SP boolean
5103    
5104        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
5105    
5106          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
5107    
5108          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
5109    
5110          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
5111    
5112     key_val_list =     key_val_list =
5113    
5114        string '=' param_val_list        string '=' param_val_list
# Line 3800  Internet-Draft        LinuxSampler Contr Line 5127  Internet-Draft        LinuxSampler Contr
5127    
5128        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
5129    
5130          / CHANNELS
5131    
5132          / AVAILABLE_ENGINES
5133    
5134          / AVAILABLE_MIDI_INPUT_DRIVERS
5135    
5136          / AVAILABLE_AUDIO_OUTPUT_DRIVERS
5137    
5138  Schoenebeck               Expires May 29, 2007                 [Page 68]        / MIDI_INSTRUMENTS SP midi_map
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5139    
5140          / MIDI_INSTRUMENTS SP ALL
5141    
5142        / CHANNELS        / MIDI_INSTRUMENT_MAPS
5143    
5144        / AVAILABLE_ENGINES        / FX_SENDS SP sampler_channel
5145    
5146        / AVAILABLE_MIDI_INPUT_DRIVERS     load_instr_args =
5147    
       / AVAILABLE_AUDIO_OUTPUT_DRIVERS  
5148    
5149     load_instr_args =  
5150    
5151    Schoenebeck               Expires July 18, 2007                [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol         January 2007
5154    
5155    
5156        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
5157    
# Line 3827  Internet-Draft        LinuxSampler Contr Line 5161  Internet-Draft        LinuxSampler Contr
5161    
5162        engine_name SP sampler_channel        engine_name SP sampler_channel
5163    
5164       instr_load_mode =
5165    
5166          ON_DEMAND
5167    
5168          / ON_DEMAND_HOLD
5169    
5170          / PERSISTENT
5171    
5172     device_index =     device_index =
5173    
5174        number        number
# Line 3853  Internet-Draft        LinuxSampler Contr Line 5195  Internet-Draft        LinuxSampler Contr
5195    
5196        string        string
5197    
5198     volume_value =     midi_map =
5199    
5200        dotnum        number
5201    
5202       midi_bank =
5203    
5204    
5205    
5206    
5207  Schoenebeck               Expires May 29, 2007                 [Page 69]  Schoenebeck               Expires July 18, 2007                [Page 93]
5208    
5209  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5210    
5211    
5212          number
5213    
5214       midi_prog =
5215    
5216          number
5217    
5218       midi_ctrl =
5219    
5220          number
5221    
5222       volume_value =
5223    
5224          dotnum
5225    
5226        / number        / number
5227    
# Line 3875  Internet-Draft        LinuxSampler Contr Line 5233  Internet-Draft        LinuxSampler Contr
5233    
5234        number        number
5235    
5236       fx_send_id =
5237    
5238          number
5239    
5240     engine_name =     engine_name =
5241    
5242        string        string
# Line 3883  Internet-Draft        LinuxSampler Contr Line 5245  Internet-Draft        LinuxSampler Contr
5245    
5246        stringval        stringval
5247    
5248       map_name =
5249    
5250          stringval
5251    
5252       entry_name =
5253    
5254          stringval
5255    
5256       fx_send_name =
5257    
5258          stringval
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires July 18, 2007                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol         January 2007
5266    
5267    
5268     param_val_list =     param_val_list =
5269    
5270        param_val        param_val
# Line 3916  Internet-Draft        LinuxSampler Contr Line 5298  Internet-Draft        LinuxSampler Contr
5298    
5299    
5300    
5301  Schoenebeck               Expires May 29, 2007                 [Page 70]  
5302    
5303    
5304    
5305    
5306    
5307    
5308    
5309    
5310    
5311    
5312    
5313    
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires July 18, 2007                [Page 95]
5320    
5321  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5322    
5323    
5324  8.  Events  8.  Events
# Line 3926  Internet-Draft        LinuxSampler Contr Line 5326  Internet-Draft        LinuxSampler Contr
5326     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
5327     LinuxSampler.     LinuxSampler.
5328    
5329  8.1.  Number of sampler channels changed  8.1.  Number of audio output devices changed
5330    
5331       Client may want to be notified when the total number of audio output
5332       devices on the back-end changes by issuing the following command:
5333    
5334          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
5335    
5336       Server will start sending the following notification messages:
5337    
5338          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
5339    
5340       where <devices> will be replaced by the new number of audio output
5341       devices.
5342    
5343    8.2.  Audio output device's settings changed
5344    
5345       Client may want to be notified when changes were made to audio output
5346       devices on the back-end by issuing the following command:
5347    
5348          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
5349    
5350       Server will start sending the following notification messages:
5351    
5352          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
5353    
5354       where <device-id> will be replaced by the numerical ID of the audio
5355       output device, which settings has been changed.  The front-end will
5356       have to send the respective command to actually get the audio output
5357       device info.  Because these messages will be triggered by LSCP
5358       commands issued by other clients rather than real time events
5359       happening on the server, it is believed that an empty notification
5360       message is sufficient here.
5361    
5362    8.3.  Number of MIDI input devices changed
5363    
5364       Client may want to be notified when the total number of MIDI input
5365       devices on the back-end changes by issuing the following command:
5366    
5367          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
5368    
5369       Server will start sending the following notification messages:
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires July 18, 2007                [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol         January 2007
5378    
5379    
5380          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
5381    
5382       where <devices> will be replaced by the new number of MIDI input
5383       devices.
5384    
5385    8.4.  MIDI input device's settings changed
5386    
5387       Client may want to be notified when changes were made to MIDI input
5388       devices on the back-end by issuing the following command:
5389    
5390          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
5391    
5392       Server will start sending the following notification messages:
5393    
5394          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
5395    
5396       where <device-id> will be replaced by the numerical ID of the MIDI
5397       input device, which settings has been changed.  The front-end will
5398       have to send the respective command to actually get the MIDI input
5399       device info.  Because these messages will be triggered by LSCP
5400       commands issued by other clients rather than real time events
5401       happening on the server, it is believed that an empty notification
5402       message is sufficient here.
5403    
5404    8.5.  Number of sampler channels changed
5405    
5406     Client may want to be notified when the total number of channels on     Client may want to be notified when the total number of channels on
5407     the back-end changes by issuing the following command:     the back-end changes by issuing the following command:
# Line 3940  Internet-Draft        LinuxSampler Contr Line 5415  Internet-Draft        LinuxSampler Contr
5415     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
5416     channels.     channels.
5417    
5418  8.2.  Number of active voices changed  8.6.  Number of active voices changed
5419    
5420     Client may want to be notified when the number of voices on the back-     Client may want to be notified when the number of voices on the back-
5421     end changes by issuing the following command:     end changes by issuing the following command:
# Line 3949  Internet-Draft        LinuxSampler Contr Line 5424  Internet-Draft        LinuxSampler Contr
5424    
5425     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5426    
5427    
5428    
5429    
5430    
5431    Schoenebeck               Expires July 18, 2007                [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol         January 2007
5434    
5435    
5436        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>
5437    
5438     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5439     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
5440     voices on that channel.     voices on that channel.
5441    
5442  8.3.  Number of active disk streams changed  8.7.  Number of active disk streams changed
5443    
5444     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
5445     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 3969  Internet-Draft        LinuxSampler Contr Line 5453  Internet-Draft        LinuxSampler Contr
5453    
5454     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5455     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
5456     active disk streams on that channel.     active disk streams on that channel.
5457    
5458  8.4.  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
5459    
5460     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
5461     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 3996  Internet-Draft        LinuxSampler Contr Line 5472  Internet-Draft        LinuxSampler Contr
5472     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
5473     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
5474    
5475  8.5.  Channel information changed  8.9.  Channel information changed
5476    
5477     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
5478     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
# Line 4005  Internet-Draft        LinuxSampler Contr Line 5481  Internet-Draft        LinuxSampler Contr
5481    
5482     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires July 18, 2007                [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol         January 2007
5490    
5491    
5492        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
5493    
5494     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
# Line 4014  Internet-Draft        LinuxSampler Contr Line 5498  Internet-Draft        LinuxSampler Contr
5498     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
5499     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
5500    
5501  8.6.  Total number of active voices changed  8.10.  Total number of active voices changed
5502    
5503     Client may want to be notified when the total number of voices on the     Client may want to be notified when the total number of voices on the
5504     back-end changes by issuing the following command:     back-end changes by issuing the following command:
# Line 4023  Internet-Draft        LinuxSampler Contr Line 5507  Internet-Draft        LinuxSampler Contr
5507    
5508     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5509    
5510          "NOTIFY:TOTAL_VOICE_COUNT:<voices>
5511    
5512       where <voices> will be replaced by the new number of all currently
5513       active voices.
5514    
5515    8.11.  Number of MIDI instrument maps changed
5516    
5517       Client may want to be notified when the number of MIDI instrument
5518       maps on the back-end changes by issuing the following command:
5519    
5520          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
5521    
5522       Server will start sending the following notification messages:
5523    
5524          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
5525    
5526       where <maps> will be replaced by the new number of MIDI instrument
5527       maps.
5528    
5529    8.12.  MIDI instrument map information changed
5530    
5531       Client may want to be notified when changes were made to MIDI
5532       instrument maps on the back-end by issuing the following command:
5533    
5534          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
5535    
5536       Server will start sending the following notification messages:
5537    
5538    
5539    
5540    
5541    
5542    
5543  Schoenebeck               Expires May 29, 2007                 [Page 72]  Schoenebeck               Expires July 18, 2007                [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5546    
5547    
5548          "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
5549    
5550       where <map-id> will be replaced by the numerical ID of the MIDI
5551       instrument map, for which information changes occurred.  The front-
5552       end will have to send the respective command to actually get the MIDI
5553       instrument map info.  Because these messages will be triggered by
5554       LSCP commands issued by other clients rather than real time events
5555       happening on the server, it is believed that an empty notification
5556       message is sufficient here.
5557    
5558    8.13.  Number of MIDI instruments changed
5559    
5560       Client may want to be notified when the number of MIDI instrument
5561       maps on the back-end changes by issuing the following command:
5562    
5563          SUBSCRIBE MIDI_INSTRUMENT_COUNT
5564    
5565       Server will start sending the following notification messages:
5566    
5567          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
5568    
5569       where <map-id> is the numerical ID of the MIDI instrument map, in
5570       which the nuber of instruments has changed and <instruments> will be
5571       replaced by the new number of MIDI instruments in the specified map.
5572    
5573    8.14.  MIDI instrument information changed
5574    
5575       Client may want to be notified when changes were made to MIDI
5576       instruments on the back-end by issuing the following command:
5577    
5578          SUBSCRIBE MIDI_INSTRUMENT_INFO
5579    
5580       Server will start sending the following notification messages:
5581    
5582          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
5583    
5584       where <map-id> will be replaced by the numerical ID of the MIDI
5585       instrument map, in which a MIDI instrument is changed. <bank> and
5586       <program> specifies the location of the changed MIDI instrument in
5587       the map.  The front-end will have to send the respective command to
5588       actually get the MIDI instrument info.  Because these messages will
5589       be triggered by LSCP commands issued by other clients rather than
5590       real time events happening on the server, it is believed that an
5591       empty notification message is sufficient here.
5592    
5593    
5594    
5595    
       "NOTIFY:TOTAL_VOICE_COUNT:<voices>  
5596    
    where <voices> will be replaced by the new number of all currently  
    active voices.  
5597    
5598  8.7.  Miscellaneous and debugging events  
5599    Schoenebeck               Expires July 18, 2007               [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol         January 2007
5602    
5603    
5604    8.15.  Miscellaneous and debugging events
5605    
5606     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
5607     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 4084  Internet-Draft        LinuxSampler Contr Line 5647  Internet-Draft        LinuxSampler Contr
5647    
5648    
5649    
5650  Schoenebeck               Expires May 29, 2007                 [Page 73]  
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires July 18, 2007               [Page 101]
5656    
5657  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5658    
5659    
5660  9.  Security Considerations  9.  Security Considerations
# Line 4140  Internet-Draft        LinuxSampler Contr Line 5708  Internet-Draft        LinuxSampler Contr
5708    
5709    
5710    
5711  Schoenebeck               Expires May 29, 2007                 [Page 74]  Schoenebeck               Expires July 18, 2007               [Page 102]
5712    
5713  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5714    
5715    
5716  10.  Acknowledgments  10.  Acknowledgments
# Line 4160  Internet-Draft        LinuxSampler Contr Line 5728  Internet-Draft        LinuxSampler Contr
5728        Grigor Iliev        Grigor Iliev
5729    
5730    
 11.  References  
5731    
    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate  
               Requirement Levels", RFC 2119, 1997.  
5732    
    [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax  
               Specifications", RFC 2234, 1997.  
5733    
    [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION  
               CONTROL PROTOCOL", RFC 793, 1981.  
5734    
5735    
5736    
# Line 4196  Internet-Draft        LinuxSampler Contr Line 5757  Internet-Draft        LinuxSampler Contr
5757    
5758    
5759    
5760  Schoenebeck               Expires May 29, 2007                 [Page 75]  
5761    
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck               Expires July 18, 2007               [Page 103]
5768    
5769  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5770    
5771    
5772  Author's Address  11.  References
5773    
5774     C. Schoenebeck     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
5775     Interessengemeinschaft Software Engineering e. V.                Requirement Levels", RFC 2119, 1997.
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
5776    
5777     Email: schoenebeck at software minus engineering dot org     [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
5778                  Specifications", RFC 2234, 1997.
5779    
5780       [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION
5781                  CONTROL PROTOCOL", RFC 793, 1981.
5782    
5783    
5784    
# Line 4252  Author's Address Line 5820  Author's Address
5820    
5821    
5822    
5823  Schoenebeck               Expires May 29, 2007                 [Page 76]  Schoenebeck               Expires July 18, 2007               [Page 104]
5824    
5825  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol         January 2007
5826    
5827    
5828  Intellectual Property Statement  Author's Address
5829    
5830     The IETF takes no position regarding the validity or scope of any     C. Schoenebeck
5831     intellectual property or other rights that might be claimed to     Interessengemeinschaft Software Engineering e. V.
5832     pertain to the implementation or use of the technology described in     Max-Planck-Str. 39
5833     this document or the extent to which any license under such rights     74081 Heilbronn
5834     might or might not be available; neither does it represent that it     Germany
    has made any effort to identify any such rights.  Information on the  
    IETF's procedures with respect to rights in standards-track and  
    standards-related documentation can be found in BCP 11.  Copies of  
    claims of rights made available for publication and any assurances of  
    licenses to be made available, or the result of an attempt made to  
    obtain a general license or permission for the use of such  
    proprietary rights by implementors or users of this specification can  
    be obtained from the IETF Secretariat.  
5835    
5836     The IETF invites any interested party to bring to its attention any     Email: schoenebeck at software minus engineering dot org
    copyrights, patents or patent applications, or other proprietary  
    rights which may cover technology that may be required to practice  
    this standard.  Please address the information to the IETF Executive  
    Director.  
5837    
5838    
 Full Copyright Statement  
5839    
    Copyright (C) The Internet Society (2006).  All Rights Reserved.  
5840    
    This document and translations of it may be copied and furnished to  
    others, and derivative works that comment on or otherwise explain it  
    or assist in its implementation may be prepared, copied, published  
    and distributed, in whole or in part, without restriction of any  
    kind, provided that the above copyright notice and this paragraph are  
    included on all such copies and derivative works.  However, this  
    document itself may not be modified in any way, such as by removing  
    the copyright notice or references to the Internet Society or other  
    Internet organizations, except as needed for the purpose of  
    developing Internet standards in which case the procedures for  
    copyrights defined in the Internet Standards process must be  
    followed, or as required to translate it into languages other than  
    English.  
5841    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
5842    
    This document and the information contained herein is provided on an  
    "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  
    TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  
    BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  
5843    
5844    
5845    
 Schoenebeck               Expires May 29, 2007                 [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5846    
5847    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
5848    
5849    
 Acknowledgment  
5850    
    Funding for the RFC Editor function is currently provided by the  
    Internet Society.  
5851    
5852    
5853    
# Line 4349  Acknowledgment Line 5876  Acknowledgment
5876    
5877    
5878    
5879    Schoenebeck               Expires July 18, 2007               [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol         January 2007
5882    
5883    
5884    Full Copyright Statement
5885    
5886       Copyright (C) The Internet Society (2007).
5887    
5888       This document is subject to the rights, licenses and restrictions
5889       contained in BCP 78, and except as set forth therein, the authors
5890       retain all their rights.
5891    
5892       This document and the information contained herein are provided on an
5893       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
5894       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
5895       ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
5896       INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
5897       INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
5898       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
5899    
5900    
5901    Intellectual Property
5902    
5903       The IETF takes no position regarding the validity or scope of any
5904       Intellectual Property Rights or other rights that might be claimed to
5905       pertain to the implementation or use of the technology described in
5906       this document or the extent to which any license under such rights
5907       might or might not be available; nor does it represent that it has
5908       made any independent effort to identify any such rights.  Information
5909       on the procedures with respect to rights in RFC documents can be
5910       found in BCP 78 and BCP 79.
5911    
5912       Copies of IPR disclosures made to the IETF Secretariat and any
5913       assurances of licenses to be made available, or the result of an
5914       attempt made to obtain a general license or permission for the use of
5915       such proprietary rights by implementers or users of this
5916       specification can be obtained from the IETF on-line IPR repository at
5917       http://www.ietf.org/ipr.
5918    
5919       The IETF invites any interested party to bring to its attention any
5920       copyrights, patents or patent applications, or other proprietary
5921       rights that may cover technology that may be required to implement
5922       this standard.  Please address the information to the IETF at
5923       ietf-ipr@ietf.org.
5924    
5925    
5926    Acknowledgment
5927    
5928       Funding for the RFC Editor function is provided by the IETF
5929       Administrative Support Activity (IASA).
5930    
5931    
5932    
5933    
5934    
5935  Schoenebeck               Expires May 29, 2007                 [Page 78]  Schoenebeck               Expires July 18, 2007               [Page 106]
5936    
Legend:
Removed from v.940  
changed lines
  Added in v.1028
  ViewVC Help
Powered by ViewVC