/[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 2138 by schoenebeck, Sun Nov 1 12:59:16 2009 UTC revision 2139 by schoenebeck, Mon Oct 4 22:17:58 2010 UTC
# Line 4  Line 4 
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7  Expires: May 5, 2010                                    November 1, 2009  Expires: April 8, 2011                                   October 5, 2010
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
# Line 26  Status of this Memo Line 26  Status of this Memo
26     aware will be disclosed, in accordance with Section 6 of BCP 79.     aware will be disclosed, in accordance with Section 6 of BCP 79.
27    
28     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
29     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF).  Note that other groups may also distribute
30     other groups may also distribute working documents as Internet-     working documents as Internet-Drafts.  The list of current Internet-
31     Drafts.     Drafts is at http://datatracker.ietf.org/drafts/current/.
32    
33     Internet-Drafts are draft documents valid for a maximum of six months     Internet-Drafts are draft documents valid for a maximum of six months
34     and may be updated, replaced, or obsoleted by other documents at any     and may be updated, replaced, or obsoleted by other documents at any
35     time.  It is inappropriate to use Internet-Drafts as reference     time.  It is inappropriate to use Internet-Drafts as reference
36     material or to cite them other than as "work in progress."     material or to cite them other than as "work in progress."
37    
38     The list of current Internet-Drafts can be accessed at     This Internet-Draft will expire on April 8, 2011.
    http://www.ietf.org/ietf/1id-abstracts.txt.  
39    
    The list of Internet-Draft Shadow Directories can be accessed at  
    http://www.ietf.org/shadow.html.  
40    
    This Internet-Draft will expire on May 5, 2010.  
41    
42    
43    
# Line 52  Status of this Memo Line 48  Status of this Memo
48    
49    
50    
51  Schoenebeck                Expires May 5, 2010                  [Page 1]  
52    
53    
54    
55    Schoenebeck               Expires April 8, 2011                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
58    
59    
60  Table of Contents  Table of Contents
61    
62     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   7
63     2.  Versioning of this specification  . . . . . . . . . . . . . .   7     2.  Versioning of this specification  . . . . . . . . . . . . . .   8
64     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   9
65     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .  10
66     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  11
67       5.1.  Request/response communication method . . . . . . . . . .  10       5.1.  Request/response communication method . . . . . . . . . .  11
68         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11         5.1.1.   Result format  . . . . . . . . . . . . . . . . . . .  12
69       5.2.  Subscribe/notify communication method . . . . . . . . . .  13       5.2.  Subscribe/notify communication method . . . . . . . . . .  14
70     6.  Description for control commands  . . . . . . . . . . . . . .  15     6.  Description for control commands  . . . . . . . . . . . . . .  16
71       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  16
72       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  16
73         6.2.1.  Getting amount of available audio output drivers  . .  16         6.2.1.   Getting amount of available audio output drivers . .  17
74         6.2.2.  Getting all available audio output drivers  . . . . .  16         6.2.2.   Getting all available audio output drivers . . . . .  17
75         6.2.3.  Getting information about a specific audio output         6.2.3.   Getting information about a specific audio output
76                 driver  . . . . . . . . . . . . . . . . . . . . . . .  16                  driver . . . . . . . . . . . . . . . . . . . . . . .  17
77         6.2.4.  Getting information about specific audio output         6.2.4.   Getting information about specific audio output
78                 driver parameter  . . . . . . . . . . . . . . . . . .  17                  driver parameter . . . . . . . . . . . . . . . . . .  18
79         6.2.5.  Creating an audio output device . . . . . . . . . . .  21         6.2.5.   Creating an audio output device  . . . . . . . . . .  22
80         6.2.6.  Destroying an audio output device . . . . . . . . . .  22         6.2.6.   Destroying an audio output device  . . . . . . . . .  23
81         6.2.7.  Getting all created audio output device count . . . .  23         6.2.7.   Getting all created audio output device count  . . .  24
82         6.2.8.  Getting all created audio output device list  . . . .  23         6.2.8.   Getting all created audio output device list . . . .  24
83         6.2.9.  Getting current settings of an audio output device  .  23         6.2.9.   Getting current settings of an audio output device .  24
84         6.2.10. Changing settings of audio output devices . . . . . .  25         6.2.10.  Changing settings of audio output devices  . . . . .  26
85         6.2.11. Getting information about an audio channel  . . . . .  26         6.2.11.  Getting information about an audio channel . . . . .  27
86         6.2.12. Getting information about specific audio channel         6.2.12.  Getting information about specific audio channel
87                 parameter . . . . . . . . . . . . . . . . . . . . . .  27                  parameter  . . . . . . . . . . . . . . . . . . . . .  28
88         6.2.13. Changing settings of audio output channels  . . . . .  29         6.2.13.  Changing settings of audio output channels . . . . .  30
89       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  31
90         6.3.1.  Getting amount of available MIDI input drivers  . . .  31         6.3.1.   Getting amount of available MIDI input drivers . . .  32
91         6.3.2.  Getting all available MIDI input drivers  . . . . . .  31         6.3.2.   Getting all available MIDI input drivers . . . . . .  32
92         6.3.3.  Getting information about a specific MIDI input         6.3.3.   Getting information about a specific MIDI input
93                 driver  . . . . . . . . . . . . . . . . . . . . . . .  32                  driver . . . . . . . . . . . . . . . . . . . . . . .  33
94         6.3.4.  Getting information about specific MIDI input         6.3.4.   Getting information about specific MIDI input
95                 driver parameter  . . . . . . . . . . . . . . . . . .  33                  driver parameter . . . . . . . . . . . . . . . . . .  34
96         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35         6.3.5.   Creating a MIDI input device . . . . . . . . . . . .  36
97         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36         6.3.6.   Destroying a MIDI input device . . . . . . . . . . .  37
98         6.3.7.  Getting all created MIDI input device count . . . . .  37         6.3.7.   Getting all created MIDI input device count  . . . .  38
99         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.3.8.   Getting all created MIDI input device list . . . . .  38
100         6.3.9.  Getting current settings of a MIDI input device . . .  38         6.3.9.   Getting current settings of a MIDI input device  . .  39
101         6.3.10. Changing settings of MIDI input devices . . . . . . .  39         6.3.10.  Changing settings of MIDI input devices  . . . . . .  40
102         6.3.11. Getting information about a MIDI port . . . . . . . .  39         6.3.11.  Getting information about a MIDI port  . . . . . . .  40
103         6.3.12. Getting information about specific MIDI port         6.3.12.  Getting information about specific MIDI port
104                 parameter . . . . . . . . . . . . . . . . . . . . . .  40                  parameter  . . . . . . . . . . . . . . . . . . . . .  41
105         6.3.13. Changing settings of MIDI input ports . . . . . . . .  42         6.3.13.  Changing settings of MIDI input ports  . . . . . . .  43
106       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  44
107         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43         6.4.1.   Loading an instrument  . . . . . . . . . . . . . . .  44
108    
109    
110    
111  Schoenebeck                Expires May 5, 2010                  [Page 2]  Schoenebeck               Expires April 8, 2011                 [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
114    
115    
116         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44         6.4.2.   Loading a sampler engine . . . . . . . . . . . . . .  45
117         6.4.3.  Getting all created sampler channel count . . . . . .  45         6.4.3.   Getting all created sampler channel count  . . . . .  46
118         6.4.4.  Getting all created sampler channel list  . . . . . .  46         6.4.4.   Getting all created sampler channel list . . . . . .  47
119         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46         6.4.5.   Adding a new sampler channel . . . . . . . . . . . .  47
120         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47         6.4.6.   Removing a sampler channel . . . . . . . . . . . . .  48
121         6.4.7.  Getting amount of available engines . . . . . . . . .  48         6.4.7.   Getting amount of available engines  . . . . . . . .  49
122         6.4.8.  Getting all available engines . . . . . . . . . . . .  48         6.4.8.   Getting all available engines  . . . . . . . . . . .  49
123         6.4.9.  Getting information about an engine . . . . . . . . .  48         6.4.9.   Getting information about an engine  . . . . . . . .  49
124         6.4.10. Getting sampler channel information . . . . . . . . .  49         6.4.10.  Getting sampler channel information  . . . . . . . .  50
125         6.4.11. Current number of active voices . . . . . . . . . . .  52         6.4.11.  Current number of active voices  . . . . . . . . . .  53
126         6.4.12. Current number of active disk streams . . . . . . . .  53         6.4.12.  Current number of active disk streams  . . . . . . .  54
127         6.4.13. Current fill state of disk stream buffers . . . . . .  53         6.4.13.  Current fill state of disk stream buffers  . . . . .  54
128         6.4.14. Setting audio output device . . . . . . . . . . . . .  54         6.4.14.  Setting audio output device  . . . . . . . . . . . .  55
129         6.4.15. Setting audio output type . . . . . . . . . . . . . .  55         6.4.15.  Setting audio output type  . . . . . . . . . . . . .  56
130         6.4.16. Setting audio output channel  . . . . . . . . . . . .  56         6.4.16.  Setting audio output channel . . . . . . . . . . . .  57
131         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  57         6.4.17.  Setting MIDI input device  . . . . . . . . . . . . .  58
132         6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57         6.4.18.  Setting MIDI input type  . . . . . . . . . . . . . .  58
133         6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58         6.4.19.  Setting MIDI input port  . . . . . . . . . . . . . .  59
134         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  59         6.4.20.  Setting MIDI input channel . . . . . . . . . . . . .  60
135         6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59         6.4.21.  Setting channel volume . . . . . . . . . . . . . . .  60
136         6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60         6.4.22.  Muting a sampler channel . . . . . . . . . . . . . .  61
137         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  61         6.4.23.  Soloing a sampler channel  . . . . . . . . . . . . .  62
138         6.4.24. Assigning a MIDI instrument map to a sampler         6.4.24.  Assigning a MIDI instrument map to a sampler
139                 channel . . . . . . . . . . . . . . . . . . . . . . .  61                  channel  . . . . . . . . . . . . . . . . . . . . . .  62
140         6.4.25. Adding an effect send to a sampler channel  . . . . .  62         6.4.25.  Adding an effect send to a sampler channel . . . . .  63
141         6.4.26. Removing an effect send from a sampler channel  . . .  64         6.4.26.  Removing an effect send from a sampler channel . . .  65
142         6.4.27. Getting amount of effect sends on a sampler channel .  64         6.4.27.  Getting amount of effect sends on a sampler
143         6.4.28. Listing all effect sends on a sampler channel . . . .  65                  channel  . . . . . . . . . . . . . . . . . . . . . .  65
144         6.4.29. Getting effect send information . . . . . . . . . . .  65         6.4.28.  Listing all effect sends on a sampler channel  . . .  66
145         6.4.30. Changing effect send's name . . . . . . . . . . . . .  67         6.4.29.  Getting effect send information  . . . . . . . . . .  66
146         6.4.31. Altering effect send's audio routing  . . . . . . . .  67         6.4.30.  Changing effect send's name  . . . . . . . . . . . .  68
147         6.4.32. Altering effect send's MIDI controller  . . . . . . .  68         6.4.31.  Altering effect send's audio routing . . . . . . . .  69
148         6.4.33. Altering effect send's send level . . . . . . . . . .  69         6.4.32.  Assigning destination effect to an effect send . . .  70
149         6.4.34. Sending MIDI messages to sampler channel  . . . . . .  70         6.4.33.  Removing destination effect from an effect send  . .  71
150         6.4.35. Resetting a sampler channel . . . . . . . . . . . . .  71         6.4.34.  Altering effect send's MIDI controller . . . . . . .  71
151       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  72         6.4.35.  Altering effect send's send level  . . . . . . . . .  72
152         6.5.1.  Register front-end for receiving event messages . . .  72         6.4.36.  Sending MIDI messages to sampler channel . . . . . .  73
153         6.5.2.  Unregister front-end for not receiving event         6.4.37.  Resetting a sampler channel  . . . . . . . . . . . .  74
154                 messages  . . . . . . . . . . . . . . . . . . . . . .  73       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  75
155         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  73         6.5.1.   Register front-end for receiving event messages  . .  75
156         6.5.4.  Close client connection . . . . . . . . . . . . . . .  74         6.5.2.   Unregister front-end for not receiving event
157       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  74                  messages . . . . . . . . . . . . . . . . . . . . . .  75
158         6.6.1.  Current number of active voices . . . . . . . . . . .  74         6.5.3.   Enable or disable echo of commands . . . . . . . . .  76
159         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  74         6.5.4.   Close client connection  . . . . . . . . . . . . . .  77
160         6.6.3.  Current number of active disk streams . . . . . . . .  75       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  77
161         6.6.4.  Reset sampler . . . . . . . . . . . . . . . . . . . .  75         6.6.1.   Current number of active voices  . . . . . . . . . .  77
162         6.6.5.  General sampler informations  . . . . . . . . . . . .  75         6.6.2.   Maximum amount of active voices  . . . . . . . . . .  77
163         6.6.6.  Getting global volume attenuation . . . . . . . . . .  76         6.6.3.   Current number of active disk streams  . . . . . . .  77
164    
165    
166    
167  Schoenebeck                Expires May 5, 2010                  [Page 3]  Schoenebeck               Expires April 8, 2011                 [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
170    
171    
172         6.6.7.  Setting global volume attenuation . . . . . . . . . .  76         6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  78
173         6.6.8.  Getting global voice limit  . . . . . . . . . . . . .  77         6.6.5.   General sampler informations . . . . . . . . . . . .  78
174         6.6.9.  Setting global voice limit  . . . . . . . . . . . . .  77         6.6.6.   Getting global volume attenuation  . . . . . . . . .  79
175         6.6.10. Getting global disk stream limit  . . . . . . . . . .  78         6.6.7.   Setting global volume attenuation  . . . . . . . . .  79
176         6.6.11. Setting global disk stream limit  . . . . . . . . . .  79         6.6.8.   Getting global voice limit . . . . . . . . . . . . .  80
177       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  79         6.6.9.   Setting global voice limit . . . . . . . . . . . . .  80
178         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  80         6.6.10.  Getting global disk stream limit . . . . . . . . . .  81
179         6.7.2.  Delete one particular or all MIDI instrument maps . .  81         6.6.11.  Setting global disk stream limit . . . . . . . . . .  81
180         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  82       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  82
181         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  82         6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  83
182         6.7.5.  Getting MIDI instrument map information . . . . . . .  82         6.7.2.   Delete one particular or all MIDI instrument maps  .  84
183         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  83         6.7.3.   Get amount of existing MIDI instrument maps  . . . .  84
184         6.7.7.  Create or replace a MIDI instrument map entry . . . .  84         6.7.4.   Getting all created MIDI instrument maps . . . . . .  85
185         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  87         6.7.5.   Getting MIDI instrument map information  . . . . . .  85
186         6.7.9.  Getting indeces of all entries of a MIDI         6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  86
187                 instrument map  . . . . . . . . . . . . . . . . . . .  87         6.7.7.   Create or replace a MIDI instrument map entry  . . .  87
188         6.7.10. Remove an entry from the MIDI instrument map  . . . .  88         6.7.8.   Getting ammount of MIDI instrument map entries . . .  89
189         6.7.11. Get current settings of MIDI instrument map entry . .  89         6.7.9.   Getting indeces of all entries of a MIDI
190         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  90                  instrument map . . . . . . . . . . . . . . . . . . .  90
191       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  91         6.7.10.  Remove an entry from the MIDI instrument map . . . .  91
192         6.8.1.  Creating a new instrument directory . . . . . . . . .  91         6.7.11.  Get current settings of MIDI instrument map entry  .  91
193         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  92         6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  93
194         6.8.3.  Getting amount of instrument directories  . . . . . .  93       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  94
195         6.8.4.  Listing all directories in specific directory . . . .  93         6.8.1.   Creating a new instrument directory  . . . . . . . .  94
196         6.8.5.  Getting instrument directory information  . . . . . .  94         6.8.2.   Deleting an instrument directory . . . . . . . . . .  95
197         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  95         6.8.3.   Getting amount of instrument directories . . . . . .  95
198         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  95         6.8.4.   Listing all directories in specific directory  . . .  96
199         6.8.8.  Copying instrument directories  . . . . . . . . . . .  96         6.8.5.   Getting instrument directory information . . . . . .  97
200         6.8.9.  Changing the description of directory . . . . . . . .  97         6.8.6.   Renaming an instrument directory . . . . . . . . . .  98
201         6.8.10. Finding directories . . . . . . . . . . . . . . . . .  97         6.8.7.   Moving an instrument directory . . . . . . . . . . .  98
202         6.8.11. Adding instruments to the instruments database  . . .  99         6.8.8.   Copying instrument directories . . . . . . . . . . .  99
203         6.8.12. Removing an instrument  . . . . . . . . . . . . . . . 100         6.8.9.   Changing the description of directory  . . . . . . . 100
204         6.8.13. Getting amount of instruments . . . . . . . . . . . . 101         6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 100
205         6.8.14. Listing all instruments in specific directory . . . . 102         6.8.11.  Adding instruments to the instruments database . . . 102
206         6.8.15. Getting instrument information  . . . . . . . . . . . 102         6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 103
207         6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 105         6.8.13.  Getting amount of instruments  . . . . . . . . . . . 104
208         6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 105         6.8.14.  Listing all instruments in specific directory  . . . 104
209         6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 106         6.8.15.  Getting instrument information . . . . . . . . . . . 105
210         6.8.19. Changing the description of instrument  . . . . . . . 106         6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 107
211         6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 107         6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 108
212         6.8.21. Getting job status information  . . . . . . . . . . . 109         6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 109
213         6.8.22. Formatting the instruments database . . . . . . . . . 111         6.8.19.  Changing the description of instrument . . . . . . . 109
214         6.8.23. Checking for lost instrument files  . . . . . . . . . 111         6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 110
215         6.8.24. Replacing an instrument file  . . . . . . . . . . . . 112         6.8.21.  Getting job status information . . . . . . . . . . . 112
216       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 112         6.8.22.  Formatting the instruments database  . . . . . . . . 113
217         6.9.1.  Opening an appropriate instrument editor         6.8.23.  Checking for lost instrument files . . . . . . . . . 114
218                 application . . . . . . . . . . . . . . . . . . . . . 112         6.8.24.  Replacing an instrument file . . . . . . . . . . . . 114
219       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 113       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 115
220    
221    
222    
223  Schoenebeck                Expires May 5, 2010                  [Page 4]  Schoenebeck               Expires April 8, 2011                 [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
226    
227    
228         6.10.1. Retrieving amount of instruments of a file  . . . . . 114         6.9.1.   Opening an appropriate instrument editor
229         6.10.2. Retrieving all instruments of a file  . . . . . . . . 114                  application  . . . . . . . . . . . . . . . . . . . . 115
230         6.10.3. Retrieving informations about one instrument in a       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 116
231                 file  . . . . . . . . . . . . . . . . . . . . . . . . 115         6.10.1.  Retrieving amount of instruments of a file . . . . . 116
232     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 117         6.10.2.  Retrieving all instruments of a file . . . . . . . . 117
233       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 131         6.10.3.  Retrieving informations about one instrument in a
234     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 136                  file . . . . . . . . . . . . . . . . . . . . . . . . 117
235       8.1.  Number of audio output devices changed  . . . . . . . . . 136       6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 119
236       8.2.  Audio output device's settings changed  . . . . . . . . . 136         6.11.1.  Retrieve amount of available effects . . . . . . . . 120
237       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 136         6.11.2.  Get list of available effects  . . . . . . . . . . . 120
238       8.4.  MIDI input device's settings changed  . . . . . . . . . . 137         6.11.3.  Retrieving general information about an effect . . . 121
239       8.5.  Number of sampler channels changed  . . . . . . . . . . . 137         6.11.4.  Creating an instance of an effect by its portable
240       8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 137                  ID . . . . . . . . . . . . . . . . . . . . . . . . . 122
241       8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 138         6.11.5.  Creating an instance of an effect by its
242       8.8.  Number of active voices changed . . . . . . . . . . . . . 138                  numerical ID . . . . . . . . . . . . . . . . . . . . 123
243       8.9.  Number of active disk streams changed . . . . . . . . . . 139         6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 124
244       8.10. Disk stream buffer fill state changed . . . . . . . . . . 139         6.11.7.  Retrieve amount of effect instances  . . . . . . . . 125
245       8.11. Channel information changed . . . . . . . . . . . . . . . 139         6.11.8.  Get list of effect instances . . . . . . . . . . . . 125
246       8.12. Number of effect sends changed  . . . . . . . . . . . . . 140         6.11.9.  Retrieving current information about an effect
247       8.13. Effect send information changed . . . . . . . . . . . . . 140                  instance . . . . . . . . . . . . . . . . . . . . . . 125
248       8.14. Total number of active voices changed . . . . . . . . . . 141         6.11.10. Retrieving information about an effect parameter . . 127
249       8.15. Total number of active disk streams changed . . . . . . . 141         6.11.11. Altering an effect parameter . . . . . . . . . . . . 129
250       8.16. Number of MIDI instrument maps changed  . . . . . . . . . 141         6.11.12. Retrieve amount of send effect chains  . . . . . . . 129
251       8.17. MIDI instrument map information changed . . . . . . . . . 141         6.11.13. Retrieve list of send effect chains  . . . . . . . . 130
252       8.18. Number of MIDI instruments changed  . . . . . . . . . . . 142         6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 130
253       8.19. MIDI instrument information changed . . . . . . . . . . . 142         6.11.15. Remove send effect chain . . . . . . . . . . . . . . 131
254       8.20. Global settings changed . . . . . . . . . . . . . . . . . 143         6.11.16. Retrieving information about a send effect chain . . 132
255       8.21. Number of database instrument directories changed . . . . 143         6.11.17. Append effect instance to a send effect chain  . . . 133
256       8.22. Database instrument directory information changed . . . . 143         6.11.18. Insert effect instance to a send effect chain  . . . 133
257       8.23. Number of database instruments changed  . . . . . . . . . 144         6.11.19. Remove effect instance from send effect chain  . . . 134
258       8.24. Database instrument information changed . . . . . . . . . 144     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 136
259       8.25. Database job status information changed . . . . . . . . . 145       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 152
260       8.26. Miscellaneous and debugging events  . . . . . . . . . . . 145     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
261     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 147       8.1.  Number of audio output devices changed  . . . . . . . . . 157
262     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 148       8.2.  Audio output device's settings changed  . . . . . . . . . 157
263     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 149       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 157
264     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 150       8.4.  MIDI input device's settings changed  . . . . . . . . . . 158
265     Intellectual Property and Copyright Statements  . . . . . . . . . 151       8.5.  Number of sampler channels changed  . . . . . . . . . . . 158
266         8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 158
267         8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 159
268         8.8.  Number of active voices changed . . . . . . . . . . . . . 159
269         8.9.  Number of active disk streams changed . . . . . . . . . . 160
270         8.10. Disk stream buffer fill state changed . . . . . . . . . . 160
271         8.11. Channel information changed . . . . . . . . . . . . . . . 160
272         8.12. Number of effect sends changed  . . . . . . . . . . . . . 161
273         8.13. Effect send information changed . . . . . . . . . . . . . 161
274         8.14. Total number of active voices changed . . . . . . . . . . 162
275         8.15. Total number of active disk streams changed . . . . . . . 162
276    
277    
278    
279    Schoenebeck               Expires April 8, 2011                 [Page 5]
280    
281    Internet-Draft        LinuxSampler Control Protocol         October 2010
282    
283    
284         8.16. Number of MIDI instrument maps changed  . . . . . . . . . 162
285         8.17. MIDI instrument map information changed . . . . . . . . . 162
286         8.18. Number of MIDI instruments changed  . . . . . . . . . . . 163
287         8.19. MIDI instrument information changed . . . . . . . . . . . 163
288         8.20. Global settings changed . . . . . . . . . . . . . . . . . 164
289         8.21. Number of database instrument directories changed . . . . 164
290         8.22. Database instrument directory information changed . . . . 164
291         8.23. Number of database instruments changed  . . . . . . . . . 165
292         8.24. Database instrument information changed . . . . . . . . . 165
293         8.25. Database job status information changed . . . . . . . . . 166
294         8.26. Miscellaneous and debugging events  . . . . . . . . . . . 166
295       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 168
296       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 169
297       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 170
298       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 171
299       Intellectual Property and Copyright Statements  . . . . . . . . . 172
300    
301    
302    
303    
304    
305    
306    
307    
308    
309    
310    
311    
312    
313    
314    
315    
316    
317    
318    
319    
320    
321    
322    
# Line 276  Internet-Draft        LinuxSampler Contr Line 330  Internet-Draft        LinuxSampler Contr
330    
331    
332    
333  Schoenebeck                Expires May 5, 2010                  [Page 5]  
334    
335    Schoenebeck               Expires April 8, 2011                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
338    
339    
340  1.  Requirements notation  1.  Requirements notation
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck                Expires May 5, 2010                  [Page 6]  Schoenebeck               Expires April 8, 2011                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
394    
395    
396  2.  Versioning of this specification  2.  Versioning of this specification
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck                Expires May 5, 2010                  [Page 7]  Schoenebeck               Expires April 8, 2011                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
450    
451    
452  3.  Introduction  3.  Introduction
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck                Expires May 5, 2010                  [Page 8]  Schoenebeck               Expires April 8, 2011                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
506    
507    
508  4.  Focus of this protocol  4.  Focus of this protocol
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck                Expires May 5, 2010                  [Page 9]  Schoenebeck               Expires April 8, 2011                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
562    
563    
564  5.  Communication Overview  5.  Communication Overview
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck                Expires May 5, 2010                 [Page 10]  Schoenebeck               Expires April 8, 2011                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
618    
619    
620  5.1.1.  Result format  5.1.1.  Result format
# Line 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck                Expires May 5, 2010                 [Page 11]  Schoenebeck               Expires April 8, 2011                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
674    
675    
676     set has the following format:     set has the following format:
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck                Expires May 5, 2010                 [Page 12]  Schoenebeck               Expires April 8, 2011                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
730    
731    
732     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 724  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck                Expires May 5, 2010                 [Page 13]  Schoenebeck               Expires April 8, 2011                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
786    
787    
788         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 780  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck                Expires May 5, 2010                 [Page 14]  Schoenebeck               Expires April 8, 2011                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
842    
843    
844  6.  Description for control commands  6.  Description for control commands
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck                Expires May 5, 2010                 [Page 15]  Schoenebeck               Expires April 8, 2011                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
898    
899    
900  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck                Expires May 5, 2010                 [Page 16]  Schoenebeck               Expires April 8, 2011                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
954    
955    
956        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck                Expires May 5, 2010                 [Page 17]  Schoenebeck               Expires April 8, 2011                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1010    
1011    
1012     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck                Expires May 5, 2010                 [Page 18]  Schoenebeck               Expires April 8, 2011                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1066    
1067    
1068        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck                Expires May 5, 2010                 [Page 19]  Schoenebeck               Expires April 8, 2011                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1122    
1123    
1124           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck                Expires May 5, 2010                 [Page 20]  Schoenebeck               Expires April 8, 2011                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1178    
1179    
1180           "TYPE: INT"           "TYPE: INT"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck                Expires May 5, 2010                 [Page 21]  Schoenebeck               Expires April 8, 2011                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1234    
1235    
1236           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck                Expires May 5, 2010                 [Page 22]  Schoenebeck               Expires April 8, 2011                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1290    
1291    
1292        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck                Expires May 5, 2010                 [Page 23]  Schoenebeck               Expires April 8, 2011                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1346    
1347    
1348     Possible Answers:     Possible Answers:
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck                Expires May 5, 2010                 [Page 24]  Schoenebeck               Expires April 8, 2011                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1402    
1403    
1404           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck                Expires May 5, 2010                 [Page 25]  Schoenebeck               Expires April 8, 2011                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1458    
1459    
1460  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck                Expires May 5, 2010                 [Page 26]  Schoenebeck               Expires April 8, 2011                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1514    
1515    
1516     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck                Expires May 5, 2010                 [Page 27]  Schoenebeck               Expires April 8, 2011                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1570    
1571    
1572     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck                Expires May 5, 2010                 [Page 28]  Schoenebeck               Expires April 8, 2011                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1626    
1627    
1628           RANGE_MAX -           RANGE_MAX -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck                Expires May 5, 2010                 [Page 29]  Schoenebeck               Expires April 8, 2011                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1682    
1683    
1684        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck                Expires May 5, 2010                 [Page 30]  Schoenebeck               Expires April 8, 2011                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1738    
1739    
1740     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck                Expires May 5, 2010                 [Page 31]  Schoenebeck               Expires April 8, 2011                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1794    
1795    
1796  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck                Expires May 5, 2010                 [Page 32]  Schoenebeck               Expires April 8, 2011                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1850    
1851    
1852  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck                Expires May 5, 2010                 [Page 33]  Schoenebeck               Expires April 8, 2011                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1906    
1907    
1908        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck                Expires May 5, 2010                 [Page 34]  Schoenebeck               Expires April 8, 2011                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
1962    
1963    
1964           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 1956  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck                Expires May 5, 2010                 [Page 35]  Schoenebeck               Expires April 8, 2011                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2018    
2019    
2020        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck                Expires May 5, 2010                 [Page 36]  Schoenebeck               Expires April 8, 2011                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2074    
2075    
2076           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck                Expires May 5, 2010                 [Page 37]  Schoenebeck               Expires April 8, 2011                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2130    
2131    
2132  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck                Expires May 5, 2010                 [Page 38]  Schoenebeck               Expires April 8, 2011                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2186    
2187    
2188           "ACTIVE: true"           "ACTIVE: true"
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck                Expires May 5, 2010                 [Page 39]  Schoenebeck               Expires April 8, 2011                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2242    
2243    
2244     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck                Expires May 5, 2010                 [Page 40]  Schoenebeck               Expires April 8, 2011                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2298    
2299    
2300        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck                Expires May 5, 2010                 [Page 41]  Schoenebeck               Expires April 8, 2011                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2354    
2355    
2356           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck                Expires May 5, 2010                 [Page 42]  Schoenebeck               Expires April 8, 2011                [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2410    
2411    
2412        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck                Expires May 5, 2010                 [Page 43]  Schoenebeck               Expires April 8, 2011                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2466    
2467    
2468     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck                Expires May 5, 2010                 [Page 44]  Schoenebeck               Expires April 8, 2011                [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2522    
2523    
2524     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck                Expires May 5, 2010                 [Page 45]  Schoenebeck               Expires April 8, 2011                [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2578    
2579    
2580  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck                Expires May 5, 2010                 [Page 46]  Schoenebeck               Expires April 8, 2011                [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2634    
2635    
2636           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck                Expires May 5, 2010                 [Page 47]  Schoenebeck               Expires April 8, 2011                [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2690    
2691    
2692  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck                Expires May 5, 2010                 [Page 48]  Schoenebeck               Expires April 8, 2011                [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2746    
2747    
2748     Possible Answers:     Possible Answers:
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2796  Internet-Draft        LinuxSampler Contr
2796    
2797    
2798    
2799  Schoenebeck                Expires May 5, 2010                 [Page 49]  Schoenebeck               Expires April 8, 2011                [Page 50]
2800    
2801  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2802    
2803    
2804        following categories are defined:        following categories are defined:
# Line 2796  Internet-Draft        LinuxSampler Contr Line 2852  Internet-Draft        LinuxSampler Contr
2852    
2853    
2854    
2855  Schoenebeck                Expires May 5, 2010                 [Page 50]  Schoenebeck               Expires April 8, 2011                [Page 51]
2856    
2857  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2858    
2859    
2860           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
# Line 2852  Internet-Draft        LinuxSampler Contr Line 2908  Internet-Draft        LinuxSampler Contr
2908    
2909    
2910    
2911  Schoenebeck                Expires May 5, 2010                 [Page 51]  Schoenebeck               Expires April 8, 2011                [Page 52]
2912    
2913  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2914    
2915    
2916              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
# Line 2908  Internet-Draft        LinuxSampler Contr Line 2964  Internet-Draft        LinuxSampler Contr
2964    
2965    
2966    
2967  Schoenebeck                Expires May 5, 2010                 [Page 52]  Schoenebeck               Expires April 8, 2011                [Page 53]
2968    
2969  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
2970    
2971    
2972        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
# Line 2964  Internet-Draft        LinuxSampler Contr Line 3020  Internet-Draft        LinuxSampler Contr
3020    
3021    
3022    
3023  Schoenebeck                Expires May 5, 2010                 [Page 53]  Schoenebeck               Expires April 8, 2011                [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3026    
3027    
3028        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
# Line 3020  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck                Expires May 5, 2010                 [Page 54]  Schoenebeck               Expires April 8, 2011                [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3082    
3083    
3084     Possible Answers:     Possible Answers:
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3132  Internet-Draft        LinuxSampler Contr
3132    
3133    
3134    
3135  Schoenebeck                Expires May 5, 2010                 [Page 55]  Schoenebeck               Expires April 8, 2011                [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3138    
3139    
3140        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3132  Internet-Draft        LinuxSampler Contr Line 3188  Internet-Draft        LinuxSampler Contr
3188    
3189    
3190    
3191  Schoenebeck                Expires May 5, 2010                 [Page 56]  Schoenebeck               Expires April 8, 2011                [Page 57]
3192    
3193  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3194    
3195    
3196  6.4.17.  Setting MIDI input device  6.4.17.  Setting MIDI input device
# Line 3188  Internet-Draft        LinuxSampler Contr Line 3244  Internet-Draft        LinuxSampler Contr
3244    
3245    
3246    
3247  Schoenebeck                Expires May 5, 2010                 [Page 57]  Schoenebeck               Expires April 8, 2011                [Page 58]
3248    
3249  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3250    
3251    
3252        "OK" -        "OK" -
# Line 3244  Internet-Draft        LinuxSampler Contr Line 3300  Internet-Draft        LinuxSampler Contr
3300    
3301    
3302    
3303  Schoenebeck                Expires May 5, 2010                 [Page 58]  Schoenebeck               Expires April 8, 2011                [Page 59]
3304    
3305  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3306    
3307    
3308    
# Line 3300  Internet-Draft        LinuxSampler Contr Line 3356  Internet-Draft        LinuxSampler Contr
3356    
3357    
3358    
3359  Schoenebeck                Expires May 5, 2010                 [Page 59]  Schoenebeck               Expires April 8, 2011                [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3362    
3363    
3364        "OK" -        "OK" -
# Line 3356  Internet-Draft        LinuxSampler Contr Line 3412  Internet-Draft        LinuxSampler Contr
3412    
3413    
3414    
3415  Schoenebeck                Expires May 5, 2010                 [Page 60]  Schoenebeck               Expires April 8, 2011                [Page 61]
3416    
3417  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3418    
3419    
3420     Examples:     Examples:
# Line 3412  Internet-Draft        LinuxSampler Contr Line 3468  Internet-Draft        LinuxSampler Contr
3468    
3469    
3470    
3471  Schoenebeck                Expires May 5, 2010                 [Page 61]  Schoenebeck               Expires April 8, 2011                [Page 62]
3472    
3473  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3474    
3475    
3476        "NONE" -        "NONE" -
# Line 3468  Internet-Draft        LinuxSampler Contr Line 3524  Internet-Draft        LinuxSampler Contr
3524    
3525    
3526    
3527  Schoenebeck                Expires May 5, 2010                 [Page 62]  Schoenebeck               Expires April 8, 2011                [Page 63]
3528    
3529  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3530    
3531    
3532     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
# Line 3524  Internet-Draft        LinuxSampler Contr Line 3580  Internet-Draft        LinuxSampler Contr
3580    
3581    
3582    
3583  Schoenebeck                Expires May 5, 2010                 [Page 63]  Schoenebeck               Expires April 8, 2011                [Page 64]
3584    
3585  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3586    
3587    
3588        S: "OK[1]"        S: "OK[1]"
# Line 3580  Internet-Draft        LinuxSampler Contr Line 3636  Internet-Draft        LinuxSampler Contr
3636    
3637    
3638    
3639  Schoenebeck                Expires May 5, 2010                 [Page 64]  Schoenebeck               Expires April 8, 2011                [Page 65]
3640    
3641  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3642    
3643    
3644        The sampler will answer by returning the number of effect sends on        The sampler will answer by returning the number of effect sends on
# Line 3636  Internet-Draft        LinuxSampler Contr Line 3692  Internet-Draft        LinuxSampler Contr
3692    
3693    
3694    
3695  Schoenebeck                Expires May 5, 2010                 [Page 65]  Schoenebeck               Expires April 8, 2011                [Page 66]
3696    
3697  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3698    
3699    
3700     Possible Answers:     Possible Answers:
# Line 3675  Internet-Draft        LinuxSampler Contr Line 3731  Internet-Draft        LinuxSampler Contr
3731              send's output channel 0 is routed to channel 0 of the audio              send's output channel 0 is routed to channel 0 of the audio
3732              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
3733              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3734              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details),
3735                if an internal send effect is assigned to the effect send,
3736                then this setting defines the audio channel routing to that
3737                effect instance respectively
3738    
3739             SEND_EFFECT -
3740    
3741                destination send effect chain ID and destination effect
3742                chain position, separated by comma in the form "<effect-
3743                chain>,<chain-pos>" or "NONE" if there is no send effect
3744                assigned to the effect send
3745    
3746     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3747    
    Example:  
3748    
       C: "GET FX_SEND INFO 0 0"  
3749    
       S: "NAME: Reverb Send"  
3750    
3751           "MIDI_CONTROLLER: 91"  Schoenebeck               Expires April 8, 2011                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol         October 2010
3754    
          "LEVEL: 0.3"  
3755    
3756       Example:
3757    
3758          C: "GET FX_SEND INFO 0 0"
3759    
3760          S: "NAME: Reverb Send"
3761    
3762  Schoenebeck                Expires May 5, 2010                 [Page 66]           "MIDI_CONTROLLER: 91"
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
3763    
3764             "LEVEL: 0.3"
3765    
3766           "AUDIO_OUTPUT_ROUTING: 2,3"           "AUDIO_OUTPUT_ROUTING: 2,3"
3767    
# Line 3735  Internet-Draft        LinuxSampler Contr Line 3801  Internet-Draft        LinuxSampler Contr
3801    
3802        S: "OK"        S: "OK"
3803    
3804    
3805    
3806    
3807    Schoenebeck               Expires April 8, 2011                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol         October 2010
3810    
3811    
3812  6.4.31.  Altering effect send's audio routing  6.4.31.  Altering effect send's audio routing
3813    
3814     The front-end can alter the destination of an effect send's audio     The front-end can alter the destination of an effect send's audio
# Line 3745  Internet-Draft        LinuxSampler Contr Line 3819  Internet-Draft        LinuxSampler Contr
3819        <audio-src> <audio-dst>        <audio-src> <audio-dst>
3820    
3821     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 67]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
3822     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3823     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3824     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3825     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3826     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
3827     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
3828     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.  If an
3829       internal send effect is assigned to the effect send, then this
3830       setting defines the audio channel routing to that effect instance
3831       respectively.
3832    
3833     Note that effect sends can only route audio to the same audio output     Note that effect sends can only route audio to the same audio output
3834     device as assigned to the effect send's sampler channel.  Also note     device as assigned to the effect send's sampler channel.  Also note
# Line 3787  Internet-Draft        LinuxSampler Contr Line 3856  Internet-Draft        LinuxSampler Contr
3856    
3857        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3858    
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires April 8, 2011                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol         October 2010
3866    
3867    
3868           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3869           error message           error message
3870    
# Line 3796  Internet-Draft        LinuxSampler Contr Line 3874  Internet-Draft        LinuxSampler Contr
3874    
3875        S: "OK"        S: "OK"
3876    
3877  6.4.32.  Altering effect send's MIDI controller  6.4.32.  Assigning destination effect to an effect send
3878    
3879     The front-end can alter the MIDI controller of an effect send entity     The front-end can (re-)assign a destination effect to an effect send
3880     by sending the following command:     by sending the following command:
3881    
3882          SET FX_SEND SEND_EFFECT <sampler-chan> <fx-send-id> <effect-chain>
3883          <chain-pos>
3884    
3885       Where <sampler-chan> is the sampler channel number as returned by the
3886       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3887       command, <fx-send-id> reflects the numerical ID of the effect send
3888       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3889       FX_SENDS" (Section 6.4.28) command, <effect-chain> by the numerical
3890       ID of the destination effect chain as returned by the "ADD
3891       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
3892       (Section 6.11.13) command and <chain-pos> reflects the exact effect
3893       chain position in the effect chain which hosts the actual destination
3894       effect.
3895    
3896       Possible Answers:
3897    
3898          "OK" -
3899    
3900             on success
3901    
3902          "ERR:<error-code>:<error-message>" -
3903    
3904             in case it failed, providing an appropriate error code and
3905             error message
3906    
3907       Example:
3908    
3909          C: "SET FX_SEND SEND_EFFECT 0 0 2 5"
3910    
3911          S: "OK"
3912    
3913    
3914    
3915    
3916    
3917    
3918  Schoenebeck                Expires May 5, 2010                 [Page 68]  
3919    Schoenebeck               Expires April 8, 2011                [Page 70]
3920    
3921  Internet-Draft        LinuxSampler Control Protocol        November 2009  Internet-Draft        LinuxSampler Control Protocol         October 2010
3922    
3923    
3924    6.4.33.  Removing destination effect from an effect send
3925    
3926       The front-end can (re-)assign a destination effect to an effect send
3927       by sending the following command:
3928    
3929          REMOVE FX_SEND SEND_EFFECT <sampler-chan> <fx-send-id>
3930    
3931       Where <sampler-chan> is the sampler channel number as returned by the
3932       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3933       command, <fx-send-id> reflects the numerical ID of the effect send
3934       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3935       FX_SENDS" (Section 6.4.28) command.
3936    
3937       After the destination effect has been removed from the effect send,
3938       the audio signal of the effect send will be routed directly to the
3939       audio output device, according to the audio channel routing setting
3940       of the effect send.
3941    
3942       Possible Answers:
3943    
3944          "OK" -
3945    
3946             on success
3947    
3948          "ERR:<error-code>:<error-message>" -
3949    
3950             in case it failed, providing an appropriate error code and
3951             error message
3952    
3953       Example:
3954    
3955          C: "REMOVE FX_SEND SEND_EFFECT 0 0"
3956    
3957          S: "OK"
3958    
3959    6.4.34.  Altering effect send's MIDI controller
3960    
3961       The front-end can alter the MIDI controller of an effect send entity
3962       by sending the following command:
3963    
3964        SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-        SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3965        ctrl>        ctrl>
# Line 3817  Internet-Draft        LinuxSampler Contr Line 3969  Internet-Draft        LinuxSampler Contr
3969     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3970     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3971     FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI     FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3972    
3973    
3974    
3975    Schoenebeck               Expires April 8, 2011                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol         October 2010
3978    
3979    
3980     controller which shall be able to modify the effect send's send     controller which shall be able to modify the effect send's send
3981     level.     level.
3982    
# Line 3843  Internet-Draft        LinuxSampler Contr Line 4003  Internet-Draft        LinuxSampler Contr
4003    
4004        S: "OK"        S: "OK"
4005    
4006  6.4.33.  Altering effect send's send level  6.4.35.  Altering effect send's send level
4007    
4008     The front-end can alter the current send level of an effect send     The front-end can alter the current send level of an effect send
4009     entity by sending the following command:     entity by sending the following command:
# Line 3857  Internet-Draft        LinuxSampler Contr Line 4017  Internet-Draft        LinuxSampler Contr
4017     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
4018     dotted positive number (a value smaller than 1.0 means attenuation,     dotted positive number (a value smaller than 1.0 means attenuation,
4019     whereas a value greater than 1.0 means amplification) reflecting the     whereas a value greater than 1.0 means amplification) reflecting the
4020       new send level.
4021    
4022       Possible Answers:
4023    
4024          "OK" -
4025    
4026  Schoenebeck                Expires May 5, 2010                 [Page 69]           on success
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
4027    
4028    
    new send level.  
4029    
    Possible Answers:  
4030    
4031        "OK" -  Schoenebeck               Expires April 8, 2011                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol         October 2010
4034    
          on success  
4035    
4036        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4037    
# Line 3890  Internet-Draft        LinuxSampler Contr Line 4050  Internet-Draft        LinuxSampler Contr
4050    
4051        S: "OK"        S: "OK"
4052    
4053  6.4.34.  Sending MIDI messages to sampler channel  6.4.36.  Sending MIDI messages to sampler channel
4054    
4055     The front-end can send MIDI events to a specific sampler channel by     The front-end can send MIDI events to a specific sampler channel by
4056     sending the following command:     sending the following command:
# Line 3913  Internet-Draft        LinuxSampler Contr Line 4073  Internet-Draft        LinuxSampler Contr
4073    
4074           For turning a currently playing MIDI note off, where <arg1>           For turning a currently playing MIDI note off, where <arg1>
4075           specifies the key number and <arg2> the velocity as described           specifies the key number and <arg2> the velocity as described
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4076           in the MIDI specification.           in the MIDI specification.
4077    
4078        "CC" -        "CC" -
# Line 3930  Internet-Draft        LinuxSampler Contr Line 4082  Internet-Draft        LinuxSampler Contr
4082           described in the Control Change section of the MIDI           described in the Control Change section of the MIDI
4083           specification.           specification.
4084    
4085    
4086    
4087    Schoenebeck               Expires April 8, 2011                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol         October 2010
4090    
4091    
4092     CAUTION: This command is provided for implementations of virtual MIDI     CAUTION: This command is provided for implementations of virtual MIDI
4093     keyboards and no realtime guarantee whatsoever will be made!     keyboards and no realtime guarantee whatsoever will be made!
4094    
# Line 3950  Internet-Draft        LinuxSampler Contr Line 4109  Internet-Draft        LinuxSampler Contr
4109    
4110        S: "OK"        S: "OK"
4111    
4112  6.4.35.  Resetting a sampler channel  6.4.37.  Resetting a sampler channel
4113    
4114     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
4115     following command:     following command:
# Line 3968  Internet-Draft        LinuxSampler Contr Line 4127  Internet-Draft        LinuxSampler Contr
4127    
4128           on success           on success
4129    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4130        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4131    
4132           if channel was reset, but there are noteworthy issue(s)           if channel was reset, but there are noteworthy issue(s)
# Line 3988  Internet-Draft        LinuxSampler Contr Line 4138  Internet-Draft        LinuxSampler Contr
4138           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4139           error message           error message
4140    
4141    
4142    
4143    Schoenebeck               Expires April 8, 2011                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol         October 2010
4146    
4147    
4148     Examples:     Examples:
4149    
4150    
# Line 4028  Internet-Draft        LinuxSampler Contr Line 4185  Internet-Draft        LinuxSampler Contr
4185    
4186    
4187    
 Schoenebeck                Expires May 5, 2010                 [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
   
   
4188  6.5.2.  Unregister front-end for not receiving event messages  6.5.2.  Unregister front-end for not receiving event messages
4189    
4190     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
# Line 4043  Internet-Draft        LinuxSampler Contr Line 4193  Internet-Draft        LinuxSampler Contr
4193        UNSUBSCRIBE <event-id>        UNSUBSCRIBE <event-id>
4194    
4195     Where <event-id> will be replaced by the respective event that client     Where <event-id> will be replaced by the respective event that client
4196    
4197    
4198    
4199    Schoenebeck               Expires April 8, 2011                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol         October 2010
4202    
4203    
4204     doesn't want to receive anymore.     doesn't want to receive anymore.
4205    
4206     Possible Answers:     Possible Answers:
# Line 4082  Internet-Draft        LinuxSampler Contr Line 4240  Internet-Draft        LinuxSampler Contr
4240    
4241     Possible Answers:     Possible Answers:
4242    
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4243        "OK" -        "OK" -
4244    
4245           usually           usually
# Line 4101  Internet-Draft        LinuxSampler Contr Line 4252  Internet-Draft        LinuxSampler Contr
4252    
4253    
4254    
4255    Schoenebeck               Expires April 8, 2011                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol         October 2010
4258    
4259    
4260    
4261    
4262  6.5.4.  Close client connection  6.5.4.  Close client connection
4263    
4264     The client can close its network connection to LinuxSampler by     The client can close its network connection to LinuxSampler by
# Line 4136  Internet-Draft        LinuxSampler Contr Line 4294  Internet-Draft        LinuxSampler Contr
4294    
4295     Possible Answers:     Possible Answers:
4296    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4297        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4298        voices.        voices.
4299    
# Line 4157  Internet-Draft        LinuxSampler Contr Line 4306  Internet-Draft        LinuxSampler Contr
4306    
4307     Possible Answers:     Possible Answers:
4308    
4309    
4310    
4311    Schoenebeck               Expires April 8, 2011                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol         October 2010
4314    
4315    
4316        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4317        disk streams on the sampler.        disk streams on the sampler.
4318    
# Line 4194  Internet-Draft        LinuxSampler Contr Line 4350  Internet-Draft        LinuxSampler Contr
4350    
4351    
4352    
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
   
   
4353           DESCRIPTION -           DESCRIPTION -
4354    
4355              arbitrary textual description about the sampler (note that              arbitrary textual description about the sampler (note that
# Line 4213  Internet-Draft        LinuxSampler Contr Line 4360  Internet-Draft        LinuxSampler Contr
4360    
4361              version of the sampler              version of the sampler
4362    
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires April 8, 2011                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol         October 2010
4370    
4371    
4372           PROTOCOL_VERSION -           PROTOCOL_VERSION -
4373    
4374              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
# Line 4248  Internet-Draft        LinuxSampler Contr Line 4404  Internet-Draft        LinuxSampler Contr
4404     The client can alter the current global sampler-wide volume     The client can alter the current global sampler-wide volume
4405     attenuation by sending the following command:     attenuation by sending the following command:
4406    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4407        SET VOLUME <volume>        SET VOLUME <volume>
4408    
4409     Where <volume> should be replaced by the optional dotted floating     Where <volume> should be replaced by the optional dotted floating
# Line 4270  Internet-Draft        LinuxSampler Contr Line 4417  Internet-Draft        LinuxSampler Contr
4417    
4418           on success           on success
4419    
4420    
4421    
4422    
4423    Schoenebeck               Expires April 8, 2011                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol         October 2010
4426    
4427    
4428        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4429    
4430           if the global volume was set, but there are noteworthy issue(s)           if the global volume was set, but there are noteworthy issue(s)
# Line 4306  Internet-Draft        LinuxSampler Contr Line 4461  Internet-Draft        LinuxSampler Contr
4461     The client can alter the current global sampler-wide limit for     The client can alter the current global sampler-wide limit for
4462     maximum voices by sending the following command:     maximum voices by sending the following command:
4463    
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4464        SET VOICES <max-voices>        SET VOICES <max-voices>
4465    
4466     Where <max-voices> should be replaced by the integer value,     Where <max-voices> should be replaced by the integer value,
# Line 4325  Internet-Draft        LinuxSampler Contr Line 4473  Internet-Draft        LinuxSampler Contr
4473    
4474           on success           on success
4475    
4476    
4477    
4478    
4479    Schoenebeck               Expires April 8, 2011                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol         October 2010
4482    
4483    
4484        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4485    
4486           if the voice limit was set, but there are noteworthy issue(s)           if the voice limit was set, but there are noteworthy issue(s)
# Line 4362  Internet-Draft        LinuxSampler Contr Line 4518  Internet-Draft        LinuxSampler Contr
4518     every disk streams allocates a certain buffer size for being able to     every disk streams allocates a certain buffer size for being able to
4519     perform its streaming operations.     perform its streaming operations.
4520    
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4521  6.6.11.  Setting global disk stream limit  6.6.11.  Setting global disk stream limit
4522    
4523     The client can alter the current global sampler-wide limit for     The client can alter the current global sampler-wide limit for
# Line 4380  Internet-Draft        LinuxSampler Contr Line 4529  Internet-Draft        LinuxSampler Contr
4529     reflecting the new global amount limit of maximum disk streams.  This     reflecting the new global amount limit of maximum disk streams.  This
4530     value has to be positive.     value has to be positive.
4531    
4532    
4533    
4534    
4535    Schoenebeck               Expires April 8, 2011                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol         October 2010
4538    
4539    
4540     Possible Answers:     Possible Answers:
4541    
4542        "OK" -        "OK" -
# Line 4417  Internet-Draft        LinuxSampler Contr Line 4574  Internet-Draft        LinuxSampler Contr
4574     maps which define which instrument to load on which MIDI program     maps which define which instrument to load on which MIDI program
4575     change message.     change message.
4576    
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4577     By default, that is when the sampler is launched, there is no map,     By default, that is when the sampler is launched, there is no map,
4578     thus the sampler will simply ignore all program change messages.  The     thus the sampler will simply ignore all program change messages.  The
4579     front-end has to explicitly create at least one map, add entries to     front-end has to explicitly create at least one map, add entries to
# Line 4436  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4586     channel.     channel.
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires April 8, 2011                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol         October 2010
4594    
4595    
4596     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
4597     to switch to another instrument.  Instead when receiving a bank     to switch to another instrument.  Instead when receiving a bank
4598     select message the bank value will be stored and a subsequent program     select message the bank value will be stored and a subsequent program
# Line 4472  Internet-Draft        LinuxSampler Contr Line 4629  Internet-Draft        LinuxSampler Contr
4629    
4630        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"        C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4631    
4632          S: "OK[0]"
4633    
4634          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4635    
4636          S: "OK[1]"
4637    
4638          C: "ADD MIDI_INSTRUMENT_MAP"
4639    
4640  Schoenebeck                Expires May 5, 2010                 [Page 80]        S: "OK[5]"
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
4641    
4642    
       S: "OK[0]"  
4643    
       C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"  
4644    
       S: "OK[1]"  
4645    
       C: "ADD MIDI_INSTRUMENT_MAP"  
4646    
4647        S: "OK[5]"  Schoenebeck               Expires April 8, 2011                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol         October 2010
4650    
4651    
4652  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
4653    
# Line 4526  Internet-Draft        LinuxSampler Contr Line 4684  Internet-Draft        LinuxSampler Contr
4684    
4685        S: "OK"        S: "OK"
4686    
   
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4687  6.7.3.  Get amount of existing MIDI instrument maps  6.7.3.  Get amount of existing MIDI instrument maps
4688    
4689     The front-end can retrieve the current amount of MIDI instrument maps     The front-end can retrieve the current amount of MIDI instrument maps
# Line 4551  Internet-Draft        LinuxSampler Contr Line 4698  Internet-Draft        LinuxSampler Contr
4698    
4699     Example:     Example:
4700    
4701    
4702    
4703    Schoenebeck               Expires April 8, 2011                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol         October 2010
4706    
4707    
4708        C: "GET MIDI_INSTRUMENT_MAPS"        C: "GET MIDI_INSTRUMENT_MAPS"
4709    
4710        S: "2"        S: "2"
# Line 4585  Internet-Draft        LinuxSampler Contr Line 4739  Internet-Draft        LinuxSampler Contr
4739     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4740     (Section 6.7.4) command.     (Section 6.7.4) command.
4741    
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4742     Possible Answers:     Possible Answers:
4743    
4744        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 4607  Internet-Draft        LinuxSampler Contr Line 4753  Internet-Draft        LinuxSampler Contr
4753    
4754              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
4755              unique (note that this character string may contain escape              unique (note that this character string may contain escape
4756    
4757    
4758    
4759    Schoenebeck               Expires April 8, 2011                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol         October 2010
4762    
4763    
4764              sequences (Section 7.1))              sequences (Section 7.1))
4765    
4766           DEFAULT -           DEFAULT -
# Line 4641  Internet-Draft        LinuxSampler Contr Line 4795  Internet-Draft        LinuxSampler Contr
4795    
4796     Possible Answers:     Possible Answers:
4797    
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4798        "OK" -        "OK" -
4799    
4800           on success           on success
# Line 4663  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809    
4810        S: "OK"        S: "OK"
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires April 8, 2011                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol         October 2010
4818    
4819    
4820  6.7.7.  Create or replace a MIDI instrument map entry  6.7.7.  Create or replace a MIDI instrument map entry
4821    
4822     The front-end can create a new or replace an existing entry in a     The front-end can create a new or replace an existing entry in a
# Line 4698  Internet-Draft        LinuxSampler Contr Line 4852  Internet-Draft        LinuxSampler Contr
4852           be freed from memory when not needed by any sampler channel           be freed from memory when not needed by any sampler channel
4853           anymore.           anymore.
4854    
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4855        "ON_DEMAND_HOLD" -        "ON_DEMAND_HOLD" -
4856    
4857           The instrument will be loaded when needed, that is when           The instrument will be loaded when needed, that is when
# Line 4717  Internet-Draft        LinuxSampler Contr Line 4864  Internet-Draft        LinuxSampler Contr
4864    
4865        "PERSISTENT" -        "PERSISTENT" -
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires April 8, 2011                [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol         October 2010
4874    
4875    
4876           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
4877           mapping command is sent and the instrument is kept all the           mapping command is sent and the instrument is kept all the
4878           time.  Instruments with this mode are only freed when the           time.  Instruments with this mode are only freed when the
# Line 4753  Internet-Draft        LinuxSampler Contr Line 4909  Internet-Draft        LinuxSampler Contr
4909     "Character Set and Escape Sequences (Section 7.1)") for the mapping     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4910     entry, useful for frontends for displaying an appropriate name for     entry, useful for frontends for displaying an appropriate name for
4911     mapped instruments (using "GET MIDI_INSTRUMENT INFO"     mapped instruments (using "GET MIDI_INSTRUMENT INFO"
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 85]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4912     (Section 6.7.11)).     (Section 6.7.11)).
4913    
4914     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
# Line 4773  Internet-Draft        LinuxSampler Contr Line 4921  Internet-Draft        LinuxSampler Contr
4921     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4922     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4923     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
4924    
4925    
4926    
4927    Schoenebeck               Expires April 8, 2011                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol         October 2010
4930    
4931    
4932     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4933     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4934     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4809  Internet-Draft        LinuxSampler Contr Line 4965  Internet-Draft        LinuxSampler Contr
4965        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4966        'Silent Piano'"        'Silent Piano'"
4967    
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
4968        S: "OK"        S: "OK"
4969    
4970        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
# Line 4829  Internet-Draft        LinuxSampler Contr Line 4977  Internet-Draft        LinuxSampler Contr
4977     The front-end can query the amount of currently existing entries in a     The front-end can query the amount of currently existing entries in a
4978     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires April 8, 2011                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol         October 2010
4986    
4987    
4988        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
4989    
4990     The front-end can query the amount of currently existing entries in     The front-end can query the amount of currently existing entries in
# Line 4863  Internet-Draft        LinuxSampler Contr Line 5019  Internet-Draft        LinuxSampler Contr
5019     The front-end can query a list of all currently existing entries of     The front-end can query a list of all currently existing entries of
5020     all MIDI instrument maps by sending the following command:     all MIDI instrument maps by sending the following command:
5021    
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5022        LIST MIDI_INSTRUMENTS ALL        LIST MIDI_INSTRUMENTS ALL
5023    
5024     Possible Answers:     Possible Answers:
# Line 4887  Internet-Draft        LinuxSampler Contr Line 5033  Internet-Draft        LinuxSampler Contr
5033    
5034     Example:     Example:
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires April 8, 2011                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol         October 2010
5042    
5043    
5044        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
5045    
5046        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
# Line 4919  Internet-Draft        LinuxSampler Contr Line 5073  Internet-Draft        LinuxSampler Contr
5073    
5074        S: "OK"        S: "OK"
5075    
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5076  6.7.11.  Get current settings of MIDI instrument map entry  6.7.11.  Get current settings of MIDI instrument map entry
5077    
5078     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
# Line 4944  Internet-Draft        LinuxSampler Contr Line 5088  Internet-Draft        LinuxSampler Contr
5088    
5089     Possible Answers:     Possible Answers:
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires April 8, 2011                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol         October 2010
5098    
5099    
5100        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5101        answer line begins with the information category name followed by        answer line begins with the information category name followed by
5102        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 4977  Internet-Draft        LinuxSampler Contr Line 5130  Internet-Draft        LinuxSampler Contr
5130           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
5131           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
5132           cannot be changed (note that this character string may contain           cannot be changed (note that this character string may contain
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5133           escape sequences (Section 7.1)).           escape sequences (Section 7.1)).
5134    
5135        "LOAD_MODE" -        "LOAD_MODE" -
# Line 4998  Internet-Draft        LinuxSampler Contr Line 5143  Internet-Draft        LinuxSampler Contr
5143           (where a value < 1.0 means attenuation and a value > 1.0 means           (where a value < 1.0 means attenuation and a value > 1.0 means
5144           amplification)           amplification)
5145    
5146    
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires April 8, 2011                [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol         October 2010
5154    
5155    
5156        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
5157    
5158     Example:     Example:
# Line 5032  Internet-Draft        LinuxSampler Contr Line 5187  Internet-Draft        LinuxSampler Contr
5187     The front-end can clear all MIDI instrument maps, that is delete all     The front-end can clear all MIDI instrument maps, that is delete all
5188     entries of all maps by sending the following command:     entries of all maps by sending the following command:
5189    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5190        CLEAR MIDI_INSTRUMENTS ALL        CLEAR MIDI_INSTRUMENTS ALL
5191    
5192     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
# Line 5055  Internet-Draft        LinuxSampler Contr Line 5201  Internet-Draft        LinuxSampler Contr
5201    
5202     Examples:     Examples:
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires April 8, 2011                [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol         October 2010
5210    
5211    
5212        C: "CLEAR MIDI_INSTRUMENTS 0"        C: "CLEAR MIDI_INSTRUMENTS 0"
5213    
5214        S: "OK"        S: "OK"
# Line 5090  Internet-Draft        LinuxSampler Contr Line 5244  Internet-Draft        LinuxSampler Contr
5244    
5245     Possible Answers:     Possible Answers:
5246    
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5247        "OK" -        "OK" -
5248    
5249           on success           on success
# Line 5109  Internet-Draft        LinuxSampler Contr Line 5256  Internet-Draft        LinuxSampler Contr
5256    
5257     Examples:     Examples:
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires April 8, 2011                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol         October 2010
5266    
5267    
5268        C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"        C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
5269    
5270        S: "OK"        S: "OK"
# Line 5141  Internet-Draft        LinuxSampler Contr Line 5297  Internet-Draft        LinuxSampler Contr
5297    
5298        S: "OK"        S: "OK"
5299    
   
   
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5300  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
5301    
5302     The front-end can retrieve the current amount of directories in a     The front-end can retrieve the current amount of directories in a
# Line 5167  Internet-Draft        LinuxSampler Contr Line 5311  Internet-Draft        LinuxSampler Contr
5311    
5312     Possible Answers:     Possible Answers:
5313    
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires April 8, 2011                [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol         October 2010
5322    
5323    
5324        The current number of instrument directories in the specified        The current number of instrument directories in the specified
5325        directory.        directory.
5326    
# Line 5201  Internet-Draft        LinuxSampler Contr Line 5355  Internet-Draft        LinuxSampler Contr
5355    
5356           if the given directory does not exist.           if the given directory does not exist.
5357    
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5358     Example:     Example:
5359    
5360        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
# Line 5220  Internet-Draft        LinuxSampler Contr Line 5366  Internet-Draft        LinuxSampler Contr
5366        S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano        S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
5367        Collection/Acoustic/New','/Percussion Collection'"        Collection/Acoustic/New','/Percussion Collection'"
5368    
5369    
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck               Expires April 8, 2011                [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol         October 2010
5378    
5379    
5380  6.8.5.  Getting instrument directory information  6.8.5.  Getting instrument directory information
5381    
5382     The front-end can ask for the current settings of an instrument     The front-end can ask for the current settings of an instrument
# Line 5257  Internet-Draft        LinuxSampler Contr Line 5414  Internet-Draft        LinuxSampler Contr
5414    
5415     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5416    
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5417     Example:     Example:
5418    
5419        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"        C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
# Line 5276  Internet-Draft        LinuxSampler Contr Line 5425  Internet-Draft        LinuxSampler Contr
5425    
5426           "MODIFIED: 2007-04-07 12:50:21"           "MODIFIED: 2007-04-07 12:50:21"
5427    
5428    
5429    
5430    
5431    Schoenebeck               Expires April 8, 2011                [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol         October 2010
5434    
5435    
5436           "."           "."
5437    
5438  6.8.6.  Renaming an instrument directory  6.8.6.  Renaming an instrument directory
# Line 5311  Internet-Draft        LinuxSampler Contr Line 5468  Internet-Draft        LinuxSampler Contr
5468     The front-end can move a specific instrument directory by sending the     The front-end can move a specific instrument directory by sending the
5469     following command:     following command:
5470    
5471          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5472    
5473       Where <dir> is the absolute path name of the directory to move and
5474       <dst> is the location where the directory will be moved to.
5475    
5476       Possible Answers:
5477    
5478          "OK" -
5479    
5480             on success
5481    
 Schoenebeck                Expires May 5, 2010                 [Page 95]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
5482    
5483    
       MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>  
5484    
    Where <dir> is the absolute path name of the directory to move and  
    <dst> is the location where the directory will be moved to.  
5485    
    Possible Answers:  
5486    
5487        "OK" -  Schoenebeck               Expires April 8, 2011                [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol         October 2010
5490    
          on success  
5491    
5492        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5493    
# Line 5369  Internet-Draft        LinuxSampler Contr Line 5526  Internet-Draft        LinuxSampler Contr
5526           exists in the destination directory.  Error is also thrown when           exists in the destination directory.  Error is also thrown when
5527           trying to copy a directory to a subdirectory of itself.           trying to copy a directory to a subdirectory of itself.
5528    
5529       Example:
5530    
5531          C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5532          '/Acoustic/Pianos'"
5533    
5534          S: "OK"
5535    
 Schoenebeck                Expires May 5, 2010                 [Page 96]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
5536    
5537    
    Example:  
5538    
       C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'  
       '/Acoustic/Pianos'"  
5539    
5540        S: "OK"  
5541    
5542    
5543    Schoenebeck               Expires April 8, 2011                [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol         October 2010
5546    
5547    
5548  6.8.9.  Changing the description of directory  6.8.9.  Changing the description of directory
5549    
# Line 5425  Internet-Draft        LinuxSampler Contr Line 5586  Internet-Draft        LinuxSampler Contr
5586     directory to search in.  If NON_RECURSIVE is specified, the     directory to search in.  If NON_RECURSIVE is specified, the
5587     directories located in subdirectories of the specified directory will     directories located in subdirectories of the specified directory will
5588     not be searched. <criteria-list> is a list of search criterias in     not be searched. <criteria-list> is a list of search criterias in
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5589     form of "key1=val1 key2=val2 ...".  The following criterias are     form of "key1=val1 key2=val2 ...".  The following criterias are
5590     allowed:     allowed:
5591    
# Line 5440  Internet-Draft        LinuxSampler Contr Line 5593  Internet-Draft        LinuxSampler Contr
5593    
5594        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5595        supplied search string (encapsulated into apostrophes, supporting        supplied search string (encapsulated into apostrophes, supporting
5596    
5597    
5598    
5599    Schoenebeck               Expires April 8, 2011               [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol         October 2010
5602    
5603    
5604        escape sequences as described in chapter "Character Set and Escape        escape sequences as described in chapter "Character Set and Escape
5605        Sequences (Section 7.1)").        Sequences (Section 7.1)").
5606    
# Line 5480  Internet-Draft        LinuxSampler Contr Line 5641  Internet-Draft        LinuxSampler Contr
5641    
5642        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5643    
5644             if the given directory does not exist.
5645    
5646       Example:
5647    
5648          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5649    
5650          S: "'/Piano Collection'"
 Schoenebeck                Expires May 5, 2010                 [Page 98]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
5651    
5652    
          if the given directory does not exist.  
5653    
    Example:  
5654    
5655        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"  Schoenebeck               Expires April 8, 2011               [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol         October 2010
5658    
       S: "'/Piano Collection'"  
5659    
5660        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5661        30:13'"        30:13'"
# Line 5535  Internet-Draft        LinuxSampler Contr Line 5695  Internet-Draft        LinuxSampler Contr
5695           Only the instruments in the specified directory will be added,           Only the instruments in the specified directory will be added,
5696           the instruments in the subdirectories will not be processed.           the instruments in the subdirectories will not be processed.
5697    
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                 [Page 99]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5698        "FLAT" -        "FLAT" -
5699    
5700           All instruments will be processed, including those in the           All instruments will be processed, including those in the
# Line 5555  Internet-Draft        LinuxSampler Contr Line 5705  Internet-Draft        LinuxSampler Contr
5705     If FILE_AS_DIR argument is supplied, all instruments in an instrument     If FILE_AS_DIR argument is supplied, all instruments in an instrument
5706     file will be added to a separate directory in the instruments     file will be added to a separate directory in the instruments
5707     database, which name will be the name of the instrument file with the     database, which name will be the name of the instrument file with the
5708    
5709    
5710    
5711    Schoenebeck               Expires April 8, 2011               [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol         October 2010
5714    
5715    
5716     file extension stripped off.     file extension stripped off.
5717    
5718     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
# Line 5591  Internet-Draft        LinuxSampler Contr Line 5749  Internet-Draft        LinuxSampler Contr
5749     The front-end can remove a particular instrument from the instruments     The front-end can remove a particular instrument from the instruments
5750     database by sending the following command:     database by sending the following command:
5751    
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5752        REMOVE DB_INSTRUMENT <instr_path>        REMOVE DB_INSTRUMENT <instr_path>
5753    
5754     Where <instr_path> is the absolute path name (in the instruments     Where <instr_path> is the absolute path name (in the instruments
# Line 5612  Internet-Draft        LinuxSampler Contr Line 5760  Internet-Draft        LinuxSampler Contr
5760    
5761           if the instrument is removed successfully           if the instrument is removed successfully
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck               Expires April 8, 2011               [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol         October 2010
5770    
5771    
5772        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5773    
5774           if the given path does not exist or is a directory.           if the given path does not exist or is a directory.
# Line 5648  Internet-Draft        LinuxSampler Contr Line 5805  Internet-Draft        LinuxSampler Contr
5805    
5806        S: "2"        S: "2"
5807    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 101]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5808  6.8.14.  Listing all instruments in specific directory  6.8.14.  Listing all instruments in specific directory
5809    
5810     The front-end can retrieve the current list of instruments in     The front-end can retrieve the current list of instruments in
# Line 5669  Internet-Draft        LinuxSampler Contr Line 5817  Internet-Draft        LinuxSampler Contr
5817     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5818     specified directory, will be returned.     specified directory, will be returned.
5819    
5820    
5821    
5822    
5823    Schoenebeck               Expires April 8, 2011               [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol         October 2010
5826    
5827    
5828     Possible Answers:     Possible Answers:
5829    
5830        A comma separated list of all instruments (encapsulated into        A comma separated list of all instruments (encapsulated into
# Line 5705  Internet-Draft        LinuxSampler Contr Line 5861  Internet-Draft        LinuxSampler Contr
5861        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
5862        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
5863        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5864        following categories are defined:        following categories are defined:
5865    
5866    
# Line 5724  Internet-Draft        LinuxSampler Contr Line 5872  Internet-Draft        LinuxSampler Contr
5872    
5873           INSTRUMENT_NR -           INSTRUMENT_NR -
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires April 8, 2011               [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol         October 2010
5882    
5883    
5884              Index of the instrument within the file.              Index of the instrument within the file.
5885    
5886           FORMAT_FAMILY -           FORMAT_FAMILY -
# Line 5760  Internet-Draft        LinuxSampler Contr Line 5917  Internet-Draft        LinuxSampler Contr
5917              either true or false, determines whether the instrument is a              either true or false, determines whether the instrument is a
5918              drumkit or a chromatic instrument              drumkit or a chromatic instrument
5919    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 103]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5920           PRODUCT -           PRODUCT -
5921    
5922              The product title of the instrument.  Note that the              The product title of the instrument.  Note that the
# Line 5779  Internet-Draft        LinuxSampler Contr Line 5927  Internet-Draft        LinuxSampler Contr
5927              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5928              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5929    
5930    
5931    
5932    
5933    
5934    
5935    Schoenebeck               Expires April 8, 2011               [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol         October 2010
5938    
5939    
5940           KEYWORDS -           KEYWORDS -
5941    
5942              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
# Line 5816  Internet-Draft        LinuxSampler Contr Line 5974  Internet-Draft        LinuxSampler Contr
5974    
5975           "KEYWORDS: Bosendorfer"           "KEYWORDS: Bosendorfer"
5976    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 104]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
5977           "."           "."
5978    
5979  6.8.16.  Renaming an instrument  6.8.16.  Renaming an instrument
# Line 5837  Internet-Draft        LinuxSampler Contr Line 5986  Internet-Draft        LinuxSampler Contr
5986     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
5987     is the new name for that instrument.     is the new name for that instrument.
5988    
5989    
5990    
5991    Schoenebeck               Expires April 8, 2011               [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol         October 2010
5994    
5995    
5996     Possible Answers:     Possible Answers:
5997    
5998        "OK" -        "OK" -
# Line 5871  Internet-Draft        LinuxSampler Contr Line 6027  Internet-Draft        LinuxSampler Contr
6027    
6028           on success           on success
6029    
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 105]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6030        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6031    
6032           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
# Line 5894  Internet-Draft        LinuxSampler Contr Line 6040  Internet-Draft        LinuxSampler Contr
6040    
6041        S: "OK"        S: "OK"
6042    
6043    
6044    
6045    
6046    
6047    Schoenebeck               Expires April 8, 2011               [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol         October 2010
6050    
6051    
6052  6.8.18.  Copying instruments  6.8.18.  Copying instruments
6053    
6054     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 5928  Internet-Draft        LinuxSampler Contr Line 6083  Internet-Draft        LinuxSampler Contr
6083     The front-end can alter the description of a specific instrument by     The front-end can alter the description of a specific instrument by
6084     sending the following command:     sending the following command:
6085    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 106]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6086        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
6087    
6088     Where <instr> is the absolute path name of the instrument and <desc>     Where <instr> is the absolute path name of the instrument and <desc>
# Line 5950  Internet-Draft        LinuxSampler Contr Line 6096  Internet-Draft        LinuxSampler Contr
6096    
6097           on success           on success
6098    
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires April 8, 2011               [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol         October 2010
6106    
6107    
6108        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6109    
6110           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 5984  Internet-Draft        LinuxSampler Contr Line 6139  Internet-Draft        LinuxSampler Contr
6139    
6140     SIZE=[<min>]..[<max>]     SIZE=[<min>]..[<max>]
6141    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 107]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6142        Restricts the search to instruments, which size is in the        Restricts the search to instruments, which size is in the
6143        specified range.  If <min> is omitted, the search results are        specified range.  If <min> is omitted, the search results are
6144        restricted to instruments with size less then or equal to <max>.        restricted to instruments with size less then or equal to <max>.
# Line 6008  Internet-Draft        LinuxSampler Contr Line 6154  Internet-Draft        LinuxSampler Contr
6154        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
6155        instruments created after <date-after>.        instruments created after <date-after>.
6156    
6157    
6158    
6159    Schoenebeck               Expires April 8, 2011               [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol         October 2010
6162    
6163    
6164     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
6165    
6166        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 6041  Internet-Draft        LinuxSampler Contr Line 6194  Internet-Draft        LinuxSampler Contr
6194    
6195     KEYWORDS='<search-string>'     KEYWORDS='<search-string>'
6196    
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 108]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6197        Restricts the search to instruments with keyword list that        Restricts the search to instruments with keyword list that
6198        satisfies the supplied search string (encapsulated into        satisfies the supplied search string (encapsulated into
6199        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 6065  Internet-Draft        LinuxSampler Contr Line 6210  Internet-Draft        LinuxSampler Contr
6210        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
6211        families.        families.
6212    
6213    
6214    
6215    Schoenebeck               Expires April 8, 2011               [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol         October 2010
6218    
6219    
6220     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
6221     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
6222    
# Line 6096  Internet-Draft        LinuxSampler Contr Line 6248  Internet-Draft        LinuxSampler Contr
6248     The front-end can ask for the current status of a particular database     The front-end can ask for the current status of a particular database
6249     instruments job by sending the following command:     instruments job by sending the following command:
6250    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 109]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6251        GET DB_INSTRUMENTS_JOB INFO <job-id>        GET DB_INSTRUMENTS_JOB INFO <job-id>
6252    
6253     Where <job-id> should be replaced by the numerical ID of the job the     Where <job-id> should be replaced by the numerical ID of the job the
# Line 6122  Internet-Draft        LinuxSampler Contr Line 6265  Internet-Draft        LinuxSampler Contr
6265    
6266           FILES_TOTAL -           FILES_TOTAL -
6267    
6268    
6269    
6270    
6271    Schoenebeck               Expires April 8, 2011               [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol         October 2010
6274    
6275    
6276              The total number of files scheduled for scanning              The total number of files scheduled for scanning
6277    
6278           FILES_SCANNED -           FILES_SCANNED -
# Line 6153  Internet-Draft        LinuxSampler Contr Line 6304  Internet-Draft        LinuxSampler Contr
6304    
6305           "STATUS: 42"           "STATUS: 42"
6306    
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 110]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6307           "."           "."
6308    
6309  6.8.22.  Formatting the instruments database  6.8.22.  Formatting the instruments database
# Line 6177  Internet-Draft        LinuxSampler Contr Line 6320  Internet-Draft        LinuxSampler Contr
6320    
6321           on success           on success
6322    
6323    
6324    
6325    
6326    
6327    Schoenebeck               Expires April 8, 2011               [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol         October 2010
6330    
6331    
6332        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6333    
6334           If the formatting of the instruments database failed.           If the formatting of the instruments database failed.
# Line 6206  Internet-Draft        LinuxSampler Contr Line 6358  Internet-Draft        LinuxSampler Contr
6358        S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free        S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
6359        Piano.gig'"        Piano.gig'"
6360    
   
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 111]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6361  6.8.24.  Replacing an instrument file  6.8.24.  Replacing an instrument file
6362    
6363     The front-end can substitute all occurrences of an instrument file in     The front-end can substitute all occurrences of an instrument file in
# Line 6234  Internet-Draft        LinuxSampler Contr Line 6375  Internet-Draft        LinuxSampler Contr
6375    
6376           on success           on success
6377    
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck               Expires April 8, 2011               [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol         October 2010
6386    
6387    
6388        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6389    
6390           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 6263  Internet-Draft        LinuxSampler Contr Line 6414  Internet-Draft        LinuxSampler Contr
6414     The front-end can request to open an appropriate instrument editor     The front-end can request to open an appropriate instrument editor
6415     application by sending the following command:     application by sending the following command:
6416    
   
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 112]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6417        EDIT CHANNEL INSTRUMENT <sampler-channel>        EDIT CHANNEL INSTRUMENT <sampler-channel>
6418    
6419     Where <sampler-channel> should be replaced by the number of the     Where <sampler-channel> should be replaced by the number of the
# Line 6293  Internet-Draft        LinuxSampler Contr Line 6434  Internet-Draft        LinuxSampler Contr
6434     Note: consequently instrument editors are always spawned locally on     Note: consequently instrument editors are always spawned locally on
6435     the same machine where the sampler is running on!     the same machine where the sampler is running on!
6436    
6437    
6438    
6439    Schoenebeck               Expires April 8, 2011               [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol         October 2010
6442    
6443    
6444     Possible Answers:     Possible Answers:
6445    
6446        "OK" -        "OK" -
# Line 6321  Internet-Draft        LinuxSampler Contr Line 6469  Internet-Draft        LinuxSampler Contr
6469     set allows to retrieve file informations even remotely from another     set allows to retrieve file informations even remotely from another
6470     machine.     machine.
6471    
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 113]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6472  6.10.1.  Retrieving amount of instruments of a file  6.10.1.  Retrieving amount of instruments of a file
6473    
6474     The front-end can retrieve the amount of instruments within a given     The front-end can retrieve the amount of instruments within a given
# Line 6349  Internet-Draft        LinuxSampler Contr Line 6489  Internet-Draft        LinuxSampler Contr
6489        On success, the sampler will answer by returning the amount of        On success, the sampler will answer by returning the amount of
6490        instruments.        instruments.
6491    
6492    
6493    
6494    
6495    Schoenebeck               Expires April 8, 2011               [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol         October 2010
6498    
6499    
6500        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6501    
6502           if the file could not be handled           if the file could not be handled
# Line 6376  Internet-Draft        LinuxSampler Contr Line 6524  Internet-Draft        LinuxSampler Contr
6524    
6525     Possible Answers:     Possible Answers:
6526    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 114]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6527        On success, the sampler will answer by returning a comma separated        On success, the sampler will answer by returning a comma separated
6528        list of instrument IDs.        list of instrument IDs.
6529    
# Line 6404  Internet-Draft        LinuxSampler Contr Line 6543  Internet-Draft        LinuxSampler Contr
6543     instrument within a given instrument file by sending the following     instrument within a given instrument file by sending the following
6544     command:     command:
6545    
6546    
6547    
6548    
6549    
6550    
6551    Schoenebeck               Expires April 8, 2011               [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol         October 2010
6554    
6555    
6556        GET FILE INSTRUMENT INFO <filename> <instr-id>        GET FILE INSTRUMENT INFO <filename> <instr-id>
6557    
6558     Where <filename> is the name of the instrument file (encapsulated     Where <filename> is the name of the instrument file (encapsulated
# Line 6432  Internet-Draft        LinuxSampler Contr Line 6581  Internet-Draft        LinuxSampler Contr
6581    
6582           FORMAT_FAMILY -           FORMAT_FAMILY -
6583    
   
   
   
   
 Schoenebeck                Expires May 5, 2010                [Page 115]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2009  
   
   
6584              name of the sampler format of the given instrument              name of the sampler format of the given instrument
6585    
6586           FORMAT_VERSION -           FORMAT_VERSION -
# Line 6462  Internet-Draft        LinuxSampler Contr Line 6602  Internet-Draft        LinuxSampler Contr
6602              instrument's key mapping in the range between 0 .. 127,              instrument's key mapping in the range between 0 .. 127,
6603              reflecting the analog meaning of the MIDI specification.              reflecting the analog meaning of the MIDI specification.
6604    
6605    
6606    
6607    Schoenebeck               Expires April 8, 2011               [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol         October 2010
6610    
6611    
6612           KEYSWITCH_BINDINGS -           KEYSWITCH_BINDINGS -
6613    
6614              comma separated list of integer values representing the              comma separated list of integer values representing the
# Line 6487  Internet-Draft        LinuxSampler Contr Line 6634  Internet-Draft        LinuxSampler Contr
6634    
6635           "."           "."
6636    
6637    6.11.  Managing Effects
6638    
6639       Audio effects (e.g. reverb, delay, compression) can be applied to the
6640       audio signals generated by the sampler.  The sampler usually provides
6641       a set of internal audio effects for this task.  The exact set of
6642       effects depends on the availability of third party effect plugins
6643       installed on the system where the sampler runs on.
6644    
6645       At the moment only "send effects" are supported.  Support for "insert
6646       effects" and "master effects" is planned to be added at a later
6647       point.
6648    
6649       The following commands allow to retrieve the set of internal effects
6650       available to the sampler, detailed informations about those effects
6651       and to create and destroy instances of such effects.  After an
6652       instance of an effect is created, the effect instance can be inserted
6653       into the audio signal path of the sampler, e.g. as send effect.
6654    
6655       The sampler allows to create an arbitrary amount of so called send
6656       effect chains.  Each effect chain can host an arbitrary amount of
6657       effect instances.  The output of the first effect instance in an
6658       effect chain is fed to the input of the second effect instance of the
6659       chain and so on.  So effects in one chain are processed sequentially.
6660    
6661    
6662    
6663    Schoenebeck               Expires April 8, 2011               [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol         October 2010
6666    
6667    
6668       Send effect chains however are processed in parallel to other send
6669       effect chains.  Audio signals of sampler channels are fed to send
6670       effects by creating FX sends to the respective sampler channel and
6671       assigning a destination send effect to that FX by using the "SET
6672       FX_SEND SEND_EFFECT" (Section 6.4.32) command.  The latter allows to
6673       route the FX send to the beginning of a send effect chain, as well as
6674       directly to any other position of the send effect chain.
6675    
6676    6.11.1.  Retrieve amount of available effects
6677    
6678       The front-end can retrieve the amount of internal effects, available
6679       to the sampler by sending the following command:
6680    
6681          GET AVAILABLE_EFFECTS
6682    
6683       Possible Answers:
6684    
6685          The sampler will answer by returning the current number of effects
6686          available to the sampler.
6687    
6688       Examples:
6689    
6690          C: "GET AVAILABLE_EFFECTS"
6691    
6692          S: "129"
6693    
6694    6.11.2.  Get list of available effects
6695    
6696       The set of available internal effects can change at runtime.  The
6697       front-end can retrieve the list of internal effects, available to the
6698       sampler by sending the following command:
6699    
6700          LIST AVAILABLE_EFFECTS
6701    
6702       Possible Answers:
6703    
6704          The sampler will answer by returning a comma separated list with
6705          numerical IDs of effects.  Note: the numercial ID of an effect is
6706          generated by the sampler for the current moment.  The numerical ID
6707          of the same effect can change at runtime, e.g. when the user
6708          requests a rescan of available effect plugins.
6709    
6710       Example:
6711    
6712          C: "LIST AVAILABLE_EFFECTS"
6713    
6714          S: "5,6,7,120,121,122,123,124"
6715    
6716    
6717    
6718    
6719    Schoenebeck               Expires April 8, 2011               [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol         October 2010
6722    
6723    
6724    6.11.3.  Retrieving general information about an effect
6725    
6726       The front-end can ask for general informations about an effect by
6727       sending the following command:
6728    
6729          GET EFFECT INFO <effect-index>
6730    
6731       Where <effect-index> is the numerical ID of an effect as returned by
6732       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
6733    
6734       Possible Answers:
6735    
6736          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6737          answer line begins with the effect information category name,
6738          followed by a colon and then a space character <SP> and finally
6739          the info character string to that effect information category.  At
6740          the moment the following categories are defined:
6741    
6742    
6743    
6744             SYSTEM -
6745    
6746                name of the effect plugin system the effect is based on
6747                (e.g.  "LADSPA")
6748    
6749             MODULE -
6750    
6751                module of the effect plugin system that contains this
6752                effect, the module is usually the dynamic-linked library
6753                (DLL) filename of the effect plugin, including full path
6754                (note that this filename may contain escape sequences
6755                (Section 7.1))
6756    
6757             NAME -
6758    
6759                character string defining the unique name of the effect
6760                within its module (note that the character string may
6761                contain escape sequences (Section 7.1))
6762    
6763             DESCRIPTION -
6764    
6765                human readable name of the effect, intended to be displayed
6766                in user interfaces (note that the character string may
6767                contain escape sequences (Section 7.1))
6768    
6769       The mentioned fields above don't have to be in particular order.
6770    
6771       Example:
6772    
6773    
6774    
6775    Schoenebeck               Expires April 8, 2011               [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol         October 2010
6778    
6779    
6780          C: "GET EFFECT INFO 121"
6781    
6782          S: "SYSTEM: LADSPA"
6783    
6784             "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"
6785    
6786             "NAME: lowpass_iir"
6787    
6788             "DESCRIPTION: Glame Lowpass Filter"
6789    
6790             "."
6791    
6792    6.11.4.  Creating an instance of an effect by its portable ID
6793    
6794       The front-end can spawn an instance of the desired effect by sending
6795       the following command:
6796    
6797          CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name>
6798    
6799       Where <effect-system> is the "SYSTEM" field, <module> the "MODULE"
6800       field and <effect-name> the "NAME" field as returned by the "GET
6801       EFFECT INFO" (Section 6.11.3) command.  The filename of argument
6802       <module> and the character string of argument <effect-name> may
6803       contain escape sequences (Section 7.1).
6804    
6805       The sampler will try to load the requested effect and to create an
6806       instance of it.  To allow loading the same effect on a different
6807       machine, probably even running a completely different operating
6808       system (e.g.  Linux vs. Windows), the sampler tries to match <module>
6809       "softly".  That means it first tries to find an effect that exactly
6810       matches the given <module> argument.  If there is no exact match, the
6811       sampler will try to lower the restrictions on matching the <module>
6812       argument more and more, e.g. by ignoring upper / lower case
6813       differences and by ignoring the path of the DLL filename and file
6814       extension.  If there is still no match at the end, the sampler will
6815       try to ignore the <module> argument completely and as a last resort
6816       search for an effect that only matches the given <effect-system> and
6817       <effect-name> arguments.
6818    
6819       Possible Answers:
6820    
6821          "OK[<effect-instance>]" -
6822    
6823             in case the effect instance was successfully created, where
6824             <effect-instance> is the numerical ID of the new effect
6825             instance
6826    
6827    
6828    
6829    
6830    
6831    Schoenebeck               Expires April 8, 2011               [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol         October 2010
6834    
6835    
6836          "WRN:<warning-code>:<warning-message>" -
6837    
6838             in case the effect instance was spawned successfully, but there
6839             are noteworthy issue(s) related, providing an appropriate
6840             warning code and warning message
6841    
6842          "ERR:<error-code>:<error-message>" -
6843    
6844             if the effect could not be instantiated
6845    
6846       Examples:
6847    
6848          C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/
6849          mod_delay_1419.so' 'modDelay'"
6850    
6851          S: "OK[0]"
6852    
6853    6.11.5.  Creating an instance of an effect by its numerical ID
6854    
6855       The front-end can spawn an instance of the desired effect by sending
6856       the following command:
6857    
6858          CREATE EFFECT_INSTANCE <effect-index>
6859    
6860       Where <effect-index> is the numerical ID of the effect as returned by
6861       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
6862    
6863       The sampler will try to load the requested effect and to create an
6864       instance of it.
6865    
6866       Note: Since the numerical ID of a certain effect can change at any
6867       time, you should not use this command in LSCP files to restore a
6868       certain effect at a later time!  To store a sampler session including
6869       all its effects, use the portable text-based version of "CREATE
6870       EFFECT_INSTANCE" (Section 6.11.4) instead!  This allows to restore a
6871       sampler session with all its effects also on other machines, possibly
6872       even running a completely different operating system (e.g.  Linux vs.
6873       Windows), with different plugin directories or plugin DLL names.
6874    
6875       Possible Answers:
6876    
6877          "OK[<effect-instance>]" -
6878    
6879             in case the effect instance was successfully created, where
6880             <effect-instance> is the numerical ID of the new effect
6881             instance
6882    
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires April 8, 2011               [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol         October 2010
6890    
6891    
6892          "WRN:<warning-code>:<warning-message>" -
6893    
6894             in case the effect instance was spawned successfully, but there
6895             are noteworthy issue(s) related, providing an appropriate
6896             warning code and warning message
6897    
6898          "ERR:<error-code>:<error-message>" -
6899    
6900             if the effect could not be instantiated
6901    
6902       Examples:
6903    
6904          C: "CREATE EFFECT_INSTANCE 72"
6905    
6906          S: "OK[5]"
6907    
6908    6.11.6.  Destroy an effect instance
6909    
6910       The front-end can destroy an unusued effect instance and thus freeing
6911       it from memory by sending the following command:
6912    
6913          DESTROY EFFECT_INSTANCE <effect-instance>
6914    
6915       Where <effect-instance> is the numerical ID of the effect instance as
6916       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
6917       EFFECT_INSTANCES" (Section 6.11.8) command.
6918    
6919       The effect instance can only be destroyed if it's not used in any
6920       part of the sampler's audio signal path anymore.  If the effect
6921       instance is still in use somewhere, trying to destroy the effect
6922       instance will result in an error message.
6923    
6924       Possible Answers:
6925    
6926          "OK" -
6927    
6928             in case the effect instance was successfully destroyed
6929    
6930          "ERR:<error-code>:<error-message>" -
6931    
6932             in case it failed, providing an appropriate error code and
6933             error message
6934    
6935       Examples:
6936    
6937          C: "DESTROY EFFECT_INSTANCE 5"
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck               Expires April 8, 2011               [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol         October 2010
6946    
6947    
6948          S: "OK"
6949    
6950    6.11.7.  Retrieve amount of effect instances
6951    
6952       The front-end can retrieve the current amount of effect instances by
6953       sending the following command:
6954    
6955          GET EFFECT_INSTANCES
6956    
6957       Possible Answers:
6958    
6959          The sampler will answer by returning the current number of effect
6960          instances created and not yet destroyed in the current sampler
6961          session.
6962    
6963       Examples:
6964    
6965          C: "GET EFFECT_INSTANCES"
6966    
6967          S: "14"
6968    
6969    6.11.8.  Get list of effect instances
6970    
6971       The front-end can retrieve the current list of effect instances by
6972       sending the following command:
6973    
6974          LIST EFFECT_INSTANCES
6975    
6976       Possible Answers:
6977    
6978          The sampler will answer by returning a comma separated list with
6979          numerical IDs of effects instances.
6980    
6981       Example:
6982    
6983          C: "LIST EFFECT_INSTANCES"
6984    
6985          S: "9,11,14,15,16,17,25"
6986    
6987    6.11.9.  Retrieving current information about an effect instance
6988    
6989       The front-end can ask for the current informations about a particular
6990       effect instance by sending the following command:
6991    
6992          GET EFFECT_INSTANCE INFO <effect-instance>
6993    
6994       Where <effect-instance> is the numerical ID of an effect instance as
6995       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
6996    
6997    
6998    
6999    Schoenebeck               Expires April 8, 2011               [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol         October 2010
7002    
7003    
7004       EFFECT_INSTANCES" (Section 6.11.8) command.
7005    
7006       Possible Answers:
7007    
7008          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7009          answer line begins with the information category name, followed by
7010          a colon and then a space character <SP> and finally the info
7011          character string to that information category.  At the moment the
7012          following categories are defined:
7013    
7014    
7015    
7016             SYSTEM -
7017    
7018                name of the effect plugin system the effect is based on
7019                (e.g.  "LADSPA")
7020    
7021             MODULE -
7022    
7023                module of the effect plugin system that contains this
7024                effect, the module is usually the dynamic-linked library
7025                (DLL) filename of the effect plugin, including full path
7026                (note that this filename may contain escape sequences
7027                (Section 7.1))
7028    
7029             NAME -
7030    
7031                character string defining the unique name of the effect
7032                within its module (note that the character string may
7033                contain escape sequences (Section 7.1))
7034    
7035             DESCRIPTION -
7036    
7037                human readable name of the effect, intended to be displayed
7038                in user interfaces (note that the character string may
7039                contain escape sequences (Section 7.1))
7040    
7041             INPUT_CONTROLS -
7042    
7043                amount of input controls the effect instance provides, to
7044                allow controlling the effect parameters in realtime
7045    
7046       The mentioned fields above don't have to be in particular order.
7047    
7048       Example:
7049    
7050    
7051    
7052    
7053    
7054    
7055    Schoenebeck               Expires April 8, 2011               [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol         October 2010
7058    
7059    
7060          C: "GET EFFECT_INSTANCE INFO 3"
7061    
7062          S: "SYSTEM: LADSPA"
7063    
7064             "MODULE: /usr/lib/ladspa/mod_delay_1419.so"
7065    
7066             "NAME: modDelay"
7067    
7068             "DESCRIPTION: Modulatable delay"
7069    
7070             "INPUT_CONTROLS: 1"
7071    
7072             "."
7073    
7074    6.11.10.  Retrieving information about an effect parameter
7075    
7076       Effects typically provide a certain set of effect parameters which
7077       can be altered by the user in realtime (e.g. depth of a reverb
7078       effect, duration of a delay effect, dry / wet signal ratio).  Those
7079       controllable effect parameters are called "input controls".  The
7080       front-end can ask for the current informations of an effect
7081       instance's input control by sending the following command:
7082    
7083          GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-
7084          control>
7085    
7086       Where <effect-instance> is the numerical ID of an effect instance as
7087       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7088       EFFECT_INSTANCES" (Section 6.11.8) command and <input-control> is the
7089       index of the input control within the numerical bounds as returned by
7090       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7091       (Section 6.11.9) command.
7092    
7093       Possible Answers:
7094    
7095          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7096          answer line begins with the information category name, followed by
7097          a colon and then a space character <SP> and finally the info
7098          character string to that information category.  There are
7099          information categories which are always returned, independent of
7100          the respective effect parameter and there are optional information
7101          categories which are only shown for certain effect parameters.  At
7102          the moment the following categories are defined:
7103    
7104    
7105    
7106             DESCRIPTION -
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires April 8, 2011               [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol         October 2010
7114    
7115    
7116                (always returned) human readable name of the effect
7117                parameter, intended to be displayed in user interfaces (note
7118                that the character string may contain escape sequences
7119                (Section 7.1))
7120    
7121             VALUE -
7122    
7123                (always returned) current (optional dotted) floating point
7124                value of this effect parameter
7125    
7126             RANGE_MIN -
7127    
7128                (optionally returned) minimum allowed value for this effect
7129                parameter
7130    
7131             RANGE_MAX -
7132    
7133                (optionally returned) maximum allowed value for this effect
7134                parameter
7135    
7136             POSSIBILITIES -
7137    
7138                (optionally returned) comma separated list of (optional
7139                dotted) floating point numbers, reflecting the exact set of
7140                possible values for this effect parameter
7141    
7142             DEFAULT -
7143    
7144                (optionally returned) default value of this effect parameter
7145    
7146       The mentioned fields above don't have to be in particular order.
7147    
7148       Example:
7149    
7150          C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"
7151    
7152          S: "SYSTEM: LADSPA"
7153    
7154             "DESCRIPTION: Base delay (s)"
7155    
7156             "VALUE: 0.500"
7157    
7158             "RANGE_MIN: 0.000"
7159    
7160             "."
7161    
7162    
7163    
7164    
7165    
7166    
7167    Schoenebeck               Expires April 8, 2011               [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol         October 2010
7170    
7171    
7172    6.11.11.  Altering an effect parameter
7173    
7174       The front-end can alter the current value of an effect parameter by
7175       sending the following command:
7176    
7177          SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-
7178          control> <value>
7179    
7180       Where <effect-instance> i