/[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 1162 by iliev, Mon Apr 16 16:02:19 2007 UTC revision 2189 by iliev, Fri Jun 24 19:57:07 2011 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: October 18, 2007                                 April 16, 2007  Expires: December 26, 2011                                 June 24, 2011
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.2                                  LSCP 1.5
12    
13    Abstract
14    
15       The LinuxSampler Control Protocol (LSCP) is an application-level
16       protocol primarily intended for local and remote controlling the
17       LinuxSampler backend application, which is a sophisticated server-
18       like console application essentially playing back audio samples and
19       manipulating the samples in real time to certain extent.
20    
21  Status of this Memo  Status of this Memo
22    
# Line 33  Status of this Memo Line 41  Status of this Memo
41     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
42     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
43    
44     This Internet-Draft will expire on October 18, 2007.     This Internet-Draft will expire on December 26, 2011.
   
 Copyright Notice  
45    
    Copyright (C) The IETF Trust (2007).  
46    
47    
48    
# Line 47  Copyright Notice Line 52  Copyright Notice
52    
53    
54    
55    Schoenebeck             Expires December 26, 2011               [Page 1]
   
   
   
   
 Schoenebeck             Expires October 18, 2007                [Page 1]  
56    
57  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
   
   
 Abstract  
   
    The LinuxSampler Control Protocol (LSCP) is an application-level  
    protocol primarily intended for local and remote controlling the  
    LinuxSampler backend application, which is a sophisticated server-  
    like console application essentially playing back audio samples and  
    manipulating the samples in real time to certain extent.  
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 . . . . .  38
100           6.3.9.   Getting current settings of a MIDI input device  . .  39
101           6.3.10.  Changing settings of MIDI input devices  . . . . . .  40
102  Schoenebeck             Expires October 18, 2007                [Page 2]         6.3.11.  Getting information about a MIDI port  . . . . . . .  40
103           6.3.12.  Getting information about specific MIDI port
104  Internet-Draft        LinuxSampler Control Protocol           April 2007                  parameter  . . . . . . . . . . . . . . . . . . . . .  41
105           6.3.13.  Changing settings of MIDI input ports  . . . . . . .  43
106         6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  44
107         6.3.8.  Getting all created MIDI input device list  . . . . .  37         6.4.1.   Loading an instrument  . . . . . . . . . . . . . . .  44
108         6.3.9.  Getting current settings of a MIDI input device . . .  38  
109         6.3.10. Changing settings of MIDI input devices . . . . . . .  39  
110         6.3.11. Getting information about a MIDI port . . . . . . . .  39  
111         6.3.12. Getting information about specific MIDI port  Schoenebeck             Expires December 26, 2011               [Page 2]
112                 parameter . . . . . . . . . . . . . . . . . . . . . .  40  
113         6.3.13. Changing settings of MIDI input ports . . . . . . . .  42  Internet-Draft        LinuxSampler Control Protocol            June 2011
114       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43  
115         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43  
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  . . . . . .  45         6.4.4.   Getting all created sampler channel list . . . . . .  47
119         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  45         6.4.5.   Adding a new sampler channel . . . . . . . . . . . .  47
120         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  46         6.4.6.   Removing a sampler channel . . . . . . . . . . . . .  48
121         6.4.7.  Getting amount of available engines . . . . . . . . .  47         6.4.7.   Getting amount of available engines  . . . . . . . .  49
122         6.4.8.  Getting all available engines . . . . . . . . . . . .  47         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 . . . . . . . .  52         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 . . . . . . . . . . . . . .  54         6.4.15.  Setting audio output type  . . . . . . . . . . . . .  56
130         6.4.16. Setting audio output channel  . . . . . . . . . . . .  55         6.4.16.  Setting audio output channel . . . . . . . . . . . .  57
131         6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56         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 . . . . . . . . . . . . . . .  57         6.4.19.  Setting MIDI input port  . . . . . . . . . . . . . .  59
134         6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58         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  . . . . . . . . . . . . . .  59         6.4.22.  Muting a sampler channel . . . . . . . . . . . . . .  61
137         6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60         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  . . .  63         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 . . . .  64                  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 . . . . . . . . . . . . .  66         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 . . . . . . . . . .  68         6.4.32.  Assigning destination effect to an effect send . . .  70
149         6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  69         6.4.33.  Removing destination effect from an effect send  . .  71
150       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70         6.4.34.  Altering effect send's MIDI controller . . . . . . .  72
151         6.5.1.  Register front-end for receiving event messages . . .  70         6.4.35.  Altering effect send's send level  . . . . . . . . .  72
152         6.5.2.  Unregister front-end for not receiving event         6.4.36.  Sending MIDI messages to sampler channel . . . . . .  73
153                 messages  . . . . . . . . . . . . . . . . . . . . . .  71         6.4.37.  Resetting a sampler channel  . . . . . . . . . . . .  74
154         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  71       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  75
155           6.5.1.   Register front-end for receiving event messages  . .  75
156           6.5.2.   Unregister front-end for not receiving event
157                    messages . . . . . . . . . . . . . . . . . . . . . .  76
158  Schoenebeck             Expires October 18, 2007                [Page 3]         6.5.3.   Enable or disable echo of commands . . . . . . . . .  76
159           6.5.4.   Close client connection  . . . . . . . . . . . . . .  77
160  Internet-Draft        LinuxSampler Control Protocol           April 2007       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  77
161           6.6.1.   Current number of active voices  . . . . . . . . . .  77
162           6.6.2.   Maximum amount of active voices  . . . . . . . . . .  78
163         6.5.4.  Close client connection . . . . . . . . . . . . . . .  72         6.6.3.   Current number of active disk streams  . . . . . . .  78
164       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  72  
165         6.6.1.  Current number of active voices . . . . . . . . . . .  72  
166         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73  
167         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73  Schoenebeck             Expires December 26, 2011               [Page 3]
168         6.6.4.  General sampler informations  . . . . . . . . . . . .  73  
169         6.6.5.  Getting global volume attenuation . . . . . . . . . .  74  Internet-Draft        LinuxSampler Control Protocol            June 2011
170         6.6.6.  Setting global volume attenuation . . . . . . . . . .  74  
171       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75  
172         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76         6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  78
173         6.7.2.  Delete one particular or all MIDI instrument maps . .  76         6.6.5.   General sampler informations . . . . . . . . . . . .  78
174         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77         6.6.6.   Getting global volume attenuation  . . . . . . . . .  79
175         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  77         6.6.7.   Setting global volume attenuation  . . . . . . . . .  80
176         6.7.5.  Getting MIDI instrument map information . . . . . . .  78         6.6.8.   Getting global voice limit . . . . . . . . . . . . .  80
177         6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79         6.6.9.   Setting global voice limit . . . . . . . . . . . . .  81
178         6.7.7.  Create or replace a MIDI instrument map entry . . . .  79         6.6.10.  Getting global disk stream limit . . . . . . . . . .  81
179         6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82         6.6.11.  Setting global disk stream limit . . . . . . . . . .  82
180         6.7.9.  Getting indeces of all entries of a MIDI       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  83
181                 instrument map  . . . . . . . . . . . . . . . . . . .  83         6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  83
182         6.7.10. Remove an entry from the MIDI instrument map  . . . .  83         6.7.2.   Delete one particular or all MIDI instrument maps  .  84
183         6.7.11. Get current settings of MIDI instrument map entry . .  84         6.7.3.   Get amount of existing MIDI instrument maps  . . . .  85
184         6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86         6.7.4.   Getting all created MIDI instrument maps . . . . . .  85
185       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  86         6.7.5.   Getting MIDI instrument map information  . . . . . .  86
186         6.8.1.  Creating a new instrument directory . . . . . . . . .  86         6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  87
187         6.8.2.  Deleting an instrument directory  . . . . . . . . . .  87         6.7.7.   Create or replace a MIDI instrument map entry  . . .  87
188         6.8.3.  Getting amount of instrument directories  . . . . . .  88         6.7.8.   Getting ammount of MIDI instrument map entries . . .  90
189         6.8.4.  Listing all directories in specific directory . . . .  88         6.7.9.   Getting indeces of all entries of a MIDI
190         6.8.5.  Getting instrument directory information  . . . . . .  89                  instrument map . . . . . . . . . . . . . . . . . . .  91
191         6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90         6.7.10.  Remove an entry from the MIDI instrument map . . . .  91
192         6.8.7.  Moving an instrument directory  . . . . . . . . . . .  90         6.7.11.  Get current settings of MIDI instrument map entry  .  92
193         6.8.8.  Changing the description of directory . . . . . . . .  91         6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  94
194         6.8.9.  Adding instruments to the instruments database  . . .  92       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  94
195         6.8.10. Removing an instrument  . . . . . . . . . . . . . . .  93         6.8.1.   Creating a new instrument directory  . . . . . . . .  95
196         6.8.11. Getting amount of instruments . . . . . . . . . . . .  93         6.8.2.   Deleting an instrument directory . . . . . . . . . .  95
197         6.8.12. Listing all instruments in specific directory . . . .  94         6.8.3.   Getting amount of instrument directories . . . . . .  96
198         6.8.13. Getting instrument information  . . . . . . . . . . .  94         6.8.4.   Listing all directories in specific directory  . . .  96
199         6.8.14. Renaming an instrument  . . . . . . . . . . . . . . .  97         6.8.5.   Getting instrument directory information . . . . . .  97
200         6.8.15. Moving an instrument  . . . . . . . . . . . . . . . .  97         6.8.6.   Renaming an instrument directory . . . . . . . . . .  98
201         6.8.16. Changing the description of instrument  . . . . . . .  98         6.8.7.   Moving an instrument directory . . . . . . . . . . .  99
202     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  99         6.8.8.   Copying instrument directories . . . . . . . . . . .  99
203     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 112         6.8.9.   Changing the description of directory  . . . . . . . 100
204       8.1.  Number of audio output devices changed  . . . . . . . . . 112         6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 101
205       8.2.  Audio output device's settings changed  . . . . . . . . . 112         6.8.11.  Adding instruments to the instruments database . . . 102
206       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 112         6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 104
207       8.4.  MIDI input device's settings changed  . . . . . . . . . . 113         6.8.13.  Getting amount of instruments  . . . . . . . . . . . 104
208       8.5.  Number of sampler channels changed  . . . . . . . . . . . 113         6.8.14.  Listing all instruments in specific directory  . . . 105
209       8.6.  Number of active voices changed . . . . . . . . . . . . . 113         6.8.15.  Getting instrument information . . . . . . . . . . . 105
210       8.7.  Number of active disk streams changed . . . . . . . . . . 114         6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 108
211           6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 108
212           6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 109
213           6.8.19.  Changing the description of instrument . . . . . . . 110
214  Schoenebeck             Expires October 18, 2007                [Page 4]         6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 110
215           6.8.21.  Getting job status information . . . . . . . . . . . 113
216  Internet-Draft        LinuxSampler Control Protocol           April 2007         6.8.22.  Formatting the instruments database  . . . . . . . . 114
217           6.8.23.  Checking for lost instrument files . . . . . . . . . 114
218           6.8.24.  Replacing an instrument file . . . . . . . . . . . . 115
219       8.8.  Disk stream buffer fill state changed . . . . . . . . . . 114       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 115
220       8.9.  Channel information changed . . . . . . . . . . . . . . . 114  
221       8.10. Number of effect sends changed  . . . . . . . . . . . . . 115  
222       8.11. Effect send information changed . . . . . . . . . . . . . 115  
223       8.12. Total number of active voices changed . . . . . . . . . . 115  Schoenebeck             Expires December 26, 2011               [Page 4]
224       8.13. Number of MIDI instrument maps changed  . . . . . . . . . 116  
225       8.14. MIDI instrument map information changed . . . . . . . . . 116  Internet-Draft        LinuxSampler Control Protocol            June 2011
226       8.15. Number of MIDI instruments changed  . . . . . . . . . . . 116  
227       8.16. MIDI instrument information changed . . . . . . . . . . . 117  
228       8.17. Global settings changed . . . . . . . . . . . . . . . . . 117         6.9.1.   Opening an appropriate instrument editor
229       8.18. Number of database instrument directories changed . . . . 118                  application  . . . . . . . . . . . . . . . . . . . . 116
230       8.19. Database instrument directory information changed . . . . 118       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 117
231       8.20. Number of database instruments changed  . . . . . . . . . 119         6.10.1.  Retrieving amount of instruments of a file . . . . . 117
232       8.21. Database instrument information changed . . . . . . . . . 119         6.10.2.  Retrieving all instruments of a file . . . . . . . . 117
233       8.22. Miscellaneous and debugging events  . . . . . . . . . . . 120         6.10.3.  Retrieving informations about one instrument in a
234     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 121                  file . . . . . . . . . . . . . . . . . . . . . . . . 118
235     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 122       6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 120
236     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 123         6.11.1.  Retrieve amount of available effects . . . . . . . . 120
237     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 124         6.11.2.  Get list of available effects  . . . . . . . . . . . 121
238     Intellectual Property and Copyright Statements  . . . . . . . . . 125         6.11.3.  Retrieving general information about an effect . . . 121
239           6.11.4.  Creating an instance of an effect by its portable
240                    ID . . . . . . . . . . . . . . . . . . . . . . . . . 122
241           6.11.5.  Creating an instance of an effect by its
242                    numerical ID . . . . . . . . . . . . . . . . . . . . 123
243           6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 124
244           6.11.7.  Retrieve amount of effect instances  . . . . . . . . 125
245           6.11.8.  Get list of effect instances . . . . . . . . . . . . 126
246           6.11.9.  Retrieving current information about an effect
247                    instance . . . . . . . . . . . . . . . . . . . . . . 126
248           6.11.10. Retrieving information about an effect parameter . . 127
249           6.11.11. Altering an effect parameter . . . . . . . . . . . . 129
250           6.11.12. Retrieve amount of send effect chains  . . . . . . . 130
251           6.11.13. Retrieve list of send effect chains  . . . . . . . . 130
252           6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 131
253           6.11.15. Remove send effect chain . . . . . . . . . . . . . . 131
254           6.11.16. Retrieving information about a send effect chain . . 132
255           6.11.17. Append effect instance to a send effect chain  . . . 133
256           6.11.18. Insert effect instance to a send effect chain  . . . 134
257           6.11.19. Remove effect instance from send effect chain  . . . 134
258       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 136
259         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 152
260       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
261         8.1.  Number of audio output devices changed  . . . . . . . . . 157
262         8.2.  Audio output device's settings changed  . . . . . . . . . 157
263         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 157
264         8.4.  MIDI input device's settings changed  . . . . . . . . . . 158
265         8.5.  Number of sampler channels changed  . . . . . . . . . . . 158
266         8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 158
267         8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 159
268         8.8.  Number of active voices changed . . . . . . . . . . . . . 159
269         8.9.  Number of active disk streams changed . . . . . . . . . . 160
270         8.10. Disk stream buffer fill state changed . . . . . . . . . . 160
271         8.11. Channel information changed . . . . . . . . . . . . . . . 160
272         8.12. Number of effect sends changed  . . . . . . . . . . . . . 161
273         8.13. Effect send information changed . . . . . . . . . . . . . 161
274         8.14. Total number of active voices changed . . . . . . . . . . 162
275         8.15. Total number of active disk streams changed . . . . . . . 162
276    
277    
278    
279    Schoenebeck             Expires December 26, 2011               [Page 5]
280    
281    Internet-Draft        LinuxSampler Control Protocol            June 2011
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. Number of effect instances changed  . . . . . . . . . . . 166
295         8.27. Effect instance information changed . . . . . . . . . . . 167
296         8.28. Number of send effect chains changed  . . . . . . . . . . 167
297         8.29. Send effect chain information changed . . . . . . . . . . 167
298         8.30. Miscellaneous and debugging events  . . . . . . . . . . . 168
299       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 169
300       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 170
301       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 171
302       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 172
303       Intellectual Property and Copyright Statements  . . . . . . . . . 173
304    
305    
306    
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck             Expires October 18, 2007                [Page 5]  Schoenebeck             Expires December 26, 2011               [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
338    
339    
340  1.  Requirements notation  1.  Requirements notation
# Line 294  Internet-Draft        LinuxSampler Contr Line 350  Internet-Draft        LinuxSampler Contr
350     end) and server (LinuxSampler) respectively.  Lines in examples must     end) and server (LinuxSampler) respectively.  Lines in examples must
351     be interpreted as every line being CRLF terminated (carriage return     be interpreted as every line being CRLF terminated (carriage return
352     character followed by line feed character as defined in the ASCII     character followed by line feed character as defined in the ASCII
353     standard), thus the following example:     standard [RFC20]), thus the following example:
354    
355        C: "some line"        C: "some line"
356    
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck             Expires October 18, 2007                [Page 6]  Schoenebeck             Expires December 26, 2011               [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
394    
395    
396  2.  Versioning of this specification  2.  Versioning of this specification
# Line 363  Internet-Draft        LinuxSampler Contr Line 419  Internet-Draft        LinuxSampler Contr
419         sampler's LSCP minor version.         sampler's LSCP minor version.
420    
421     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
422     frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get     frontend can use the "GET SERVER INFO" (Section 6.6.5) command to get
423     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
424    
425    
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck             Expires October 18, 2007                [Page 7]  Schoenebeck             Expires December 26, 2011               [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007                [Page 8]  Schoenebeck             Expires December 26, 2011               [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007                [Page 9]  Schoenebeck             Expires December 26, 2011              [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 10]  Schoenebeck             Expires December 26, 2011              [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 11]  Schoenebeck             Expires December 26, 2011              [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 12]  Schoenebeck             Expires December 26, 2011              [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 13]  Schoenebeck             Expires December 26, 2011              [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 14]  Schoenebeck             Expires December 26, 2011              [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 15]  Schoenebeck             Expires December 26, 2011              [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 16]  Schoenebeck             Expires December 26, 2011              [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 17]  Schoenebeck             Expires December 26, 2011              [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 18]  Schoenebeck             Expires December 26, 2011              [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
1066    
1067    
1068        MULTIPLICITY -        MULTIPLICITY -
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck             Expires October 18, 2007               [Page 19]  Schoenebeck             Expires December 26, 2011              [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 20]  Schoenebeck             Expires December 26, 2011              [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 21]  Schoenebeck             Expires December 26, 2011              [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 22]  Schoenebeck             Expires December 26, 2011              [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 23]  Schoenebeck             Expires December 26, 2011              [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 24]  Schoenebeck             Expires December 26, 2011              [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 25]  Schoenebeck             Expires December 26, 2011              [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 26]  Schoenebeck             Expires December 26, 2011              [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
1514    
1515    
1516     Examples:     Examples:
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck             Expires October 18, 2007               [Page 27]  Schoenebeck             Expires December 26, 2011              [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 28]  Schoenebeck             Expires December 26, 2011              [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 29]  Schoenebeck             Expires December 26, 2011              [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
1682    
1683    
1684        "OK" -        "OK" -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck             Expires October 18, 2007               [Page 30]  Schoenebeck             Expires December 26, 2011              [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 31]  Schoenebeck             Expires December 26, 2011              [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 32]  Schoenebeck             Expires December 26, 2011              [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 33]  Schoenebeck             Expires December 26, 2011              [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
1906    
1907    
1908        FIX -        FIX -
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck             Expires October 18, 2007               [Page 34]  Schoenebeck             Expires December 26, 2011              [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 35]  Schoenebeck             Expires December 26, 2011              [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 36]  Schoenebeck             Expires December 26, 2011              [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 37]  Schoenebeck             Expires December 26, 2011              [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 38]  Schoenebeck             Expires December 26, 2011              [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 39]  Schoenebeck             Expires December 26, 2011              [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 40]  Schoenebeck             Expires December 26, 2011              [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
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 October 18, 2007               [Page 41]  Schoenebeck             Expires December 26, 2011              [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
2354    
2355    
2356           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2328  Internet-Draft        LinuxSampler Contr Line 2384  Internet-Draft        LinuxSampler Contr
2384     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2385     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2386     MIDI port number, <key> by the name of the parameter to change and     MIDI port number, <key> by the name of the parameter to change and
2387     <value> by the new value for this parameter.     <value> by the new value for this parameter (encapsulated into
2388       apostrophes) or NONE (not encapsulated into apostrophes) for
2389       specifying no value for parameters allowing a list of values.
2390    
2391     Possible Answers:     Possible Answers:
2392    
# Line 2342  Internet-Draft        LinuxSampler Contr Line 2400  Internet-Draft        LinuxSampler Contr
2400           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2401           code and warning message           code and warning message
2402    
       "ERR:<error-code>:<error-message>" -  
   
2403    
2404    
2405    
2406    
2407  Schoenebeck             Expires October 18, 2007               [Page 42]  Schoenebeck             Expires December 26, 2011              [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
2410    
2411    
2412          "ERR:<error-code>:<error-message>" -
2413    
2414           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2415           error message           error message
2416    
2417     Example:     Example:
2418    
2419          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2420    
2421          S: "OK"
2422    
2423          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2424    
2425          S: "OK"
2426    
2427  6.4.  Configuring sampler channels  6.4.  Configuring sampler channels
2428    
# Line 2380  Internet-Draft        LinuxSampler Contr Line 2444  Internet-Draft        LinuxSampler Contr
2444     of the sampler channel the instrument should be assigned to.  Each     of the sampler channel the instrument should be assigned to.  Each
2445     sampler channel can only have one instrument.     sampler channel can only have one instrument.
2446    
2447       Notice: since LSCP 1.2 the <filename> argument supports escape
2448       characters for special characters (see chapter "Character Set and
2449       Escape Sequences (Section 7.1)" for details) and accordingly
2450       backslash characters in the filename MUST now be escaped as well!
2451    
2452     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
2453     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2454     been fully loaded and the channel is ready to be used while NON_MODAL     been fully loaded and the channel is ready to be used while NON_MODAL
# Line 2388  Internet-Draft        LinuxSampler Contr Line 2457  Internet-Draft        LinuxSampler Contr
2457     (Section 6.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2458     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2459     such as making sure that the file could be read and it is of a proper     such as making sure that the file could be read and it is of a proper
2460    
2461    
2462    
2463    Schoenebeck             Expires December 26, 2011              [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol            June 2011
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
2469     process should any errors be detected at that point.     process should any errors be detected at that point.
2470    
# Line 2401  Internet-Draft        LinuxSampler Contr Line 2478  Internet-Draft        LinuxSampler Contr
2478    
2479           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2480           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 43]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2481           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
2482           file), providing an appropriate warning code and warning           file), providing an appropriate warning code and warning
2483           message           message
# Line 2418  Internet-Draft        LinuxSampler Contr Line 2487  Internet-Draft        LinuxSampler Contr
2487           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2488           error message           error message
2489    
2490     Example:     Example (Unix):
2491    
2492          C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
2493    
2494          S: OK
2495    
2496       Example (Windows):
2497    
2498          C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
2499    
2500          S: OK
2501    
2502  6.4.2.  Loading a sampler engine  6.4.2.  Loading a sampler engine
2503    
# Line 2436  Internet-Draft        LinuxSampler Contr Line 2513  Internet-Draft        LinuxSampler Contr
2513     be assigned to.  This command should be issued after adding a new     be assigned to.  This command should be issued after adding a new
2514     sampler channel and before any other control commands on the new     sampler channel and before any other control commands on the new
2515     sampler channel.  It can also be used to change the engine type of a     sampler channel.  It can also be used to change the engine type of a
2516    
2517    
2518    
2519    Schoenebeck             Expires December 26, 2011              [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol            June 2011
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
2525     force if a new engine instance should be created and assigned to the     force if a new engine instance should be created and assigned to the
2526     given sampler channel or if an already existing instance of that     given sampler channel or if an already existing instance of that
# Line 2458  Internet-Draft        LinuxSampler Contr Line 2543  Internet-Draft        LinuxSampler Contr
2543           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2544           error message           error message
2545    
   
   
 Schoenebeck             Expires October 18, 2007               [Page 44]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2546     Example:     Example:
2547    
2548    
# Line 2488  Internet-Draft        LinuxSampler Contr Line 2566  Internet-Draft        LinuxSampler Contr
2566    
2567        S: "12"        S: "12"
2568    
2569    
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck             Expires December 26, 2011              [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol            June 2011
2578    
2579    
2580  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2581    
2582     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
# Line 2512  Internet-Draft        LinuxSampler Contr Line 2601  Internet-Draft        LinuxSampler Contr
2601     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2602     list by sending the following command:     list by sending the following command:
2603    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2604        ADD CHANNEL        ADD CHANNEL
2605    
2606     This will increment the sampler channel count by one and the new     This will increment the sampler channel count by one and the new
# Line 2544  Internet-Draft        LinuxSampler Contr Line 2624  Internet-Draft        LinuxSampler Contr
2624    
2625        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck             Expires December 26, 2011              [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol            June 2011
2634    
2635    
2636           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2637           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2638           code and warning message           code and warning message
# Line 2570  Internet-Draft        LinuxSampler Contr Line 2659  Internet-Draft        LinuxSampler Contr
2659    
2660     Possible Answers:     Possible Answers:
2661    
   
   
 Schoenebeck             Expires October 18, 2007               [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2662        "OK" -        "OK" -
2663    
2664           in case the given sampler channel could be removed           in case the given sampler channel could be removed
# Line 2596  Internet-Draft        LinuxSampler Contr Line 2678  Internet-Draft        LinuxSampler Contr
2678    
2679    
2680    
2681    
2682    
2683    
2684    
2685    
2686    
2687    Schoenebeck             Expires December 26, 2011              [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol            June 2011
2690    
2691    
2692  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
2693    
2694     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
# Line 2623  Internet-Draft        LinuxSampler Contr Line 2716  Internet-Draft        LinuxSampler Contr
2716    
2717     Possible Answers:     Possible Answers:
2718    
   
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2719        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
2720        engines' names encapsulated into apostrophes (').  Engine names        engines' names encapsulated into apostrophes (').  Engine names
2721        can consist of lower and upper cases, digits and underlines ("_"        can consist of lower and upper cases, digits and underlines ("_"
# Line 2654  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
2737     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2738     AVAILABLE_ENGINES" (Section 6.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2739    
2740    
2741    
2742    
2743    Schoenebeck             Expires December 26, 2011              [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol            June 2011
2746    
2747    
2748     Possible Answers:     Possible Answers:
2749    
2750        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 2666  Internet-Draft        LinuxSampler Contr Line 2757  Internet-Draft        LinuxSampler Contr
2757    
2758           DESCRIPTION -           DESCRIPTION -
2759    
2760              arbitrary description text about the engine              arbitrary description text about the engine (note that the
2761                character string may contain escape sequences (Section 7.1))
2762    
2763           VERSION -           VERSION -
2764    
# Line 2680  Internet-Draft        LinuxSampler Contr Line 2772  Internet-Draft        LinuxSampler Contr
2772    
2773        S: "DESCRIPTION: this is Joe's custom sampler engine"        S: "DESCRIPTION: this is Joe's custom sampler engine"
2774    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2775           "VERSION: testing-1.0"           "VERSION: testing-1.0"
2776    
2777           "."           "."
# Line 2710  Internet-Draft        LinuxSampler Contr Line 2793  Internet-Draft        LinuxSampler Contr
2793        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
2794        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
2795        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2796    
2797    
2798    
2799    Schoenebeck             Expires December 26, 2011              [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol            June 2011
2802    
2803    
2804        following categories are defined:        following categories are defined:
2805    
2806    
# Line 2724  Internet-Draft        LinuxSampler Contr Line 2815  Internet-Draft        LinuxSampler Contr
2815    
2816              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2817              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2818              signal, "NONE" if there's no device connected to this              signal, "-1" if there's no device connected to this sampler
2819              sampler channel              channel
2820    
2821           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2822    
# Line 2737  Internet-Draft        LinuxSampler Contr Line 2828  Internet-Draft        LinuxSampler Contr
2828              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
2829              of the selected audio output device each sampler output              of the selected audio output device each sampler output
2830              channel is routed to, e.g. "0,3" would mean the engine's              channel is routed to, e.g. "0,3" would mean the engine's
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 49]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2831              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
2832              device and the engine's output channel 1 is routed to the              device and the engine's output channel 1 is routed to the
2833              channel 3 of the audio output device              channel 3 of the audio output device
# Line 2752  Internet-Draft        LinuxSampler Contr Line 2835  Internet-Draft        LinuxSampler Contr
2835           INSTRUMENT_FILE -           INSTRUMENT_FILE -
2836    
2837              the file name of the loaded instrument, "NONE" if there's no              the file name of the loaded instrument, "NONE" if there's no
2838              instrument yet loaded for this sampler channel              instrument yet loaded for this sampler channel (note: since
2839                LSCP 1.2 this path may contain escape sequences
2840                (Section 7.1))
2841    
2842           INSTRUMENT_NR -           INSTRUMENT_NR -
2843    
2844              the instrument index number of the loaded instrument              the instrument index number of the loaded instrument, "-1"
2845                if there's no instrument loaded for this sampler channel
2846    
2847           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2848    
2849              the instrument name of the loaded instrument              the instrument name of the loaded instrument (note: since
2850                LSCP 1.2 this character string may contain escape sequences
2851                (Section 7.1))
2852    
2853    
2854    
2855    Schoenebeck             Expires December 26, 2011              [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol            June 2011
2858    
2859    
2860           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2861    
2862              integer values 0 to 100 indicating loading progress              Integer values 0 to 100 indicating loading progress
2863              percentage for the instrument.  Negative value indicates a              percentage for the instrument.  Negative value indicates a
2864              loading exception.  Value of 100 indicates that the              loading exception (also returns "-1" in case no instrument
2865              instrument is fully loaded.              was yet to be loaded on the sampler channel).  Value of 100
2866                indicates that the instrument is fully loaded.
2867    
2868           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2869    
2870              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
2871              connected to this sampler channel to deliver MIDI input              connected to this sampler channel to deliver MIDI input
2872              commands, "NONE" if there's no device connected to this              commands, "-1" if there's no device connected to this
2873              sampler channel              sampler channel
2874    
2875           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2876    
2877              port number of the MIDI input device              port number of the MIDI input device (in case a MIDI device
2878                was already assigned to the sampler channel)
2879    
2880           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2881    
# Line 2791  Internet-Draft        LinuxSampler Contr Line 2888  Internet-Draft        LinuxSampler Contr
2888              (where a value < 1.0 means attenuation and a value > 1.0              (where a value < 1.0 means attenuation and a value > 1.0
2889              means amplification)              means amplification)
2890    
   
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2891           MUTE -           MUTE -
2892    
2893              Determines whether the channel is muted, "true" if the              Determines whether the channel is muted, "true" if the
# Line 2818  Internet-Draft        LinuxSampler Contr Line 2905  Internet-Draft        LinuxSampler Contr
2905    
2906              Determines to which MIDI instrument map this sampler channel              Determines to which MIDI instrument map this sampler channel
2907              is assigned to.  Read chapter "SET CHANNEL              is assigned to.  Read chapter "SET CHANNEL
2908    
2909    
2910    
2911    Schoenebeck             Expires December 26, 2011              [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol            June 2011
2914    
2915    
2916              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible              MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2917              values.              values.
2918    
# Line 2849  Internet-Draft        LinuxSampler Contr Line 2944  Internet-Draft        LinuxSampler Contr
2944    
2945           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2946    
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
2947           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2948    
2949           "VOLUME: 1.0"           "VOLUME: 1.0"
# Line 2874  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961     The front-end can ask for the current number of active voices on a     The front-end can ask for the current number of active voices on a
2962     sampler channel by sending the following command:     sampler channel by sending the following command:
2963    
2964    
2965    
2966    
2967    Schoenebeck             Expires December 26, 2011              [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol            June 2011
2970    
2971    
2972        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2973    
2974     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
# Line 2905  Internet-Draft        LinuxSampler Contr Line 3000  Internet-Draft        LinuxSampler Contr
3000        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
3001        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
3002        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3003        return "NA" for not available.        return "NA" for not available.
3004    
3005     Example:     Example:
# Line 2928  Internet-Draft        LinuxSampler Contr Line 3015  Internet-Draft        LinuxSampler Contr
3015    
3016     to get the fill state in bytes or     to get the fill state in bytes or
3017    
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck             Expires December 26, 2011              [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol            June 2011
3026    
3027    
3028        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
3029    
3030     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
# Line 2960  Internet-Draft        LinuxSampler Contr Line 3057  Internet-Draft        LinuxSampler Contr
3057    
3058        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
3059    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3060        S: ""        S: ""
3061    
3062  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 2986  Internet-Draft        LinuxSampler Contr Line 3074  Internet-Draft        LinuxSampler Contr
3074     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
3075     command.     command.
3076    
3077    
3078    
3079    Schoenebeck             Expires December 26, 2011              [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol            June 2011
3082    
3083    
3084     Possible Answers:     Possible Answers:
3085    
3086        "OK" -        "OK" -
# Line 3017  Internet-Draft        LinuxSampler Contr Line 3112  Internet-Draft        LinuxSampler Contr
3112        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3113        type>        type>
3114    
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3115     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3116     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
3117    
# Line 3040  Internet-Draft        LinuxSampler Contr Line 3127  Internet-Draft        LinuxSampler Contr
3127           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3128           message           message
3129    
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck             Expires December 26, 2011              [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol            June 2011
3138    
3139    
3140        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3141    
3142           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3072  Internet-Draft        LinuxSampler Contr Line 3169  Internet-Draft        LinuxSampler Contr
3169    
3170        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3171    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3172           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3173           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3174           warning message           warning message
# Line 3094  Internet-Draft        LinuxSampler Contr Line 3182  Internet-Draft        LinuxSampler Contr
3182    
3183    
3184    
3185    
3186    
3187    
3188    
3189    
3190    
3191    Schoenebeck             Expires December 26, 2011              [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol            June 2011
3194    
3195    
3196  6.4.17.  Setting MIDI input device  6.4.17.  Setting MIDI input device
3197    
3198     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
# Line 3128  Internet-Draft        LinuxSampler Contr Line 3227  Internet-Draft        LinuxSampler Contr
3227    
3228    
3229    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3230  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
3231    
3232     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 3151  Internet-Draft        LinuxSampler Contr Line 3241  Internet-Draft        LinuxSampler Contr
3241    
3242     Possible Answers:     Possible Answers:
3243    
3244    
3245    
3246    
3247    Schoenebeck             Expires December 26, 2011              [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol            June 2011
3250    
3251    
3252        "OK" -        "OK" -
3253    
3254           on success           on success
# Line 3184  Internet-Draft        LinuxSampler Contr Line 3282  Internet-Draft        LinuxSampler Contr
3282    
3283        "OK" -        "OK" -
3284    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3285           on success           on success
3286    
3287        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3210  Internet-Draft        LinuxSampler Contr Line 3299  Internet-Draft        LinuxSampler Contr
3299    
3300    
3301    
3302    
3303    Schoenebeck             Expires December 26, 2011              [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol            June 2011
3306    
3307    
3308    
3309    
3310  6.4.20.  Setting MIDI input channel  6.4.20.  Setting MIDI input channel
3311    
3312     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
# Line 3242  Internet-Draft        LinuxSampler Contr Line 3339  Internet-Draft        LinuxSampler Contr
3339    
3340    
3341    
   
   
 Schoenebeck             Expires October 18, 2007               [Page 58]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
   
   
3342  6.4.21.  Setting channel volume  6.4.21.  Setting channel volume
3343    
3344     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
# Line 3265  Internet-Draft        LinuxSampler Contr Line 3353  Internet-Draft        LinuxSampler Contr
3353    
3354     Possible Answers:     Possible Answers:
3355    
3356    
3357    
3358    
3359    Schoenebeck             Expires December 26, 2011              [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol            June 2011
3362    
3363    
3364        "OK" -        "OK" -
3365    
3366           on success           on success
# Line 3298  Internet-Draft        LinuxSampler Contr Line 3394  Internet-Draft        LinuxSampler Contr
3394    
3395     Possible Answers:     Possible Answers:
3396    
   
   
 Schoenebeck             Expires October 18, 2007               [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3397        "OK" -        "OK" -
3398    
3399           on success           on success
# Line 3320  Internet-Draft        LinuxSampler Contr Line 3409  Internet-Draft        LinuxSampler Contr
3409           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3410           error message           error message
3411    
3412    
3413    
3414    
3415    Schoenebeck             Expires December 26, 2011              [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol            June 2011
3418    
3419    
3420     Examples:     Examples:
3421    
3422    
# Line 3353  Internet-Draft        LinuxSampler Contr Line 3450  Internet-Draft        LinuxSampler Contr
3450           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3451           error message           error message
3452    
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3453     Examples:     Examples:
3454    
3455    
# Line 3377  Internet-Draft        LinuxSampler Contr Line 3466  Internet-Draft        LinuxSampler Contr
3466     (Section 6.4.4) command and <map> can have the following     (Section 6.4.4) command and <map> can have the following
3467     possibilites:     possibilites:
3468    
3469    
3470    
3471    Schoenebeck             Expires December 26, 2011              [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol            June 2011
3474    
3475    
3476        "NONE" -        "NONE" -
3477    
3478           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
# Line 3410  Internet-Draft        LinuxSampler Contr Line 3506  Internet-Draft        LinuxSampler Contr
3506           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3507           error message           error message
3508    
   
   
 Schoenebeck             Expires October 18, 2007               [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3509     Examples:     Examples:
3510    
3511    
# Line 3432  Internet-Draft        LinuxSampler Contr Line 3521  Internet-Draft        LinuxSampler Contr
3521     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3522     (Section 6.4.4) command, that is the sampler channel on which the     (Section 6.4.4) command, that is the sampler channel on which the
3523     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
3524    
3525    
3526    
3527    Schoenebeck             Expires December 26, 2011              [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol            June 2011
3530    
3531    
3532     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3533     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3534     effect send entity.  The name does not have to be unique.     effect send entity.  The name does not have to be unique, but MUST be
3535       encapsulated into apostrophes and supports escape sequences as
3536       described in chapter "Character Set and Escape Sequences
3537       (Section 7.1)".
3538    
3539     By default, that is as initial routing, the effect send's audio     By default, that is as initial routing, the effect send's audio
3540     channels are automatically routed to the last audio channels of the     channels are automatically routed to the last audio channels of the
# Line 3463  Internet-Draft        LinuxSampler Contr Line 3563  Internet-Draft        LinuxSampler Contr
3563           channel, where <fx-send-id> reflects the unique ID of the newly           channel, where <fx-send-id> reflects the unique ID of the newly
3564           created effect send entity           created effect send entity
3565    
   
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3566        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3567    
3568           when a new effect send could not be added, i.e. due to invalid           when a new effect send could not be added, i.e. due to invalid
# Line 3486  Internet-Draft        LinuxSampler Contr Line 3576  Internet-Draft        LinuxSampler Contr
3576    
3577        C: "CREATE FX_SEND 0 93"        C: "CREATE FX_SEND 0 93"
3578    
3579    
3580    
3581    
3582    
3583    Schoenebeck             Expires December 26, 2011              [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol            June 2011
3586    
3587    
3588        S: "OK[1]"        S: "OK[1]"
3589    
3590  6.4.26.  Removing an effect send from a sampler channel  6.4.26.  Removing an effect send from a sampler channel
# Line 3519  Internet-Draft        LinuxSampler Contr Line 3618  Internet-Draft        LinuxSampler Contr
3618    
3619        S: "OK"        S: "OK"
3620    
   
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3621  6.4.27.  Getting amount of effect sends on a sampler channel  6.4.27.  Getting amount of effect sends on a sampler channel
3622    
3623     The front-end can ask for the amount of effect sends on a specific     The front-end can ask for the amount of effect sends on a specific
# Line 3542  Internet-Draft        LinuxSampler Contr Line 3631  Internet-Draft        LinuxSampler Contr
3631    
3632     Possible Answers:     Possible Answers:
3633    
3634    
3635    
3636    
3637    
3638    
3639    Schoenebeck             Expires December 26, 2011              [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol            June 2011
3642    
3643    
3644        The sampler will answer by returning the number of effect sends on        The sampler will answer by returning the number of effect sends on
3645        the given sampler channel.        the given sampler channel.
3646    
# Line 3577  Internet-Draft        LinuxSampler Contr Line 3676  Internet-Draft        LinuxSampler Contr
3676    
3677        S: ""        S: ""
3678    
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 64]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3679  6.4.29.  Getting effect send information  6.4.29.  Getting effect send information
3680    
3681     The front-end can ask for the current settings of an effect send     The front-end can ask for the current settings of an effect send
# Line 3598  Internet-Draft        LinuxSampler Contr Line 3689  Internet-Draft        LinuxSampler Contr
3689     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3690     FX_SENDS" (Section 6.4.28) command.     FX_SENDS" (Section 6.4.28) command.
3691    
3692    
3693    
3694    
3695    Schoenebeck             Expires December 26, 2011              [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol            June 2011
3698    
3699    
3700     Possible Answers:     Possible Answers:
3701    
3702        The sampler will answer by sending a <CRLF> separated list.  Each        The sampler will answer by sending a <CRLF> separated list.  Each
# Line 3610  Internet-Draft        LinuxSampler Contr Line 3709  Internet-Draft        LinuxSampler Contr
3709    
3710           NAME -           NAME -
3711    
3712              name of the effect send entity              name of the effect send entity (note that this character
3713                string may contain escape sequences (Section 7.1))
3714    
3715           MIDI_CONTROLLER -           MIDI_CONTROLLER -
3716    
# Line 3631  Internet-Draft        LinuxSampler Contr Line 3731  Internet-Draft        LinuxSampler Contr
3731              send's output channel 0 is routed to channel 0 of the audio              send's output channel 0 is routed to channel 0 of the audio
3732              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
3733              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
3734              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details),
3735                if an internal send effect is assigned to the effect send,
3736                then this setting defines the audio channel routing to that
3737                effect instance respectively
3738    
3739             EFFECT -
3740    
3741                destination send effect chain ID and destination effect
3742                chain position, separated by comma in the form "<effect-
3743                chain>,<chain-pos>" or "NONE" if there is no send effect
3744                assigned to the effect send
3745    
3746       The mentioned fields above don't have to be in particular order.
3747    
3748    
3749    
 Schoenebeck             Expires October 18, 2007               [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
3750    
3751    Schoenebeck             Expires December 26, 2011              [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol            June 2011
3754    
    The mentioned fields above don't have to be in particular order.  
3755    
3756     Example:     Example:
3757    
# Line 3655  Internet-Draft        LinuxSampler Contr Line 3765  Internet-Draft        LinuxSampler Contr
3765    
3766           "AUDIO_OUTPUT_ROUTING: 2,3"           "AUDIO_OUTPUT_ROUTING: 2,3"
3767    
3768             "EFFECT: NONE"
3769    
3770             "."
3771    
3772          C: "GET FX_SEND INFO 0 1"
3773    
3774          S: "NAME: Delay Send (Internal)"
3775    
3776             "MIDI_CONTROLLER: 93"
3777    
3778             "LEVEL: 0.51"
3779    
3780             "AUDIO_OUTPUT_ROUTING: 1,2"
3781    
3782             "EFFECT: 2,0"
3783    
3784           "."           "."
3785    
3786  6.4.30.  Changing effect send's name  6.4.30.  Changing effect send's name
# Line 3669  Internet-Draft        LinuxSampler Contr Line 3795  Internet-Draft        LinuxSampler Contr
3795     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3796     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
3797     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3798     effect send entity, which does not have to be unique.     effect send entity, which does not have to be unique (name MUST be
3799       encapsulated into apostrophes and supports escape sequences as
3800       described in chapter "Character Set and Escape Sequences
3801       (Section 7.1)").
3802    
3803     Possible Answers:     Possible Answers:
3804    
3805    
3806    
3807    Schoenebeck             Expires December 26, 2011              [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol            June 2011
3810    
3811    
3812        "OK" -        "OK" -
3813    
3814           on success           on success
# Line 3688  Internet-Draft        LinuxSampler Contr Line 3824  Internet-Draft        LinuxSampler Contr
3824    
3825        S: "OK"        S: "OK"
3826    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
3827  6.4.31.  Altering effect send's audio routing  6.4.31.  Altering effect send's audio routing
3828    
3829     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 3713  Internet-Draft        LinuxSampler Contr Line 3840  Internet-Draft        LinuxSampler Contr
3840     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3841     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
3842     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
3843     audio output device where <audio-src> should be routed to.     audio output device where <audio-src> should be routed to.  If an
3844       internal send effect is assigned to the effect send, then this
3845       setting defines the audio channel routing to that effect instance
3846       respectively.
3847    
3848     Note that effect sends can only route audio to the same audio output     Note that effect sends can only route audio to the same audio output
3849     device as assigned to the effect send's sampler channel.  Also note     device as assigned to the effect send's sampler channel.  Also note
# Line 3727  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857     send into a mono one by simply altering its audio routing     send into a mono one by simply altering its audio routing
3858     appropriately.     appropriately.
3859    
3860    
3861    
3862    
3863    Schoenebeck             Expires December 26, 2011              [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol            June 2011
3866    
3867    
3868     Possible Answers:     Possible Answers:
3869    
3870        "OK" -        "OK" -
# Line 3746  Internet-Draft        LinuxSampler Contr Line 3884  Internet-Draft        LinuxSampler Contr
3884    
3885     Example:     Example:
3886    
3887          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3888    
3889          S: "OK"
3890    
3891    6.4.32.  Assigning destination effect to an effect send
3892    
3893       The front-end can (re-)assign a destination effect to an effect send
3894       by sending the following command:
3895    
3896          SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain>
3897          <chain-pos>
3898    
3899       Where <sampler-chan> is the sampler channel number as returned by the
3900       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3901       command, <fx-send-id> reflects the numerical ID of the effect send
3902       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3903       FX_SENDS" (Section 6.4.28) command, <effect-chain> by the numerical
3904       ID of the destination effect chain as returned by the "ADD
3905       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
3906       (Section 6.11.13) command and <chain-pos> reflects the exact effect
3907       chain position in the effect chain which hosts the actual destination
3908       effect.
3909    
3910       Possible Answers:
3911    
3912          "OK" -
3913    
3914             on success
3915    
3916    
3917    
3918  Schoenebeck             Expires October 18, 2007               [Page 67]  
3919    Schoenebeck             Expires December 26, 2011              [Page 70]
3920    
3921  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
3922    
3923    
3924        C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"        "ERR:<error-code>:<error-message>" -
3925    
3926             in case it failed, providing an appropriate error code and
3927             error message
3928    
3929       Example:
3930    
3931          C: "SET FX_SEND EFFECT 0 0 2 5"
3932    
3933        S: "OK"        S: "OK"
3934    
3935  6.4.32.  Altering effect send's MIDI controller  6.4.33.  Removing destination effect from an effect send
3936    
3937       The front-end can (re-)assign a destination effect to an effect send
3938       by sending the following command:
3939    
3940          REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id>
3941    
3942       Where <sampler-chan> is the sampler channel number as returned by the
3943       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3944       command, <fx-send-id> reflects the numerical ID of the effect send
3945       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3946       FX_SENDS" (Section 6.4.28) command.
3947    
3948       After the destination effect has been removed from the effect send,
3949       the audio signal of the effect send will be routed directly to the
3950       audio output device, according to the audio channel routing setting
3951       of the effect send.
3952    
3953       Possible Answers:
3954    
3955          "OK" -
3956    
3957             on success
3958    
3959          "ERR:<error-code>:<error-message>" -
3960    
3961             in case it failed, providing an appropriate error code and
3962             error message
3963    
3964       Example:
3965    
3966          C: "REMOVE FX_SEND EFFECT 0 0"
3967    
3968          S: "OK"
3969    
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck             Expires December 26, 2011              [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol            June 2011
3978    
3979    
3980    6.4.34.  Altering effect send's MIDI controller
3981    
3982     The front-end can alter the MIDI controller of an effect send entity     The front-end can alter the MIDI controller of an effect send entity
3983     by sending the following command:     by sending the following command:
# Line 3796  Internet-Draft        LinuxSampler Contr Line 4016  Internet-Draft        LinuxSampler Contr
4016    
4017        S: "OK"        S: "OK"
4018    
4019  6.4.33.  Altering effect send's send level  6.4.35.  Altering effect send's send level
4020    
4021     The front-end can alter the current send level of an effect send     The front-end can alter the current send level of an effect send
4022     entity by sending the following command:     entity by sending the following command:
4023    
4024          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
4025    
4026       Where <sampler-chan> is the sampler channel number as returned by the
4027       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4028    
4029    
4030    
4031  Schoenebeck             Expires October 18, 2007               [Page 68]  Schoenebeck             Expires December 26, 2011              [Page 72]
4032    
4033  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
   
4034    
       SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>  
4035    
    Where <sampler-chan> is the sampler channel number as returned by the  
    "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)  
4036     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4037     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
4038     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
# Line 3843  Internet-Draft        LinuxSampler Contr Line 4063  Internet-Draft        LinuxSampler Contr
4063    
4064        S: "OK"        S: "OK"
4065    
4066  6.4.34.  Resetting a sampler channel  6.4.36.  Sending MIDI messages to sampler channel
4067    
4068       The front-end can send MIDI events to a specific sampler channel by
4069       sending the following command:
4070    
4071          SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2>
4072    
4073       Where <sampler-chan> is the sampler channel number as returned by the
4074       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4075       command, <arg1> and <arg2> arguments depend on the <midi-msg>
4076       argument, which specifies the MIDI message type.  Currently, the
4077       following MIDI messages are supported:
4078    
4079          "NOTE_ON" -
4080    
4081             For turning on MIDI notes, where <arg1> specifies the key
4082             number and <arg2> the velocity as described in the MIDI
4083             specification.
4084    
4085    
4086    
4087    Schoenebeck             Expires December 26, 2011              [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol            June 2011
4090    
4091    
4092          "NOTE_OFF" -
4093    
4094             For turning a currently playing MIDI note off, where <arg1>
4095             specifies the key number and <arg2> the velocity as described
4096             in the MIDI specification.
4097    
4098          "CC" -
4099    
4100             For changing a MIDI controller, where <arg1> specifies the
4101             controller number and <arg2> the new value of the controller as
4102             described in the Control Change section of the MIDI
4103             specification.
4104    
4105       CAUTION: This command is provided for implementations of virtual MIDI
4106       keyboards and no realtime guarantee whatsoever will be made!
4107    
4108       Possible Answers:
4109    
4110          "OK" -
4111    
4112             on success
4113    
4114          "ERR:<error-code>:<error-message>" -
4115    
4116             in case it failed, providing an appropriate error code and
4117             error message
4118    
4119       Example:
4120    
4121          C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
4122    
4123          S: "OK"
4124    
4125    6.4.37.  Resetting a sampler channel
4126    
4127     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
4128     following command:     following command:
# Line 3860  Internet-Draft        LinuxSampler Contr Line 4139  Internet-Draft        LinuxSampler Contr
4139    
4140    
4141    
4142  Schoenebeck             Expires October 18, 2007               [Page 69]  
4143    Schoenebeck             Expires December 26, 2011              [Page 74]
4144    
4145  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
4146    
4147    
4148        "OK" -        "OK" -
# Line 3916  Internet-Draft        LinuxSampler Contr Line 4196  Internet-Draft        LinuxSampler Contr
4196    
4197    
4198    
4199  Schoenebeck             Expires October 18, 2007               [Page 70]  Schoenebeck             Expires December 26, 2011              [Page 75]
4200    
4201  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
4202    
4203    
4204        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 3972  Internet-Draft        LinuxSampler Contr Line 4252  Internet-Draft        LinuxSampler Contr
4252    
4253    
4254    
4255  Schoenebeck             Expires October 18, 2007               [Page 71]  Schoenebeck             Expires December 26, 2011              [Page 76]
4256    
4257  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
4258    
4259    
4260     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
# Line 4028  Internet-Draft        LinuxSampler Contr Line 4308  Internet-Draft        LinuxSampler Contr
4308    
4309    
4310    
4311  Schoenebeck             Expires October 18, 2007               [Page 72]  Schoenebeck             Expires December 26, 2011              [Page 77]
4312    
4313  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
4314    
4315    
4316  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
# Line 4045  Internet-Draft        LinuxSampler Contr Line 4325  Internet-Draft        LinuxSampler Contr
4325        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4326        voices.        voices.
4327    
4328  6.6.3.  Reset sampler  6.6.3.  Current number of active disk streams
4329    
4330       The front-end can ask for the current number of active disk streams
4331       on the sampler by sending the following command:
4332    
4333          GET TOTAL_STREAM_COUNT
4334    
4335       Possible Answers:
4336    
4337          LinuxSampler will answer by returning the number of all active
4338          disk streams on the sampler.
4339    
4340    6.6.4.  Reset sampler
4341    
4342     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
4343     command:     command:
# Line 4062  Internet-Draft        LinuxSampler Contr Line 4354  Internet-Draft        LinuxSampler Contr
4354    
4355    
4356    
4357  6.6.4.  General sampler informations  6.6.5.  General sampler informations
4358    
4359     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
4360     instance by sending the following command:     instance by sending the following command:
4361    
4362    
4363    
4364    
4365    
4366    
4367    Schoenebeck             Expires December 26, 2011              [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol            June 2011
4370    
4371    
4372        GET SERVER INFO        GET SERVER INFO
4373    
4374     Possible Answers:     Possible Answers:
# Line 4081  Internet-Draft        LinuxSampler Contr Line 4383  Internet-Draft        LinuxSampler Contr
4383    
4384           DESCRIPTION -           DESCRIPTION -
4385    
4386                arbitrary textual description about the sampler (note that
4387                the character string may contain escape sequences
4388                (Section 7.1))
 Schoenebeck             Expires October 18, 2007               [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
             arbitrary textual description about the sampler  
4389    
4390           VERSION -           VERSION -
4391    
# Line 4108  Internet-Draft        LinuxSampler Contr Line 4404  Internet-Draft        LinuxSampler Contr
4404     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4405     Other fields might be added in future.     Other fields might be added in future.
4406    
4407  6.6.5.  Getting global volume attenuation  6.6.6.  Getting global volume attenuation
4408    
4409     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
4410     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4121  Internet-Draft        LinuxSampler Contr Line 4417  Internet-Draft        LinuxSampler Contr
4417        floating point coefficient, reflecting the current global volume        floating point coefficient, reflecting the current global volume
4418        attenuation.        attenuation.
4419    
4420    
4421    
4422    
4423    Schoenebeck             Expires December 26, 2011              [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol            June 2011
4426    
4427    
4428     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4429     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
4430     this parameter.     this parameter.
4431    
4432  6.6.6.  Setting global volume attenuation  6.6.7.  Setting global volume attenuation
4433    
4434     The client can alter the current global sampler-wide volume     The client can alter the current global sampler-wide volume
4435     attenuation by sending the following command:     attenuation by sending the following command:
# Line 4137  Internet-Draft        LinuxSampler Contr Line 4441  Internet-Draft        LinuxSampler Contr
4441     might usually be in the range between 0.0 and 1.0, that is for     might usually be in the range between 0.0 and 1.0, that is for
4442     attenuating the overall volume.     attenuating the overall volume.
4443    
4444       Possible Answers:
4445    
4446          "OK" -
4447    
4448             on success
4449    
4450          "WRN:<warning-code>:<warning-message>" -
4451    
4452             if the global volume was set, but there are noteworthy issue(s)
4453             related, providing an appropriate warning code and warning
4454             message
4455    
4456          "ERR:<error-code>:<error-message>" -
4457    
4458             in case it failed, providing an appropriate error code and
4459             error message
4460    
4461    6.6.8.  Getting global voice limit
4462    
4463       The client can ask for the current global sampler-wide limit for
4464       maximum voices by sending the following command:
4465    
4466          GET VOICES
4467    
4468       Possible Answers:
4469    
4470          LinuxSampler will answer by returning the number for the current
4471          limit of maximum voices.
4472    
4473       The voice limit setting defines how many voices should maximum be
4474       processed by the sampler at the same time.  If the user triggers new
4475       notes which would exceed that voice limit, the sampler engine will
4476    
4477    
4478  Schoenebeck             Expires October 18, 2007               [Page 74]  
4479    Schoenebeck             Expires December 26, 2011              [Page 80]
4480    
4481  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
4482    
4483    
4484       react by stealing old voices for those newly triggered notes.  Note
4485       that the amount of voices triggered by a new note can be larger than
4486       one and is dependent to the respective instrument and probably
4487       further criterias.
4488    
4489    6.6.9.  Setting global voice limit
4490    
4491       The client can alter the current global sampler-wide limit for
4492       maximum voices by sending the following command:
4493    
4494          SET VOICES <max-voices>
4495    
4496       Where <max-voices> should be replaced by the integer value,
4497       reflecting the new global amount limit of maximum voices.  This value
4498       has to be larger than 0.
4499    
4500     Possible Answers:     Possible Answers:
4501    
# Line 4153  Internet-Draft        LinuxSampler Contr Line 4505  Internet-Draft        LinuxSampler Contr
4505    
4506        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4507    
4508           if the global volume was set, but there are noteworthy issue(s)           if the voice limit was set, but there are noteworthy issue(s)
4509           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4510           message           message
4511    
# Line 4162  Internet-Draft        LinuxSampler Contr Line 4514  Internet-Draft        LinuxSampler Contr
4514           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4515           error message           error message
4516    
4517       Note: the given value will be passed to all sampler engine instances.
4518       The total amount of maximum voices on the running system might thus
4519       be as big as the given value multiplied by the current amount of
4520       engine instances.
4521    
4522       Caution: when adjusting the voice limit, you SHOULD also adjust the
4523       disk stream limit respectively and vice versa.
4524    
4525    6.6.10.  Getting global disk stream limit
4526    
4527       The client can ask for the current global sampler-wide limit for
4528       maximum disk streams by sending the following command:
4529    
4530    
4531    
4532    
4533    
4534    
4535    Schoenebeck             Expires December 26, 2011              [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol            June 2011
4538    
4539    
4540          GET STREAMS
4541    
4542       Possible Answers:
4543    
4544          LinuxSampler will answer by returning the number for the current
4545          limit of maximum disk streams.
4546    
4547       The disk stream limit setting defines how many disk streams should
4548       maximum be processed by a sampler engine at the same time.  The
4549       higher this value, the more memory (RAM) will be occupied, since
4550       every disk streams allocates a certain buffer size for being able to
4551       perform its streaming operations.
4552    
4553    6.6.11.  Setting global disk stream limit
4554    
4555       The client can alter the current global sampler-wide limit for
4556       maximum disk streams by sending the following command:
4557    
4558          SET STREAMS <max-streams>
4559    
4560       Where <max-streams> should be replaced by the integer value,
4561       reflecting the new global amount limit of maximum disk streams.  This
4562       value has to be positive.
4563    
4564       Possible Answers:
4565    
4566          "OK" -
4567    
4568             on success
4569    
4570          "WRN:<warning-code>:<warning-message>" -
4571    
4572             if the disk stream limit was set, but there are noteworthy
4573             issue(s) related, providing an appropriate warning code and
4574             warning message
4575    
4576          "ERR:<error-code>:<error-message>" -
4577    
4578             in case it failed, providing an appropriate error code and
4579             error message
4580    
4581       Note: the given value will be passed to all sampler engine instances.
4582       The total amount of maximum disk streams on the running system might
4583       thus be as big as the given value multiplied by the current amount of
4584       engine instances.
4585    
4586       Caution: when adjusting the disk stream limit, you SHOULD also adjust
4587       the voice limit respectively and vice versa.
4588    
4589    
4590    
4591    Schoenebeck             Expires December 26, 2011              [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol            June 2011
4594    
4595    
4596  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4597    
4598     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 4192  Internet-Draft        LinuxSampler Contr Line 4623  Internet-Draft        LinuxSampler Contr
4623     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4624     current MIDI instrument map.     current MIDI instrument map.
4625    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
4626  6.7.1.  Create a new MIDI instrument map  6.7.1.  Create a new MIDI instrument map
4627    
4628     The front-end can add a new MIDI instrument map by sending the     The front-end can add a new MIDI instrument map by sending the
# Line 4209  Internet-Draft        LinuxSampler Contr Line 4631  Internet-Draft        LinuxSampler Contr
4631        ADD MIDI_INSTRUMENT_MAP [<name>]        ADD MIDI_INSTRUMENT_MAP [<name>]
4632    
4633     Where <name> is an optional argument allowing to assign a custom name     Where <name> is an optional argument allowing to assign a custom name
4634     to the new map.  MIDI instrument Map names do not have to be unique.     to the new map.  MIDI instrument Map names do not have to be unique,
4635       but MUST be encapsulated into apostrophes and support escape
4636       sequences as described in chapter "Character Set and Escape Sequences
4637       (Section 7.1)".
4638    
4639     Possible Answers:     Possible Answers:
4640    
4641        "OK[<map>]" -        "OK[<map>]" -
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck             Expires December 26, 2011              [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol            June 2011
4650    
4651    
4652           in case a new MIDI instrument map could be added, where <map>           in case a new MIDI instrument map could be added, where <map>
4653           reflects the unique ID of the newly created MIDI instrument map           reflects the unique ID of the newly created MIDI instrument map
4654    
# Line 4250  Internet-Draft        LinuxSampler Contr Line 4684  Internet-Draft        LinuxSampler Contr
4684     The front-end can delete all MIDI instrument maps by sending the     The front-end can delete all MIDI instrument maps by sending the
4685     following command:     following command:
4686    
   
   
 Schoenebeck             Expires October 18, 2007               [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
4687        REMOVE MIDI_INSTRUMENT_MAP ALL        REMOVE MIDI_INSTRUMENT_MAP ALL
4688    
4689     Possible Answers:     Possible Answers:
# Line 4271  Internet-Draft        LinuxSampler Contr Line 4698  Internet-Draft        LinuxSampler Contr
4698    
4699     Examples:     Examples:
4700    
4701    
4702    
4703    Schoenebeck             Expires December 26, 2011              [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol            June 2011
4706    
4707    
4708        C: "REMOVE MIDI_INSTRUMENT_MAP 0"        C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4709    
4710        S: "OK"        S: "OK"
# Line 4303  Internet-Draft        LinuxSampler Contr Line 4737  Internet-Draft        LinuxSampler Contr
4737     current list of MIDI instrument maps, the front-end can send the     current list of MIDI instrument maps, the front-end can send the
4738     following command:     following command:
4739    
   
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
4740        LIST MIDI_INSTRUMENT_MAPS        LIST MIDI_INSTRUMENT_MAPS
4741    
4742     Possible Answers:     Possible Answers:
# Line 4326  Internet-Draft        LinuxSampler Contr Line 4750  Internet-Draft        LinuxSampler Contr
4750    
4751        S: "0,1,5,12"        S: "0,1,5,12"
4752    
4753    
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck             Expires December 26, 2011              [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol            June 2011
4762    
4763    
4764  6.7.5.  Getting MIDI instrument map information  6.7.5.  Getting MIDI instrument map information
4765    
4766     The front-end can ask for the current settings of a MIDI instrument     The front-end can ask for the current settings of a MIDI instrument
# Line 4350  Internet-Draft        LinuxSampler Contr Line 4785  Internet-Draft        LinuxSampler Contr
4785           NAME -           NAME -
4786    
4787              custom name of the given map, which does not have to be              custom name of the given map, which does not have to be
4788              unique              unique (note that this character string may contain escape
4789                sequences (Section 7.1))
4790    
4791           DEFAULT -           DEFAULT -
4792    
# Line 4361  Internet-Draft        LinuxSampler Contr Line 4797  Internet-Draft        LinuxSampler Contr
4797    
4798     Example:     Example:
4799    
4800          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4801    
4802          S: "NAME: Standard Map"
4803    
4804             "DEFAULT: true"
4805    
4806  Schoenebeck             Expires October 18, 2007               [Page 78]           "."
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
4807    
4808    
       C: "GET MIDI_INSTRUMENT_MAP INFO 0"  
4809    
       S: "NAME: Standard Map"  
4810    
          "DEFAULT: true"  
4811    
4812           "."  
4813    
4814    
4815    Schoenebeck             Expires December 26, 2011              [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol            June 2011
4818    
4819    
4820  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
4821    
# Line 4385  Internet-Draft        LinuxSampler Contr Line 4825  Internet-Draft        LinuxSampler Contr
4825        SET MIDI_INSTRUMENT_MAP NAME <map> <name>        SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4826    
4827     Where <map> is the numerical ID of the map and <name> the new custom     Where <map> is the numerical ID of the map and <name> the new custom
4828     name of the map, which does not have to be unique.     name of the map, which does not have to be unique (name MUST be
4829       encapsulated into apostrophes and supports escape sequences as
4830       described in chapter "Character Set and Escape Sequences
4831       (Section 7.1)").
4832    
4833     Possible Answers:     Possible Answers:
4834    
# Line 4417  Internet-Draft        LinuxSampler Contr Line 4860  Internet-Draft        LinuxSampler Contr
4860     <midi_prog> an integer value between 0..127 reflecting the MIDI     <midi_prog> an integer value between 0..127 reflecting the MIDI
4861     program change index, <engine_name> a sampler engine name as returned     program change index, <engine_name> a sampler engine name as returned
4862     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4863       encapsulated into apostrophes), <filename> the name of the
4864       instrument's file to be deployed (encapsulated into apostrophes,
4865       supporting escape sequences as described in chapter "Character Set
4866       and Escape Sequences (Section 7.1)"), <instrument_index> the index
4867       (integer value) of the instrument within the given file,
4868    
4869    
4870    
4871  Schoenebeck             Expires October 18, 2007               [Page 79]  Schoenebeck             Expires December 26, 2011              [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
4874    
4875    
4876     encapsulated into apostrophes), <filename> the name of the     <volume_value> reflects the master volume of the instrument as
4877     instrument's file to be deployed (encapsulated into apostrophes),     optionally dotted number (where a value < 1.0 means attenuation and a
4878     <instrument_index> the index (integer value) of the instrument within     value > 1.0 means amplification).  This parameter easily allows to
4879     the given file, <volume_value> reflects the master volume of the     adjust the volume of all intruments within a custom instrument map
4880     instrument as optionally dotted number (where a value < 1.0 means     without having to adjust their instrument files.  The OPTIONAL
4881     attenuation and a value > 1.0 means amplification).  This parameter     <instr_load_mode> argument defines the life time of the instrument,
4882     easily allows to adjust the volume of all intruments within a custom     that is when the instrument should be loaded, when freed and has
4883     instrument map without having to adjust their instrument files.  The     exactly the following possibilities:
    OPTIONAL <instr_load_mode> argument defines the life time of the  
    instrument, that is when the instrument should be loaded, when freed  
    and has exactly the following possibilities:  
4884    
4885        "ON_DEMAND" -        "ON_DEMAND" -
4886    
# Line 4473  Internet-Draft        LinuxSampler Contr Line 4918  Internet-Draft        LinuxSampler Contr
4918           the mode currently reflected by the already existing entry,           the mode currently reflected by the already existing entry,
4919           that is it will not change the mode.           that is it will not change the mode.
4920    
4921       The <instr_load_mode> argument thus allows to define an appropriate
4922       strategy (low memory consumption vs. fast instrument switching) for
4923       each instrument individually.  Note, the following restrictions apply
4924    
4925    
4926    
4927  Schoenebeck             Expires October 18, 2007               [Page 80]  Schoenebeck             Expires December 26, 2011              [Page 88]
4928    
4929  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
4930    
4931    
    The <instr_load_mode> argument thus allows to define an appropriate  
    strategy (low memory consumption vs. fast instrument switching) for  
    each instrument individually.  Note, the following restrictions apply  
4932     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4933     supported by the respective sampler engine (which is technically the     supported by the respective sampler engine (which is technically the
4934     case when the engine provides an InstrumentManager for its format).     case when the engine provides an InstrumentManager for its format).
# Line 4496  Internet-Draft        LinuxSampler Contr Line 4941  Internet-Draft        LinuxSampler Contr
4941     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4942     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4943     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4944     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes, supporting escape sequences as described in chapter
4945     displaying an appropriate name for mapped instruments (using "GET     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4946     MIDI_INSTRUMENT INFO" (Section 6.7.11)).     entry, useful for frontends for displaying an appropriate name for
4947       mapped instruments (using "GET MIDI_INSTRUMENT INFO"
4948       (Section 6.7.11)).
4949    
4950     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4951     completely established in the sampler.  The OPTIONAL "NON_MODAL"     completely established in the sampler.  The OPTIONAL "NON_MODAL"
# Line 4532  Internet-Draft        LinuxSampler Contr Line 4979  Internet-Draft        LinuxSampler Contr
4979    
4980    
4981    
4982  Schoenebeck             Expires October 18, 2007               [Page 81]  
4983    Schoenebeck             Expires December 26, 2011              [Page 89]
4984    
4985  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
4986    
4987    
4988        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
# Line 4588  Internet-Draft        LinuxSampler Contr Line 5036  Internet-Draft        LinuxSampler Contr
5036    
5037    
5038    
5039  Schoenebeck             Expires October 18, 2007               [Page 82]  Schoenebeck             Expires December 26, 2011              [Page 90]
5040    
5041  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
5042    
5043    
5044        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
# Line 4644  Internet-Draft        LinuxSampler Contr Line 5092  Internet-Draft        LinuxSampler Contr
5092    
5093    
5094    
5095  Schoenebeck             Expires October 18, 2007               [Page 83]  Schoenebeck             Expires December 26, 2011              [Page 91]
5096    
5097  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
5098    
5099    
5100        "OK" -        "OK" -
# Line 4690  Internet-Draft        LinuxSampler Contr Line 5138  Internet-Draft        LinuxSampler Contr
5138           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
5139           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
5140           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
5141           be unique.           be unique. (note that this character string may contain escape
5142             sequences (Section 7.1))
5143    
5144        "ENGINE_NAME" -        "ENGINE_NAME" -
5145    
# Line 4699  Internet-Draft        LinuxSampler Contr Line 5148  Internet-Draft        LinuxSampler Contr
5148    
5149    
5150    
5151    Schoenebeck             Expires December 26, 2011              [Page 92]
 Schoenebeck             Expires October 18, 2007               [Page 84]  
5152    
5153  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
5154    
5155    
5156        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
5157    
5158           File name of the instrument.           File name of the instrument (note that this path may contain
5159             escape sequences (Section 7.1)).
5160    
5161        "INSTRUMENT_NR" -        "INSTRUMENT_NR" -
5162    
# Line 4717  Internet-Draft        LinuxSampler Contr Line 5166  Internet-Draft        LinuxSampler Contr
5166    
5167           Name of the loaded instrument as reflected by its file.  In           Name of the loaded instrument as reflected by its file.  In
5168           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
5169           cannot be changed.           cannot be changed (note that this character string may contain
5170             escape sequences (Section 7.1)).
5171    
5172        "LOAD_MODE" -        "LOAD_MODE" -
5173    
# Line 4750  Internet-Draft        LinuxSampler Contr Line 5200  Internet-Draft        LinuxSampler Contr
5200    
5201           "VOLUME: 1.0"           "VOLUME: 1.0"
5202    
          "."  
   
5203    
5204    
5205    
5206    
5207  Schoenebeck             Expires October 18, 2007               [Page 85]  Schoenebeck             Expires December 26, 2011              [Page 93]
5208    
5209  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
5210    
5211    
5212             "."
5213    
5214  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
5215    
5216     The front-end can clear a whole MIDI instrument map, that is delete     The front-end can clear a whole MIDI instrument map, that is delete
# Line 4800  Internet-Draft        LinuxSampler Contr Line 5250  Internet-Draft        LinuxSampler Contr
5250     The following commands describe how to use and manage the instruments     The following commands describe how to use and manage the instruments
5251     database.     database.
5252    
5253       Notice:
5254    
5255          All command arguments representing a path or instrument/directory
5256          name support escape sequences as described in chapter "Character
5257          Set and Escape Sequences (Section 7.1)".
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck             Expires December 26, 2011              [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol            June 2011
5266    
5267    
5268          All occurrences of a forward slash in instrument and directory
5269          names are escaped with its hex (\x2f) or octal (\057) escape
5270          sequence.
5271    
5272  6.8.1.  Creating a new instrument directory  6.8.1.  Creating a new instrument directory
5273    
5274     The front-end can add a new instrument directory to the instruments     The front-end can add a new instrument directory to the instruments
# Line 4810  Internet-Draft        LinuxSampler Contr Line 5279  Internet-Draft        LinuxSampler Contr
5279     Where <dir> is the absolute path name of the directory to be created     Where <dir> is the absolute path name of the directory to be created
5280     (encapsulated into apostrophes).     (encapsulated into apostrophes).
5281    
   
   
 Schoenebeck             Expires October 18, 2007               [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
5282     Possible Answers:     Possible Answers:
5283    
5284        "OK" -        "OK" -
# Line 4850  Internet-Draft        LinuxSampler Contr Line 5312  Internet-Draft        LinuxSampler Contr
5312    
5313        "OK" -        "OK" -
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck             Expires December 26, 2011              [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol            June 2011
5322    
5323    
5324           if the directory is deleted successfully           if the directory is deleted successfully
5325    
5326        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 4863  Internet-Draft        LinuxSampler Contr Line 5334  Internet-Draft        LinuxSampler Contr
5334    
5335        S: "OK"        S: "OK"
5336    
   
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
5337  6.8.3.  Getting amount of instrument directories  6.8.3.  Getting amount of instrument directories
5338    
5339     The front-end can retrieve the current amount of directories in a     The front-end can retrieve the current amount of directories in a
5340     specific directory by sending the following command:     specific directory by sending the following command:
5341    
5342        GET DB_INSTRUMENT_DIRECTORIES <dir>        GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
5343    
5344     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5345     directory.     directory.  If RECURSIVE is specified, the number of all directories,
5346       including those located in subdirectories of the specified directory,
5347       will be returned.
5348    
5349     Possible Answers:     Possible Answers:
5350    
# Line 4903  Internet-Draft        LinuxSampler Contr Line 5366  Internet-Draft        LinuxSampler Contr
5366     The front-end can retrieve the current list of directories in     The front-end can retrieve the current list of directories in
5367     specific directory by sending the following command:     specific directory by sending the following command:
5368    
5369        LIST DB_INSTRUMENT_DIRECTORIES <dir>        LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
5370    
5371     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5372     directory.  
5373    
5374    
5375    Schoenebeck             Expires December 26, 2011              [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol            June 2011
5378    
5379    
5380       directory.  If RECURSIVE is specified, the absolute path names of all
5381       directories, including those located in subdirectories of the
5382       specified directory, will be returned.
5383    
5384     Possible Answers:     Possible Answers:
5385    
# Line 4919  Internet-Draft        LinuxSampler Contr Line 5392  Internet-Draft        LinuxSampler Contr
5392    
5393     Example:     Example:
5394    
   
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
5395        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"        C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
5396    
5397        S: "'Piano Collection','Percussion Collection'"        S: "'Piano Collection','Percussion Collection'"
5398    
5399          C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
5400    
5401          S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
5402          Collection/Acoustic/New','/Percussion Collection'"
5403    
5404  6.8.5.  Getting instrument directory information  6.8.5.  Getting instrument directory information
5405    
5406     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 4955  Internet-Draft        LinuxSampler Contr Line 5423  Internet-Draft        LinuxSampler Contr
5423    
5424           DESCRIPTION -           DESCRIPTION -
5425    
5426              A brief description of the directory content              A brief description of the directory content.  Note that the
5427                character string may contain escape sequences (Section 7.1).
5428    
5429    
5430    
5431    Schoenebeck             Expires December 26, 2011              [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol            June 2011
5434    
5435    
5436           CREATED -           CREATED -
5437    
# Line 4976  Internet-Draft        LinuxSampler Contr Line 5452  Internet-Draft        LinuxSampler Contr
5452        S: "DESCRIPTION: Piano collection of instruments in GigaSampler        S: "DESCRIPTION: Piano collection of instruments in GigaSampler
5453        format."        format."
5454    
   
   
   
   
 Schoenebeck             Expires October 18, 2007               [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
5455           "CREATED: 2007-02-05 10:23:12"           "CREATED: 2007-02-05 10:23:12"
5456    
5457           "MODIFIED: 2007-04-07 12:50:21"           "MODIFIED: 2007-04-07 12:50:21"
# Line 5014  Internet-Draft        LinuxSampler Contr Line 5481  Internet-Draft        LinuxSampler Contr
5481    
5482     Example:     Example:
5483    
5484    
5485    
5486    
5487    Schoenebeck             Expires December 26, 2011              [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol            June 2011
5490    
5491    
5492        C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'        C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5493        'Acoustic'"        'Acoustic'"
5494    
# Line 5031  Internet-Draft        LinuxSampler Contr Line 5506  Internet-Draft        LinuxSampler Contr
5506    
5507     Possible Answers:     Possible Answers:
5508    
5509          "OK" -
5510    
5511             on success
5512    
5513          "ERR:<error-code>:<error-message>" -
5514    
5515             in case a given directory does not exists, or if a directory
5516             with name equal to the name of the specified directory already
5517             exists in the destination directory.  Error is also thrown when
5518             trying to move a directory to a subdirectory of itself.
5519    
5520       Example:
5521    
5522          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5523          Acoustic'"
5524    
5525          S: "OK"
5526    
5527    6.8.8.  Copying instrument directories
5528    
5529       The front-end can copy a specific instrument directory by sending the
5530       following command:
5531    
5532          COPY DB_INSTRUMENT_DIRECTORY <dir> <dst>
5533    
5534       Where <dir> is the absolute path name of the directory to copy and
5535       <dst> is the location where the directory will be copied to.
5536    
5537       Possible Answers:
5538    
5539  Schoenebeck             Expires October 18, 2007               [Page 90]  
5540    
5541    
5542    
5543    Schoenebeck             Expires December 26, 2011              [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
5546    
5547    
5548        "OK" -        "OK" -
# Line 5050  Internet-Draft        LinuxSampler Contr Line 5554  Internet-Draft        LinuxSampler Contr
5554           in case a given directory does not exists, or if a directory           in case a given directory does not exists, or if a directory
5555           with name equal to the name of the specified directory already           with name equal to the name of the specified directory already
5556           exists in the destination directory.  Error is also thrown when           exists in the destination directory.  Error is also thrown when
5557           trying to move a directory to a subdirectory of itself.           trying to copy a directory to a subdirectory of itself.
5558    
5559     Example:     Example:
5560    
5561        C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/        C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5562        Acoustic'"        '/Acoustic/Pianos'"
5563    
5564        S: "OK"        S: "OK"
5565    
5566  6.8.8.  Changing the description of directory  6.8.9.  Changing the description of directory
5567    
5568     The front-end can alter the description of a specific instrument     The front-end can alter the description of a specific instrument
5569     directory by sending the following command:     directory by sending the following command:
# Line 5067  Internet-Draft        LinuxSampler Contr Line 5571  Internet-Draft        LinuxSampler Contr
5571        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>        SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5572    
5573     Where <dir> is the absolute path name of the directory and <desc> is     Where <dir> is the absolute path name of the directory and <desc> is
5574     the new description for the directory.     the new description for the directory (encapsulated into apostrophes,
5575       supporting escape sequences as described in chapter "Character Set
5576       and Escape Sequences (Section 7.1)").
5577    
5578     Possible Answers:     Possible Answers:
5579    
# Line 5090  Internet-Draft        LinuxSampler Contr Line 5596  Internet-Draft        LinuxSampler Contr
5596    
5597    
5598    
5599    Schoenebeck             Expires December 26, 2011             [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol            June 2011
5602    
5603    
5604    6.8.10.  Finding directories
5605    
5606       The front-end can search for directories in specific directory by
5607       sending the following command:
5608    
5609          FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-
5610          list>
5611    
5612       Where <dir> should be replaced by the absolute path name of the
5613       directory to search in.  If NON_RECURSIVE is specified, the
5614       directories located in subdirectories of the specified directory will
5615       not be searched. <criteria-list> is a list of search criterias in
5616       form of "key1=val1 key2=val2 ...".  The following criterias are
5617       allowed:
5618    
5619       NAME='<search-string>'
5620    
5621          Restricts the search to directories, which names satisfy the
5622          supplied search string (encapsulated into apostrophes, supporting
5623          escape sequences as described in chapter "Character Set and Escape
5624          Sequences (Section 7.1)").
5625    
5626       CREATED='[<date-after>]..[<date-before>]'
5627    
5628          Restricts the search to directories, which creation date satisfies
5629          the specified period, where <date-after> and <date-before> are in
5630          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5631          search is restricted to directories created before <date-before>.
5632          If <date-before> is omitted, the search is restricted to
5633          directories created after <date-after>.
5634    
5635       MODIFIED='[<date-after>]..[<date-before>]'
5636    
5637          Restricts the search to directories, which date of last
5638          modification satisfies the specified period, where <date-after>
5639          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5640          after> is omitted the search is restricted to directories, which
5641          are last modified before <date-before>.  If <date-before> is
5642          omitted, the search is restricted to directories, which are last
5643          modified after <date-after>.
5644    
5645       DESCRIPTION='<search-string>'
5646    
5647          Restricts the search to directories with description that
5648          satisfies the supplied search string (encapsulated into
5649          apostrophes, supporting escape sequences as described in chapter
5650          "Character Set and Escape Sequences (Section 7.1)").
5651    
5652    
5653    
5654  Schoenebeck             Expires October 18, 2007               [Page 91]  
5655    Schoenebeck             Expires December 26, 2011             [Page 101]
5656    
5657  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
5658    
5659    
5660       Where <search-string> is either a regular expression, or a word list
5661       separated with spaces for OR search and with '+' for AND search.
5662    
5663       Possible Answers:
5664    
5665          A comma separated list with the absolute path names (encapsulated
5666          into apostrophes) of all directories in the specified directory
5667          that satisfy the supplied search criterias.
5668    
5669          "ERR:<error-code>:<error-message>" -
5670    
5671             if the given directory does not exist.
5672    
5673       Example:
5674    
5675          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5676    
5677  6.8.9.  Adding instruments to the instruments database        S: "'/Piano Collection'"
5678    
5679          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5680          30:13'"
5681    
5682          S: "'/Piano Collection','/Percussions'"
5683    
5684    6.8.11.  Adding instruments to the instruments database
5685    
5686     The front-end can add one or more instruments to the instruments     The front-end can add one or more instruments to the instruments
5687     database by sending the following command:     database by sending the following command:
5688    
5689        ADD DB_INSTRUMENTS [<mode>] <db_dir> <file_path> [<instr_index>]        ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir>
5690          <file_path> [<instr_index>]
5691    
5692     Where <db_dir> is the absolute path name of a directory (encapsulated     Where <db_dir> is the absolute path name of a directory (encapsulated
5693     into apostrophes) in the instruments database in which only the new     into apostrophes) in the instruments database in which only the new
# Line 5118  Internet-Draft        LinuxSampler Contr Line 5703  Internet-Draft        LinuxSampler Contr
5703     is provided as <file_path> and specifies how the scanning will be     is provided as <file_path> and specifies how the scanning will be
5704     done and has exactly the following possibilities:     done and has exactly the following possibilities:
5705    
5706    
5707    
5708    
5709    
5710    
5711    Schoenebeck             Expires December 26, 2011             [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol            June 2011
5714    
5715    
5716          "RECURSIVE" -
5717    
5718             All instruments will be processed, including those in the
5719             subdirectories, and the respective subdirectory tree structure
5720             will be recreated in the instruments database
5721    
5722        "NON_RECURSIVE" -        "NON_RECURSIVE" -
5723    
5724           Only the instruments in the specified directory will be added,           Only the instruments in the specified directory will be added,
# Line 5130  Internet-Draft        LinuxSampler Contr Line 5731  Internet-Draft        LinuxSampler Contr
5731           not be recreated in the instruments database.  All instruments           not be recreated in the instruments database.  All instruments
5732           will be added directly in the specified database directory.           will be added directly in the specified database directory.
5733    
5734        not supplied -     If FILE_AS_DIR argument is supplied, all instruments in an instrument
5735       file will be added to a separate directory in the instruments
5736       database, which name will be the name of the instrument file with the
5737       file extension stripped off.
5738    
5739           The subdirectory tree structure will be recreated in the     The difference between regular and NON_MODAL versions of the command
5740           instruments database and all instruments will be processed and     is that the regular command returns when the scanning is finished
5741           added to the respective subdirectory in the instruments     while NON_MODAL version returns immediately and a background process
5742           database.     is launched.  The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5743       command can be used to monitor the scanning progress.
5744    
5745     Possible Answers:     Possible Answers:
5746    
5747        "OK" -        "OK" -
5748    
5749           on success           on success when NON_MODAL is not supplied
5750    
5751          "OK[<job-id>]" -
5752    
5753             on success when NON_MODAL is supplied, where <job-id> is a
5754             numerical ID used to obtain status information about the job
5755             progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5756    
5757          "ERR:<error-code>:<error-message>" -
5758    
5759             if an invalid path is specified.
5760    
5761       Examples:
5762    
5763    
 Schoenebeck             Expires October 18, 2007               [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
5764    
5765    
       "ERR:<error-code>:<error-message>" -  
5766    
5767           if an invalid path is specified.  Schoenebeck             Expires December 26, 2011             [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol            June 2011
5770    
    Examples:  
5771    
5772        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5773        Bosendorfer 290.gig' 0"        Bosendorfer 290.gig' 0"
5774    
5775        S: "OK"        S: "OK"
5776    
5777  6.8.10.  Removing an instrument  6.8.12.  Removing an instrument
5778    
5779     The front-end can remove a particular instrument from the instruments     The front-end can remove a particular instrument from the instruments
5780     database by sending the following command:     database by sending the following command:
# Line 5190  Internet-Draft        LinuxSampler Contr Line 5800  Internet-Draft        LinuxSampler Contr
5800    
5801        S: "OK"        S: "OK"
5802    
5803  6.8.11.  Getting amount of instruments  6.8.13.  Getting amount of instruments
5804    
5805     The front-end can retrieve the current amount of instruments in a     The front-end can retrieve the current amount of instruments in a
5806     specific directory by sending the following command:     specific directory by sending the following command:
5807    
5808        GET DB_INSTRUMENTS <dir>        GET DB_INSTRUMENTS [RECURSIVE] <dir>
5809    
5810     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5811     directory.     directory.  If RECURSIVE is specified, the number of all instruments,
5812       including those located in subdirectories of the specified directory,
5813       will be returned.
5814    
5815     Possible Answers:     Possible Answers:
5816    
5817          The current number of instruments in the specified directory.
5818    
5819    
 Schoenebeck             Expires October 18, 2007               [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
5820    
5821    
5822        The current number of instruments in the specified directory.  
5823    Schoenebeck             Expires December 26, 2011             [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol            June 2011
5826    
5827    
5828        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5829    
# Line 5221  Internet-Draft        LinuxSampler Contr Line 5835  Internet-Draft        LinuxSampler Contr
5835    
5836        S: "2"        S: "2"
5837    
5838  6.8.12.  Listing all instruments in specific directory  6.8.14.  Listing all instruments in specific directory
5839    
5840     The front-end can retrieve the current list of instruments in     The front-end can retrieve the current list of instruments in
5841     specific directory by sending the following command:     specific directory by sending the following command:
5842    
5843        LIST DB_INSTRUMENTS <dir>        LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5844    
5845     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5846     directory.     directory.  If RECURSIVE is specified, the absolute path names of all
5847       instruments, including those located in subdirectories of the
5848       specified directory, will be returned.
5849    
5850     Possible Answers:     Possible Answers:
5851    
# Line 5246  Internet-Draft        LinuxSampler Contr Line 5862  Internet-Draft        LinuxSampler Contr
5862    
5863        S: "'Bosendorfer 290','Steinway D'"        S: "'Bosendorfer 290','Steinway D'"
5864    
5865  6.8.13.  Getting instrument information        C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
5866    
5867          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5868          Steinway D','/Piano Collection/Lite/Free Piano'"
5869    
5870    6.8.15.  Getting instrument information
5871    
5872     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
5873     sending the following command:     sending the following command:
5874    
       GET DB_INSTRUMENT INFO <instr_path>  
5875    
    Where <instr_path> should be replaced by the absolute path name of  
    the instrument the front-end is interested in.  
   
    Possible Answers:  
5876    
5877    
5878    
5879  Schoenebeck             Expires October 18, 2007               [Page 94]  Schoenebeck             Expires December 26, 2011             [Page 105]
5880    
5881  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
5882    
5883    
5884          GET DB_INSTRUMENT INFO <instr_path>
5885    
5886       Where <instr_path> should be replaced by the absolute path name of
5887       the instrument the front-end is interested in.
5888    
5889       Possible Answers:
5890    
5891        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5892        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
# Line 5275  Internet-Draft        LinuxSampler Contr Line 5898  Internet-Draft        LinuxSampler Contr
5898    
5899           INSTRUMENT_FILE -           INSTRUMENT_FILE -
5900    
5901              File name of the instrument.              File name of the instrument.  Note that the character string
5902                may contain escape sequences (Section 7.1).
5903    
5904           INSTRUMENT_NR -           INSTRUMENT_NR -
5905    
# Line 5305  Internet-Draft        LinuxSampler Contr Line 5929  Internet-Draft        LinuxSampler Contr
5929              instrument's database settings, represented in "YYYY-MM-DD              instrument's database settings, represented in "YYYY-MM-DD
5930              HH:MM:SS" format              HH:MM:SS" format
5931    
          DESCRIPTION -  
5932    
             A brief description of the instrument  
5933    
          IS_DRUM -  
5934    
5935              either true or false, determines whether the instrument is a  Schoenebeck             Expires December 26, 2011             [Page 106]
5936              drumkit or a chromatic instrument  
5937    Internet-Draft        LinuxSampler Control Protocol            June 2011
5938    
5939    
5940             DESCRIPTION -
5941    
5942  Schoenebeck             Expires October 18, 2007               [Page 95]              A brief description of the instrument.  Note that the
5943                character string may contain escape sequences (Section 7.1).
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
5944    
5945             IS_DRUM -
5946    
5947                either true or false, determines whether the instrument is a
5948                drumkit or a chromatic instrument
5949    
5950           PRODUCT -           PRODUCT -
5951    
5952              The product title of the instrument              The product title of the instrument.  Note that the
5953                character string may contain escape sequences (Section 7.1).
5954    
5955           ARTISTS -           ARTISTS -
5956    
5957              Lists the artist names              Lists the artist names.  Note that the character string may
5958                contain escape sequences (Section 7.1).
5959    
5960           KEYWORDS -           KEYWORDS -
5961    
5962              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
5963              Keywords are separated with semicolon and blank.              Keywords are separated with semicolon and blank.  Note that
5964                the character string may contain escape sequences
5965                (Section 7.1).
5966    
5967     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
5968    
# Line 5354  Internet-Draft        LinuxSampler Contr Line 5984  Internet-Draft        LinuxSampler Contr
5984    
5985           "MODIFIED: 2007-04-07 12:50:21"           "MODIFIED: 2007-04-07 12:50:21"
5986    
          "DESCRIPTION: "  
   
          "IS_DRUM: false"  
   
          "PRODUCT: GRANDIOSO Bosendorfer 290"  
5987    
          "ARTISTS: Post Musical Instruments"  
5988    
          "KEYWORDS: Bosendorfer"  
5989    
          "."  
5990    
5991    Schoenebeck             Expires December 26, 2011             [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol            June 2011
5994    
5995    
5996             "DESCRIPTION: "
5997    
5998             "IS_DRUM: false"
5999    
6000             "PRODUCT: GRANDIOSO Bosendorfer 290"
6001    
6002             "ARTISTS: Post Musical Instruments"
6003    
6004  Schoenebeck             Expires October 18, 2007               [Page 96]           "KEYWORDS: Bosendorfer"
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
6005    
6006             "."
6007    
6008  6.8.14.  Renaming an instrument  6.8.16.  Renaming an instrument
6009    
6010     The front-end can alter the name of a specific instrument by sending     The front-end can alter the name of a specific instrument by sending
6011     the following command:     the following command:
# Line 5405  Internet-Draft        LinuxSampler Contr Line 6033  Internet-Draft        LinuxSampler Contr
6033    
6034        S: "OK"        S: "OK"
6035    
6036  6.8.15.  Moving an instrument  6.8.17.  Moving an instrument
6037    
6038     The front-end can move a specific instrument to another directory by     The front-end can move a specific instrument to another directory by
6039     sending the following command:     sending the following command:
# Line 5413  Internet-Draft        LinuxSampler Contr Line 6041  Internet-Draft        LinuxSampler Contr
6041        MOVE DB_INSTRUMENT <instr> <dst>        MOVE DB_INSTRUMENT <instr> <dst>
6042    
6043     Where <instr> is the absolute path name of the instrument to move and     Where <instr> is the absolute path name of the instrument to move and
6044    
6045    
6046    
6047    Schoenebeck             Expires December 26, 2011             [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol            June 2011
6050    
6051    
6052     <dst> is the directory where the instrument will be moved to.     <dst> is the directory where the instrument will be moved to.
6053    
6054     Possible Answers:     Possible Answers:
# Line 5425  Internet-Draft        LinuxSampler Contr Line 6061  Internet-Draft        LinuxSampler Contr
6061    
6062           in case the given instrument does not exists, or if an           in case the given instrument does not exists, or if an
6063           instrument with name equal to the name of the specified           instrument with name equal to the name of the specified
6064             instrument already exists in the destination directory.
6065    
6066       Example:
6067    
6068          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
6069          Collection/Acoustic'"
6070    
6071  Schoenebeck             Expires October 18, 2007               [Page 97]        S: "OK"
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
6072    
6073    6.8.18.  Copying instruments
6074    
6075       The front-end can copy a specific instrument to another directory by
6076       sending the following command:
6077    
6078          COPY DB_INSTRUMENT <instr> <dst>
6079    
6080       Where <instr> is the absolute path name of the instrument to copy and
6081       <dst> is the directory where the instrument will be copied to.
6082    
6083       Possible Answers:
6084    
6085          "OK" -
6086    
6087             on success
6088    
6089          "ERR:<error-code>:<error-message>" -
6090    
6091             in case the given instrument does not exists, or if an
6092             instrument with name equal to the name of the specified
6093           instrument already exists in the destination directory.           instrument already exists in the destination directory.
6094    
6095     Example:     Example:
6096    
6097        C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano        C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
6098        Collection/Acoustic'"        '/Acoustic/Pianos/'"
6099    
6100    
6101    
6102    
6103    Schoenebeck             Expires December 26, 2011             [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol            June 2011
6106    
6107    
6108        S: "OK"        S: "OK"
6109    
6110  6.8.16.  Changing the description of instrument  6.8.19.  Changing the description of instrument
6111    
6112     The front-end can alter the description of a specific instrument by     The front-end can alter the description of a specific instrument by
6113     sending the following command:     sending the following command:
# Line 5450  Internet-Draft        LinuxSampler Contr Line 6115  Internet-Draft        LinuxSampler Contr
6115        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>        SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
6116    
6117     Where <instr> is the absolute path name of the instrument and <desc>     Where <instr> is the absolute path name of the instrument and <desc>
6118     is the new description for the instrument.     is the new description for the instrument (encapsulated into
6119       apostrophes, supporting escape sequences as described in chapter
6120       "Character Set and Escape Sequences (Section 7.1)").
6121    
6122     Possible Answers:     Possible Answers:
6123    
# Line 5469  Internet-Draft        LinuxSampler Contr Line 6136  Internet-Draft        LinuxSampler Contr
6136    
6137        S: "OK"        S: "OK"
6138    
6139    6.8.20.  Finding instruments
6140    
6141       The front-end can search for instruments in specific directory by
6142       sending the following command:
6143    
6144          FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
6145    
6146       Where <dir> should be replaced by the absolute path name of the
6147       directory to search in.  If NON_RECURSIVE is specified, the
6148       directories located in subdirectories of the specified directory will
6149       not be searched. <criteria-list> is a list of search criterias in
6150       form of "key1=val1 key2=val2 ...".  The following criterias are
6151       allowed:
6152    
6153       NAME='<search-string>'
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck             Expires December 26, 2011             [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol            June 2011
6162    
6163    
6164          Restricts the search to instruments, which names satisfy the
6165          supplied search string (encapsulated into apostrophes, supporting
6166          escape sequences as described in chapter "Character Set and Escape
6167          Sequences (Section 7.1)").
6168    
6169       SIZE=[<min>]..[<max>]
6170    
6171          Restricts the search to instruments, which size is in the
6172          specified range.  If <min> is omitted, the search results are
6173          restricted to instruments with size less then or equal to <max>.
6174          If <max> is omitted, the search is restricted to instruments with
6175          size greater then or equal to <min>.
6176    
6177       CREATED='[<date-after>]..[<date-before>]'
6178    
6179          Restricts the search to instruments, which creation date satisfies
6180          the specified period, where <date-after> and <date-before> are in
6181          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
6182          search is restricted to instruments created before <date-before>.
6183          If <date-before> is omitted, the search is restricted to
6184          instruments created after <date-after>.
6185    
6186       MODIFIED='[<date-after>]..[<date-before>]'
6187    
6188          Restricts the search to instruments, which date of last
6189          modification satisfies the specified period, where <date-after>
6190          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
6191          after> is omitted the search is restricted to instruments, which
6192          are last modified before <date-before>.  If <date-before> is
6193          omitted, the search is restricted to instruments, which are last
6194          modified after <date-after>.
6195    
6196       DESCRIPTION='<search-string>'
6197    
6198          Restricts the search to instruments with description that
6199          satisfies the supplied search string (encapsulated into
6200          apostrophes, supporting escape sequences as described in chapter
6201          "Character Set and Escape Sequences (Section 7.1)").
6202    
6203       PRODUCT='<search-string>'
6204    
6205          Restricts the search to instruments with product info that
6206          satisfies the supplied search string (encapsulated into
6207          apostrophes, supporting escape sequences as described in chapter
6208          "Character Set and Escape Sequences (Section 7.1)").
6209    
6210       ARTISTS='<search-string>'
6211    
6212    
6213    
6214    
6215    Schoenebeck             Expires December 26, 2011             [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol            June 2011
6218    
6219    
6220          Restricts the search to instruments with artists info that
6221          satisfies the supplied search string (encapsulated into
6222          apostrophes, supporting escape sequences as described in chapter
6223          "Character Set and Escape Sequences (Section 7.1)").
6224    
6225       KEYWORDS='<search-string>'
6226    
6227          Restricts the search to instruments with keyword list that
6228          satisfies the supplied search string (encapsulated into
6229          apostrophes, supporting escape sequences as described in chapter
6230          "Character Set and Escape Sequences (Section 7.1)").
6231    
6232       IS_DRUM=true | false
6233    
6234          Either true or false.  Restricts the search to drum kits or
6235          chromatic instruments.
6236    
6237       FORMAT_FAMILIES='<format-list>'
6238    
6239          Restricts the search to instruments of the supplied format
6240          families, where <format-list> is a comma separated list of format
6241          families.
6242    
6243       Where <search-string> is either a regular expression, or a word list
6244       separated with spaces for OR search and with '+' for AND search.
6245    
6246       Possible Answers:
6247    
6248          A comma separated list with the absolute path names (encapsulated
6249          into apostrophes) of all instruments in the specified directory
6250          that satisfy the supplied search criterias.
6251    
6252          "ERR:<error-code>:<error-message>" -
6253    
6254             if the given directory does not exist.
6255    
6256       Example:
6257    
6258          C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
6259          290'"
6260    
6261          S: "'/Piano Collection/Bosendorfer 290'"
6262    
6263          C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
6264          09:30:13..'"
6265    
6266          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
6267          Steinway D'"
6268    
6269    
6270    
6271    Schoenebeck             Expires December 26, 2011             [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol            June 2011
6274    
6275    
6276    6.8.21.  Getting job status information
6277    
6278       The front-end can ask for the current status of a particular database
6279       instruments job by sending the following command:
6280    
6281          GET DB_INSTRUMENTS_JOB INFO <job-id>
6282    
6283       Where <job-id> should be replaced by the numerical ID of the job the
6284       front-end is interested in.
6285    
6286       Possible Answers:
6287    
6288          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6289          answer line begins with the settings category name followed by a
6290          colon and then a space character <SP> and finally the info
6291          character string to that setting category.  At the moment the
6292          following categories are defined:
6293    
6294    
6295    
6296             FILES_TOTAL -
6297    
6298                The total number of files scheduled for scanning
6299    
6300             FILES_SCANNED -
6301    
6302                The current number of scanned files
6303    
6304             SCANNING -
6305    
6306                The absolute path name of the file which is currently being
6307                scanned
6308    
6309             STATUS -
6310    
6311                An integer value between 0 and 100 indicating the scanning
6312                progress percentage of the file which is currently being
6313                scanned
6314    
6315       The mentioned fields above don't have to be in particular order.
6316    
6317       Example:
6318    
6319          C: "GET DB_INSTRUMENTS_JOB INFO 2"
6320    
6321          S: "FILES_TOTAL: 12"
6322    
6323    
6324    
6325    
6326    
6327    Schoenebeck             Expires December 26, 2011             [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol            June 2011
6330    
6331    
6332             "FILES_SCANNED: 7"
6333    
6334             "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
6335    
6336             "STATUS: 42"
6337    
6338             "."
6339    
6340    6.8.22.  Formatting the instruments database
6341    
6342       The front-end can remove all instruments and directories and re-
6343       create the instruments database structure (e.g., in case of a
6344       database corruption) by sending the following command:
6345    
6346          FORMAT INSTRUMENTS_DB
6347    
6348       Possible Answers:
6349    
6350          "OK" -
6351    
6352             on success
6353    
6354          "ERR:<error-code>:<error-message>" -
6355    
6356             If the formatting of the instruments database failed.
6357    
6358    6.8.23.  Checking for lost instrument files
6359    
6360       The front-end can retrieve the list of all instrument files in the
6361       instruments database that don't exist in the filesystem by sending
6362       the following command:
6363    
6364          FIND LOST DB_INSTRUMENT_FILES
6365    
6366       Possible Answers:
6367    
6368          A comma separated list with the absolute path names (encapsulated
6369          into apostrophes) of all lost instrument files.
6370    
6371          "ERR:<error-code>:<error-message>" -
6372    
6373             in case it failed, providing an appropriate error code and
6374             error message.
6375    
6376       Example:
6377    
6378    
6379    
6380    
6381    
6382    
6383  Schoenebeck             Expires October 18, 2007               [Page 98]  Schoenebeck             Expires December 26, 2011             [Page 114]
6384    
6385  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
6386    
6387    
6388          C: "FIND LOST DB_INSTRUMENT_FILES"
6389    
6390          S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
6391          Piano.gig'"
6392    
6393    6.8.24.  Replacing an instrument file
6394    
6395       The front-end can substitute all occurrences of an instrument file in
6396       the instruments database with a new one by sending the following
6397       command:
6398    
6399          SET DB_INSTRUMENT FILE_PATH <old_path> <new_path>
6400    
6401       Where <old_path> is the absolute path name of the instrument file to
6402       substitute with <new_path>.
6403    
6404       Possible Answers:
6405    
6406          "OK" -
6407    
6408             on success
6409    
6410          "ERR:<error-code>:<error-message>" -
6411    
6412             in case it failed, providing an appropriate error code and
6413             error message.
6414    
6415       Example:
6416    
6417          C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig'
6418          '/gigs/pianos/Bosendorfer 290.gig'"
6419    
6420          S: "OK"
6421    
6422    6.9.  Editing Instruments
6423    
6424       The sampler allows to edit instruments while playing with the sampler
6425       by spawning an external (3rd party) instrument editor application for
6426       a given instrument.  The 3rd party instrument editor applications
6427       have to place a respective plugin DLL file into the sampler's plugins
6428       directory.  The sampler will automatically try to load all plugin
6429       DLLs in that directory on startup and only on startup!
6430    
6431       At the moment there is only one command for this feature set, but
6432       this will most probably change in future.
6433    
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck             Expires December 26, 2011             [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol            June 2011
6442    
6443    
6444    6.9.1.  Opening an appropriate instrument editor application
6445    
6446       The front-end can request to open an appropriate instrument editor
6447       application by sending the following command:
6448    
6449          EDIT CHANNEL INSTRUMENT <sampler-channel>
6450    
6451       Where <sampler-channel> should be replaced by the number of the
6452       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
6453       "LIST CHANNELS" (Section 6.4.4) command.
6454    
6455       The sampler will try to ask all registered instrument editors (or to
6456       be more specific: their sampler plugins) whether they are capable to
6457       handle the instrument on the given sampler channel.  The sampler will
6458       simply use the first instrument editor application which replied with
6459       a positive answer and spawn that instrument editor application within
6460       the sampler's process and provide that application access to the
6461       instrument's data structures, so both applications can share and
6462       access the same instruments data at the same time, thus allowing to
6463       immediately hear changes with the sampler made by the instrument
6464       editor.
6465    
6466       Note: consequently instrument editors are always spawned locally on
6467       the same machine where the sampler is running on!
6468    
6469       Possible Answers:
6470    
6471          "OK" -
6472    
6473             when an appropriate instrument editor was launched
6474    
6475          "WRN:<warning-code>:<warning-message>" -
6476    
6477             when an appropriate instrument editor was launched, but there
6478             are noteworthy issues
6479    
6480          "ERR:<error-code>:<error-message>" -
6481    
6482             when an appropriate instrument editor could not be launched
6483    
6484       Examples:
6485    
6486          C: "EDIT CHANNEL INSTRUMENT 0"
6487    
6488          S: "OK"
6489    
6490    
6491    
6492    
6493    
6494    
6495    Schoenebeck             Expires December 26, 2011             [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol            June 2011
6498    
6499    
6500    6.10.  Managing Files
6501    
6502       You can query detailed informations about files located at the same
6503       system where the sampler instance is running on.  Using this command
6504       set allows to retrieve file informations even remotely from another
6505       machine.
6506    
6507    6.10.1.  Retrieving amount of instruments of a file
6508    
6509       The front-end can retrieve the amount of instruments within a given
6510       instrument file by sending the following command:
6511    
6512          GET FILE INSTRUMENTS <filename>
6513    
6514       Where <filename> is the name of the instrument file (encapsulated
6515       into apostrophes, supporting escape sequences as described in chapter
6516       "Character Set and Escape Sequences (Section 7.1)").
6517    
6518       The sampler will try to ask all sampler engines, whether they support
6519       the given file and ask the first engine with a positive answer for
6520       the amount of instruments.
6521    
6522       Possible Answers:
6523    
6524          On success, the sampler will answer by returning the amount of
6525          instruments.
6526    
6527          "ERR:<error-code>:<error-message>" -
6528    
6529             if the file could not be handled
6530    
6531       Examples:
6532    
6533          C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6534    
6535          S: "10"
6536    
6537    6.10.2.  Retrieving all instruments of a file
6538    
6539       The front-end can retrieve a list of all instruments within a given
6540       instrument file by sending the following command:
6541    
6542          LIST FILE INSTRUMENTS <filename>
6543    
6544       Where <filename> is the name of the instrument file (encapsulated
6545       into apostrophes, supporting escape sequences as described in chapter
6546       "Character Set and Escape Sequences (Section 7.1)").
6547    
6548    
6549    
6550    
6551    Schoenebeck             Expires December 26, 2011             [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol            June 2011
6554    
6555    
6556       The sampler will try to ask all sampler engines, whether they support
6557       the given file and ask the first engine with a positive answer for a
6558       list of IDs for the instruments in the given file.
6559    
6560       Possible Answers:
6561    
6562          On success, the sampler will answer by returning a comma separated
6563          list of instrument IDs.
6564    
6565          "ERR:<error-code>:<error-message>" -
6566    
6567             if the file could not be handled
6568    
6569       Examples:
6570    
6571          C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
6572    
6573          S: "0,1,2,3,4,5,6,7,8,9"
6574    
6575    6.10.3.  Retrieving informations about one instrument in a file
6576    
6577       The front-end can retrieve detailed informations about a specific
6578       instrument within a given instrument file by sending the following
6579       command:
6580    
6581          GET FILE INSTRUMENT INFO <filename> <instr-id>
6582    
6583       Where <filename> is the name of the instrument file (encapsulated
6584       into apostrophes, supporting escape sequences as described in chapter
6585       "Character Set and Escape Sequences (Section 7.1)") and <instr-id> is
6586       the numeric instrument ID as returned by the "LIST FILE INSTRUMENTS"
6587       (Section 6.10.2) command.
6588    
6589       The sampler will try to ask all sampler engines, whether they support
6590       the given file and ask the first engine with a positive answer for
6591       informations about the specific instrument in the given file.
6592    
6593       Possible Answers:
6594    
6595          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6596          answer line begins with the settings category name followed by a
6597          colon and then a space character <SP> and finally the info
6598          character string to that setting category.  At the moment the
6599          following categories are defined:
6600    
6601    
6602    
6603    
6604    
6605    
6606    
6607    Schoenebeck             Expires December 26, 2011             [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol            June 2011
6610    
6611    
6612             NAME -
6613    
6614                name of the instrument as stored in the instrument file
6615    
6616             FORMAT_FAMILY -
6617    
6618                name of the sampler format of the given instrument
6619    
6620             FORMAT_VERSION -
6621    
6622                version of the sampler format the instrumen is stored as
6623    
6624             PRODUCT -
6625    
6626                official product name of the instrument as stored in the
6627                file
6628    
6629             ARTISTS -
6630    
6631                artists / sample library vendor of the instrument
6632    
6633             KEY_BINDINGS -
6634    
6635                comma separated list of integer values representing the
6636                instrument's key mapping in the range between 0 .. 127,
6637                reflecting the analog meaning of the MIDI specification.
6638    
6639             KEYSWITCH_BINDINGS -
6640    
6641                comma separated list of integer values representing the
6642                instrument's keyswitch mapping in the range between 0 ..
6643                127, reflecting the analog meaning of the MIDI
6644                specification.
6645    
6646       The mentioned fields above don't have to be in particular order.
6647    
6648       Example:
6649    
6650          C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
6651    
6652          S: "NAME: Lunatic Loops"
6653    
6654             "FORMAT_FAMILY: GIG"
6655    
6656             "FORMAT_VERSION: 3"
6657    
6658             "PRODUCT: The Backbone Bongo Beats"
6659    
6660    
6661    
6662    
6663    Schoenebeck             Expires December 26, 2011             [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol            June 2011
6666    
6667    
6668             "ARTISTS: Jimmy the Fish"
6669    
6670             "."
6671    
6672    6.11.  Managing Effects
6673    
6674       Audio effects (e.g. reverb, delay, compression) can be applied to the
6675       audio signals generated by the sampler.  The sampler usually provides
6676       a set of internal audio effects for this task.  The exact set of
6677       effects depends on the availability of third party effect plugins
6678       installed on the system where the sampler runs on.
6679    
6680       At the moment only "send effects" are supported.  Support for "insert
6681       effects" and "master effects" is planned to be added at a later
6682       point.
6683    
6684       The following commands allow to retrieve the set of internal effects
6685       available to the sampler, detailed informations about those effects
6686       and to create and destroy instances of such effects.  After an
6687       instance of an effect is created, the effect instance can be inserted
6688       into the audio signal path of the sampler, e.g. as send effect.
6689    
6690       The sampler allows to create an arbitrary amount of so called send
6691       effect chains.  Each effect chain can host an arbitrary amount of
6692       effect instances.  The output of the first effect instance in an
6693       effect chain is fed to the input of the second effect instance of the
6694       chain and so on.  So effects in one chain are processed sequentially.
6695       Send effect chains however are processed in parallel to other send
6696       effect chains.  Audio signals of sampler channels are fed to send
6697       effects by creating FX sends to the respective sampler channel and
6698       assigning a destination send effect to that FX by using the "SET
6699       FX_SEND EFFECT" (Section 6.4.32) command.  The latter allows to route
6700       the FX send to the beginning of a send effect chain, as well as
6701       directly to any other position of the send effect chain.
6702    
6703    6.11.1.  Retrieve amount of available effects
6704    
6705       The front-end can retrieve the amount of internal effects, available
6706       to the sampler by sending the following command:
6707    
6708          GET AVAILABLE_EFFECTS
6709    
6710       Possible Answers:
6711    
6712          The sampler will answer by returning the current number of effects
6713          available to the sampler.
6714    
6715       Examples:
6716    
6717    
6718    
6719    Schoenebeck             Expires December 26, 2011             [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol            June 2011
6722    
6723    
6724          C: "GET AVAILABLE_EFFECTS"
6725    
6726          S: "129"
6727    
6728    6.11.2.  Get list of available effects
6729    
6730       The set of available internal effects can change at runtime.  The
6731       front-end can retrieve the list of internal effects, available to the
6732       sampler by sending the following command:
6733    
6734          LIST AVAILABLE_EFFECTS
6735    
6736       Possible Answers:
6737    
6738          The sampler will answer by returning a comma separated list with
6739          numerical IDs of effects.  Note: the numercial ID of an effect is
6740          generated by the sampler for the current moment.  The numerical ID
6741          of the same effect can change at runtime, e.g. when the user
6742          requests a rescan of available effect plugins.
6743    
6744       Example:
6745    
6746          C: "LIST AVAILABLE_EFFECTS"
6747    
6748          S: "5,6,7,120,121,122,123,124"
6749    
6750    6.11.3.  Retrieving general information about an effect
6751    
6752       The front-end can ask for general informations about an effect by
6753       sending the following command:
6754    
6755          GET EFFECT INFO <effect-index>
6756    
6757       Where <effect-index> is the numerical ID of an effect as returned by
6758       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
6759    
6760       Possible Answers:
6761    
6762          LinuxSampler will answer by sending a <CRLF> separated list.  Each
6763          answer line begins with the effect information category name,
6764          followed by a colon and then a space character <SP> and finally
6765          the info character string to that effect information category.  At
6766          the moment the following categories are defined:
6767    
6768    
6769    
6770             SYSTEM -
6771    
6772    
6773    
6774    
6775    Schoenebeck             Expires December 26, 2011             [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol            June 2011
6778    
6779    
6780                name of the effect plugin system the effect is based on
6781                (e.g.  "LADSPA")
6782    
6783             MODULE -
6784    
6785                module of the effect plugin system that contains this
6786                effect, the module is usually the dynamic-linked library
6787                (DLL) filename of the effect plugin, including full path
6788                (note that this filename may contain escape sequences
6789                (Section 7.1))
6790    
6791             NAME -
6792    
6793                character string defining the unique name of the effect
6794                within its module (note that the character string may
6795                contain escape sequences (Section 7.1))
6796    
6797             DESCRIPTION -
6798    
6799                human readable name of the effect, intended to be displayed
6800                in user interfaces (note that the character string may
6801                contain escape sequences (Section 7.1))
6802    
6803       The mentioned fields above don't have to be in particular order.
6804    
6805       Example:
6806    
6807          C: "GET EFFECT INFO 121"
6808    
6809          S: "SYSTEM: LADSPA"
6810    
6811             "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"
6812    
6813             "NAME: lowpass_iir"
6814    
6815             "DESCRIPTION: Glame Lowpass Filter"
6816    
6817             "."
6818    
6819    6.11.4.  Creating an instance of an effect by its portable ID
6820    
6821       The front-end can spawn an instance of the desired effect by sending
6822       the following command:
6823    
6824          CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name>
6825    
6826       Where <effect-system> is the "SYSTEM" field, <module> the "MODULE"
6827       field and <effect-name> the "NAME" field as returned by the "GET
6828    
6829    
6830    
6831    Schoenebeck             Expires December 26, 2011             [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol            June 2011
6834    
6835    
6836       EFFECT INFO" (Section 6.11.3) command.  The filename of argument
6837       <module> and the character string of argument <effect-name> may
6838       contain escape sequences (Section 7.1).
6839    
6840       The sampler will try to load the requested effect and to create an
6841       instance of it.  To allow loading the same effect on a different
6842       machine, probably even running a completely different operating
6843       system (e.g.  Linux vs. Windows), the sampler tries to match <module>
6844       "softly".  That means it first tries to find an effect that exactly
6845       matches the given <module> argument.  If there is no exact match, the
6846       sampler will try to lower the restrictions on matching the <module>
6847       argument more and more, e.g. by ignoring upper / lower case
6848       differences and by ignoring the path of the DLL filename and file
6849       extension.  If there is still no match at the end, the sampler will
6850       try to ignore the <module> argument completely and as a last resort
6851       search for an effect that only matches the given <effect-system> and
6852       <effect-name> arguments.
6853    
6854       Possible Answers:
6855    
6856          "OK[<effect-instance>]" -
6857    
6858             in case the effect instance was successfully created, where
6859             <effect-instance> is the numerical ID of the new effect
6860             instance
6861    
6862          "WRN:<warning-code>:<warning-message>" -
6863    
6864             in case the effect instance was spawned successfully, but there
6865             are noteworthy issue(s) related, providing an appropriate
6866             warning code and warning message
6867    
6868          "ERR:<error-code>:<error-message>" -
6869    
6870             if the effect could not be instantiated
6871    
6872       Examples:
6873    
6874          C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/
6875          mod_delay_1419.so' 'modDelay'"
6876    
6877          S: "OK[0]"
6878    
6879    6.11.5.  Creating an instance of an effect by its numerical ID
6880    
6881       The front-end can spawn an instance of the desired effect by sending
6882       the following command:
6883    
6884    
6885    
6886    
6887    Schoenebeck             Expires December 26, 2011             [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol            June 2011
6890    
6891    
6892          CREATE EFFECT_INSTANCE <effect-index>
6893    
6894       Where <effect-index> is the numerical ID of the effect as returned by
6895       the "LIST AVAILABLE_EFFECTS" (Section 6.11.2) command.
6896    
6897       The sampler will try to load the requested effect and to create an
6898       instance of it.
6899    
6900       Note: Since the numerical ID of a certain effect can change at any
6901       time, you should not use this command in LSCP files to restore a
6902       certain effect at a later time!  To store a sampler session including
6903       all its effects, use the portable text-based version of "CREATE
6904       EFFECT_INSTANCE" (Section 6.11.4) instead!  This allows to restore a
6905       sampler session with all its effects also on other machines, possibly
6906       even running a completely different operating system (e.g.  Linux vs.
6907       Windows), with different plugin directories or plugin DLL names.
6908    
6909       Possible Answers:
6910    
6911          "OK[<effect-instance>]" -
6912    
6913             in case the effect instance was successfully created, where
6914             <effect-instance> is the numerical ID of the new effect
6915             instance
6916    
6917          "WRN:<warning-code>:<warning-message>" -
6918    
6919             in case the effect instance was spawned successfully, but there
6920             are noteworthy issue(s) related, providing an appropriate
6921             warning code and warning message
6922    
6923          "ERR:<error-code>:<error-message>" -
6924    
6925             if the effect could not be instantiated
6926    
6927       Examples:
6928    
6929          C: "CREATE EFFECT_INSTANCE 72"
6930    
6931          S: "OK[5]"
6932    
6933    6.11.6.  Destroy an effect instance
6934    
6935       The front-end can destroy an unusued effect instance and thus freeing
6936       it from memory by sending the following command:
6937    
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck             Expires December 26, 2011             [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol            June 2011
6946    
6947    
6948          DESTROY EFFECT_INSTANCE <effect-instance>
6949    
6950       Where <effect-instance> is the numerical ID of the effect instance as
6951       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
6952       EFFECT_INSTANCES" (Section 6.11.8) command.
6953    
6954       The effect instance can only be destroyed if it's not used in any
6955       part of the sampler's audio signal path anymore.  If the effect
6956       instance is still in use somewhere, trying to destroy the effect
6957       instance will result in an error message.
6958    
6959       Possible Answers:
6960    
6961          "OK" -
6962    
6963             in case the effect instance was successfully destroyed
6964    
6965          "ERR:<error-code>:<error-message>" -
6966    
6967             in case it failed, providing an appropriate error code and
6968             error message
6969    
6970       Examples:
6971    
6972          C: "DESTROY EFFECT_INSTANCE 5"
6973    
6974          S: "OK"
6975    
6976    6.11.7.  Retrieve amount of effect instances
6977    
6978       The front-end can retrieve the current amount of effect instances by
6979       sending the following command:
6980    
6981          GET EFFECT_INSTANCES
6982    
6983       Possible Answers:
6984    
6985          The sampler will answer by returning the current number of effect
6986          instances created and not yet destroyed in the current sampler
6987          session.
6988    
6989       Examples:
6990    
6991          C: "GET EFFECT_INSTANCES"
6992    
6993          S: "14"
6994    
6995    
6996    
6997    
6998    
6999    Schoenebeck             Expires December 26, 2011             [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol            June 2011
7002    
7003    
7004    6.11.8.  Get list of effect instances
7005    
7006       The front-end can retrieve the current list of effect instances by
7007       sending the following command:
7008    
7009          LIST EFFECT_INSTANCES
7010    
7011       Possible Answers:
7012    
7013          The sampler will answer by returning a comma separated list with
7014          numerical IDs of effects instances.
7015    
7016       Example:
7017    
7018          C: "LIST EFFECT_INSTANCES"
7019    
7020          S: "9,11,14,15,16,17,25"
7021    
7022    6.11.9.  Retrieving current information about an effect instance
7023    
7024       The front-end can ask for the current informations about a particular
7025       effect instance by sending the following command:
7026    
7027          GET EFFECT_INSTANCE INFO <effect-instance>
7028    
7029       Where <effect-instance> is the numerical ID of an effect instance as
7030       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7031       EFFECT_INSTANCES" (Section 6.11.8) command.
7032    
7033       Possible Answers:
7034    
7035          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7036          answer line begins with the information category name, followed by
7037          a colon and then a space character <SP> and finally the info
7038          character string to that information category.  At the moment the
7039          following categories are defined:
7040    
7041    
7042    
7043             SYSTEM -
7044    
7045                name of the effect plugin system the effect is based on
7046                (e.g.  "LADSPA")
7047    
7048             MODULE -
7049    
7050                module of the effect plugin system that contains this
7051                effect, the module is usually the dynamic-linked library
7052    
7053    
7054    
7055    Schoenebeck             Expires December 26, 2011             [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol            June 2011
7058    
7059    
7060                (DLL) filename of the effect plugin, including full path
7061                (note that this filename may contain escape sequences
7062                (Section 7.1))
7063    
7064             NAME -
7065    
7066                character string defining the unique name of the effect
7067                within its module (note that the character string may
7068                contain escape sequences (Section 7.1))
7069    
7070             DESCRIPTION -
7071    
7072                human readable name of the effect, intended to be displayed
7073                in user interfaces (note that the character string may
7074                contain escape sequences (Section 7.1))
7075    
7076             INPUT_CONTROLS -
7077    
7078                amount of input controls the effect instance provides, to
7079                allow controlling the effect parameters in realtime
7080    
7081       The mentioned fields above don't have to be in particular order.
7082    
7083       Example:
7084    
7085          C: "GET EFFECT_INSTANCE INFO 3"
7086    
7087          S: "SYSTEM: LADSPA"
7088    
7089             "MODULE: /usr/lib/ladspa/mod_delay_1419.so"
7090    
7091             "NAME: modDelay"
7092    
7093             "DESCRIPTION: Modulatable delay"
7094    
7095             "INPUT_CONTROLS: 1"
7096    
7097             "."
7098    
7099    6.11.10.  Retrieving information about an effect parameter
7100    
7101       Effects typically provide a certain set of effect parameters which
7102       can be altered by the user in realtime (e.g. depth of a reverb
7103       effect, duration of a delay effect, dry / wet signal ratio).  Those
7104       controllable effect parameters are called "input controls".  The
7105       front-end can ask for the current informations of an effect
7106       instance's input control by sending the following command:
7107    
7108    
7109    
7110    
7111    Schoenebeck             Expires December 26, 2011             [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol            June 2011
7114    
7115    
7116          GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-
7117          control>
7118    
7119       Where <effect-instance> is the numerical ID of an effect instance as
7120       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7121       EFFECT_INSTANCES" (Section 6.11.8) command and <input-control> is the
7122       index of the input control within the numerical bounds as returned by
7123       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7124       (Section 6.11.9) command.
7125    
7126       Possible Answers:
7127    
7128          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7129          answer line begins with the information category name, followed by
7130          a colon and then a space character <SP> and finally the info
7131          character string to that information category.  There are
7132          information categories which are always returned, independent of
7133          the respective effect parameter and there are optional information
7134          categories which are only shown for certain effect parameters.  At
7135          the moment the following categories are defined:
7136    
7137    
7138    
7139             DESCRIPTION -
7140    
7141                (always returned) human readable name of the effect
7142                parameter, intended to be displayed in user interfaces (note
7143                that the character string may contain escape sequences
7144                (Section 7.1))
7145    
7146             VALUE -
7147    
7148                (always returned) current (optional dotted) floating point
7149                value of this effect parameter
7150    
7151             RANGE_MIN -
7152    
7153                (optionally returned) minimum allowed value for this effect
7154                parameter
7155    
7156             RANGE_MAX -
7157    
7158                (optionally returned) maximum allowed value for this effect
7159                parameter
7160    
7161             POSSIBILITIES -
7162    
7163    
7164    
7165    
7166    
7167    Schoenebeck             Expires December 26, 2011             [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol            June 2011
7170    
7171    
7172                (optionally returned) comma separated list of (optional
7173                dotted) floating point numbers, reflecting the exact set of
7174                possible values for this effect parameter
7175    
7176             DEFAULT -
7177    
7178                (optionally returned) default value of this effect parameter
7179    
7180       The mentioned fields above don't have to be in particular order.
7181    
7182       Example:
7183    
7184          C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"
7185    
7186          S: "DESCRIPTION: Base delay (s)"
7187    
7188             "VALUE: 0.500"
7189    
7190             "RANGE_MIN: 0.000"
7191    
7192             "."
7193    
7194    6.11.11.  Altering an effect parameter
7195    
7196       The front-end can alter the current value of an effect parameter by
7197       sending the following command:
7198    
7199          SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-
7200          control> <value>
7201    
7202       Where <effect-instance> is the numerical ID of the effect instance as
7203       returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7204       EFFECT_INSTANCES" (Section 6.11.8) command, <input-control> is the
7205       index of the input control within the numerical bounds as returned by
7206       the "INPUT_CONTROLS" field of the "GET EFFECT_INSTANCE INFO"
7207       (Section 6.11.9) command and <value> is the new (optional dotted)
7208       floating point value for this effect parameter.
7209    
7210       Possible Answers:
7211    
7212          "OK" -
7213    
7214             in case the effect was altered successfully
7215    
7216          "ERR:<error-code>:<error-message>" -
7217    
7218             in case it failed, providing an appropriate error code and
7219             error message
7220    
7221    
7222    
7223    Schoenebeck             Expires December 26, 2011             [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol            June 2011
7226    
7227    
7228       Examples:
7229    
7230          C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"
7231    
7232          S: "OK"
7233    
7234    6.11.12.  Retrieve amount of send effect chains
7235    
7236       The front-end can retrieve the current amount of send effect chains
7237       of an audio output device by sending the following command:
7238    
7239          GET SEND_EFFECT_CHAINS <audio-device>
7240    
7241       Where <audio-device> should be replaced by the numerical ID of the
7242       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7243       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7244       command.
7245    
7246       Possible Answers:
7247    
7248          The sampler will answer by returning the current number of send
7249          effect chains of the supplied audio output device.
7250    
7251       Examples:
7252    
7253          C: "GET SEND_EFFECT_CHAINS 0"
7254    
7255          S: "4"
7256    
7257    6.11.13.  Retrieve list of send effect chains
7258    
7259       The front-end can retrieve the current list of send effect chains of
7260       an audio output device by sending the following command:
7261    
7262          LIST SEND_EFFECT_CHAINS <audio-device>
7263    
7264       Where <audio-device> should be replaced by the numerical ID of the
7265       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7266       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7267       command.
7268    
7269       Possible Answers:
7270    
7271          The sampler will answer by returning a comma separated list with
7272          numerical IDs of send effect chains of the supplied audio output
7273          device.
7274    
7275       Examples:
7276    
7277    
7278    
7279    Schoenebeck             Expires December 26, 2011             [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol            June 2011
7282    
7283    
7284          C: "LIST SEND_EFFECT_CHAINS 0"
7285    
7286          S: "3,4,7"
7287    
7288    6.11.14.  Add send effect chain
7289    
7290       The front-end can add a send effect chain by sending the following
7291       command:
7292    
7293          ADD SEND_EFFECT_CHAIN <audio-device>
7294    
7295       Where <audio-device> should be replaced by the numerical ID of the
7296       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7297       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7298       command.
7299    
7300       Possible Answers:
7301    
7302          "OK[<effect-chain>]" -
7303    
7304             in case the send effect chain was added successfully, where
7305             <effect-chain> is the numerical ID of the new send effect chain
7306    
7307          "ERR:<error-code>:<error-message>" -
7308    
7309             if the send effect chain could not be added
7310    
7311       Examples:
7312    
7313          C: "ADD SEND_EFFECT_CHAIN 0"
7314    
7315          S: "OK[2]"
7316    
7317    6.11.15.  Remove send effect chain
7318    
7319       The front-end can remove a send effect chain by sending the following
7320       command:
7321    
7322          REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain>
7323    
7324       Where <audio-device> should be replaced by the numerical ID of the
7325       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7326       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7327       command and <effect-chain> by the numerical ID as returned by the
7328       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7329       SEND_EFFECT_CHAINS" (Section 6.11.13) command.
7330    
7331       Possible Answers:
7332    
7333    
7334    
7335    Schoenebeck             Expires December 26, 2011             [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol            June 2011
7338    
7339    
7340          "OK" -
7341    
7342             in case the send effect chain was removed successfully
7343    
7344          "ERR:<error-code>:<error-message>" -
7345    
7346             if the send effect chain could not be removed
7347    
7348       Examples:
7349    
7350          C: "REMOVE SEND_EFFECT_CHAIN 0 2"
7351    
7352          S: "OK"
7353    
7354    6.11.16.  Retrieving information about a send effect chain
7355    
7356       The front-end can ask for informations of a send effect chain by
7357       sending the following command:
7358    
7359          GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain>
7360    
7361       Where <audio-device> should be replaced by the numerical ID of the
7362       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7363       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7364       command and <effect-chain> by the numerical ID as returned by the
7365       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7366       SEND_EFFECT_CHAINS" (Section 6.11.13) command.
7367    
7368       Possible Answers:
7369    
7370          LinuxSampler will answer by sending a <CRLF> separated list.  Each
7371          answer line begins with the information category name, followed by
7372          a colon and then a space character <SP> and finally the info
7373          character string to that information category.  At the moment the
7374          following categories are defined:
7375    
7376    
7377    
7378             EFFECT_COUNT -
7379    
7380                amount of effects in this send effect chain
7381    
7382             EFFECT_SEQUENCE -
7383    
7384                comma separated list of the numerical IDs of the effect
7385                instances in this send effect chain, in the order as they
7386                are procssed in the effect chain
7387    
7388    
7389    
7390    
7391    Schoenebeck             Expires December 26, 2011             [Page 132]
7392    
7393    Internet-Draft        LinuxSampler Control Protocol            June 2011
7394    
7395    
7396       The mentioned fields above don't have to be in particular order.
7397    
7398       Example:
7399    
7400          C: "GET SEND_EFFECT_CHAIN INFO 0 2"
7401    
7402          S: "EFFECT_COUNT: 3"
7403    
7404             "EFFECT_SEQUENCE: 31,4,7"
7405    
7406             "."
7407    
7408    6.11.17.  Append effect instance to a send effect chain
7409    
7410       The front-end can add an unused effect instance to the end of a send
7411       effect chain by sending the following command:
7412    
7413          APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7414          <effect-instance>
7415    
7416       Where <audio-device> should be replaced by the numerical ID of the
7417       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7418       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7419       command and <effect-chain> by the numerical ID as returned by the
7420       "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
7421       SEND_EFFECT_CHAINS" (Section 6.11.13) command and <effect-instance>
7422       as returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
7423       EFFECT_INSTANCES" (Section 6.11.8) command.
7424    
7425       Only unused effect instances can be added to the effect chain.
7426       Trying to add an effect instance which is already in use somewhere in
7427       the audio signal path of the sampler will result in an error.
7428    
7429       Possible Answers:
7430    
7431          "OK" -
7432    
7433             in case the effect instance was added successfully to the chain
7434    
7435          "ERR:<error-code>:<error-message>" -
7436    
7437             if the effect instance could not be added
7438    
7439       Examples:
7440    
7441          C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"
7442    
7443    
7444    
7445    
7446    
7447    Schoenebeck             Expires December 26, 2011             [Page 133]
7448    
7449    Internet-Draft        LinuxSampler Control Protocol            June 2011
7450    
7451    
7452          S: "OK"
7453    
7454    6.11.18.  Insert effect instance to a send effect chain
7455    
7456       The front-end can add an unused effect instance to a certain position
7457       of a send effect chain by sending the following command:
7458    
7459          INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7460          <chain-pos> <effect-instance>
7461    
7462       Where <audio-device> should be replaced by the numerical ID of the
7463       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7464       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7465       command, <effect-chain> by the numerical ID as returned by the "ADD
7466       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7467       (Section 6.11.13) command, <effect-instance> as returned by the
7468       "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST EFFECT_INSTANCES"
7469       (Section 6.11.8) command and <chain-pos> the exact position of the
7470       effect chain where the supplied effect shall be inserted to.
7471    
7472       Only unused effect instances can be added to the effect chain.
7473       Trying to add an effect instance which is already in use somewhere in
7474       the audio signal path of the sampler will result in an error.
7475    
7476       Possible Answers:
7477    
7478          "OK" -
7479    
7480             in case the effect instance was added successfully to the chain
7481    
7482          "ERR:<error-code>:<error-message>" -
7483    
7484             if the effect instance could not be added
7485    
7486       Examples:
7487    
7488          C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"
7489    
7490          S: "OK"
7491    
7492    6.11.19.  Remove effect instance from send effect chain
7493    
7494       The front-end can remove an effect instance from a certain position
7495       of a send effect chain by sending the following command:
7496    
7497          REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain>
7498          <chain-pos>
7499    
7500    
7501    
7502    
7503    Schoenebeck             Expires December 26, 2011             [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol            June 2011
7506    
7507    
7508       Where <audio-device> should be replaced by the numerical ID of the
7509       audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7510       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7511       command, <effect-chain> by the numerical ID as returned by the "ADD
7512       SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7513       (Section 6.11.13) command and <chain-pos> the exact position of the
7514       effect instance to be removed from the effect chain.
7515    
7516       Possible Answers:
7517    
7518          "OK" -
7519    
7520             in case the effect instance was removed successfully
7521    
7522          "ERR:<error-code>:<error-message>" -
7523    
7524             if the effect instance could not be removed
7525    
7526       Examples:
7527    
7528          C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"
7529    
7530          S: "OK"
7531    
7532    
7533    
7534    
7535    
7536    
7537    
7538    
7539    
7540    
7541    
7542    
7543    
7544    
7545    
7546    
7547    
7548    
7549    
7550    
7551    
7552    
7553    
7554    
7555    
7556    
7557    
7558    
7559    Schoenebeck             Expires December 26, 2011             [Page 135]
7560    
7561    Internet-Draft        LinuxSampler Control Protocol            June 2011
7562    
7563    
7564  7.  Command Syntax  7.  Command Syntax
# Line 5540  Internet-Draft        LinuxSampler Contr Line 7612  Internet-Draft        LinuxSampler Contr
7612    
7613    
7614    
7615  Schoenebeck             Expires October 18, 2007               [Page 99]  Schoenebeck             Expires December 26, 2011             [Page 136]
7616    
7617  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
7618    
7619    
7620        / LIST SP list_instruction        / LIST SP list_instruction
# Line 5561  Internet-Draft        LinuxSampler Contr Line 7633  Internet-Draft        LinuxSampler Contr
7633    
7634        / CLEAR SP clear_instruction        / CLEAR SP clear_instruction
7635    
7636          / FIND SP find_instruction
7637    
7638        / MOVE SP move_instruction        / MOVE SP move_instruction
7639    
7640          / COPY SP copy_instruction
7641    
7642          / EDIT SP edit_instruction
7643    
7644          / FORMAT SP format_instruction
7645    
7646          / SEND SP send_instruction
7647    
7648          / APPEND SP append_instruction
7649    
7650          / INSERT SP insert_instruction
7651    
7652        / RESET        / RESET
7653    
7654        / QUIT        / QUIT
# Line 5571  Internet-Draft        LinuxSampler Contr Line 7657  Internet-Draft        LinuxSampler Contr
7657    
7658        CHANNEL        CHANNEL
7659    
7660        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
7661    
7662          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
7663    
7664          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP
7665          db_path SP filename
7666    
       / DB_INSTRUMENTS SP FLAT SP pathname SP pathname  
7667    
       / DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname  
7668    
       / DB_INSTRUMENTS SP pathname SP pathname  
7669    
7670        / DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  
7671    Schoenebeck             Expires December 26, 2011             [Page 137]
7672    
7673    Internet-Draft        LinuxSampler Control Protocol            June 2011
7674    
7675    
7676          / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
7677    
7678          / DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP
7679          filename
7680    
7681          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
7682    
7683          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
7684          instrument_index
7685    
7686          / DB_INSTRUMENTS SP db_path SP filename
7687    
7688          / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
7689    
7690        / MIDI_INSTRUMENT_MAP        / MIDI_INSTRUMENT_MAP
7691    
7692        / MIDI_INSTRUMENT_MAP SP map_name        / MIDI_INSTRUMENT_MAP SP map_name
7693    
7694          / SEND_EFFECT_CHAIN SP device_index
7695    
7696     subscribe_event =     subscribe_event =
7697    
7698        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
# Line 5593  Internet-Draft        LinuxSampler Contr Line 7701  Internet-Draft        LinuxSampler Contr
7701    
7702        / MIDI_INPUT_DEVICE_COUNT        / MIDI_INPUT_DEVICE_COUNT
7703    
   
   
   
 Schoenebeck             Expires October 18, 2007              [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
7704        / MIDI_INPUT_DEVICE_INFO        / MIDI_INPUT_DEVICE_INFO
7705    
7706        / CHANNEL_COUNT        / CHANNEL_COUNT
7707    
7708          / CHANNEL_MIDI
7709    
7710          / DEVICE_MIDI
7711    
7712        / VOICE_COUNT        / VOICE_COUNT
7713    
7714        / STREAM_COUNT        / STREAM_COUNT
# Line 5617  Internet-Draft        LinuxSampler Contr Line 7721  Internet-Draft        LinuxSampler Contr
7721    
7722        / FX_SEND_INFO        / FX_SEND_INFO
7723    
7724    
7725    
7726    
7727    Schoenebeck             Expires December 26, 2011             [Page 138]
7728    
7729    Internet-Draft        LinuxSampler Control Protocol            June 2011
7730    
7731    
7732        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
7733    
7734        / MIDI_INSTRUMENT_MAP_INFO        / MIDI_INSTRUMENT_MAP_INFO
# Line 5633  Internet-Draft        LinuxSampler Contr Line 7745  Internet-Draft        LinuxSampler Contr
7745    
7746        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
7747    
7748          / DB_INSTRUMENTS_JOB_INFO
7749    
7750        / MISCELLANEOUS        / MISCELLANEOUS
7751    
7752          / TOTAL_STREAM_COUNT
7753    
7754        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
7755    
7756        / GLOBAL_INFO        / GLOBAL_INFO
7757    
7758          / EFFECT_INSTANCE_COUNT
7759    
7760          / EFFECT_INSTANCE_INFO
7761    
7762          / SEND_EFFECT_CHAIN_COUNT
7763    
7764          / SEND_EFFECT_CHAIN_INFO
7765    
7766     unsubscribe_event =     unsubscribe_event =
7767    
7768        AUDIO_OUTPUT_DEVICE_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
# Line 5649  Internet-Draft        LinuxSampler Contr Line 7773  Internet-Draft        LinuxSampler Contr
7773    
7774        / MIDI_INPUT_DEVICE_INFO        / MIDI_INPUT_DEVICE_INFO
7775    
7776          / CHANNEL_COUNT
7777    
7778          / CHANNEL_MIDI
7779    
7780    
7781    
7782  Schoenebeck             Expires October 18, 2007              [Page 101]  
7783    Schoenebeck             Expires December 26, 2011             [Page 139]
7784    
7785  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
7786    
7787    
7788        / CHANNEL_COUNT        / DEVICE_MIDI
7789    
7790        / VOICE_COUNT        / VOICE_COUNT
7791    
# Line 5687  Internet-Draft        LinuxSampler Contr Line 7815  Internet-Draft        LinuxSampler Contr
7815    
7816        / DB_INSTRUMENT_INFO        / DB_INSTRUMENT_INFO
7817    
7818          / DB_INSTRUMENTS_JOB_INFO
7819    
7820        / MISCELLANEOUS        / MISCELLANEOUS
7821    
7822          / TOTAL_STREAM_COUNT
7823    
7824        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
7825    
7826        / GLOBAL_INFO        / GLOBAL_INFO
7827    
7828          / EFFECT_INSTANCE_COUNT
7829    
7830          / EFFECT_INSTANCE_INFO
7831    
7832          / SEND_EFFECT_CHAIN_COUNT
7833    
7834          / SEND_EFFECT_CHAIN_INFO
7835    
7836    
7837    
7838    
7839    Schoenebeck             Expires December 26, 2011             [Page 140]
7840    
7841    Internet-Draft        LinuxSampler Control Protocol            June 2011
7842    
7843    
7844     map_instruction =     map_instruction =
7845    
7846        MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP        MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
# Line 5706  Internet-Draft        LinuxSampler Contr Line 7854  Internet-Draft        LinuxSampler Contr
7854        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
7855        entry_name        entry_name
7856    
   
   
 Schoenebeck             Expires October 18, 2007              [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
7857        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
7858        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
7859        instr_load_mode SP entry_name        instr_load_mode SP entry_name
# Line 5729  Internet-Draft        LinuxSampler Contr Line 7870  Internet-Draft        LinuxSampler Contr
7870    
7871        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
7872    
7873        / DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname        / SEND_EFFECT_CHAIN SP device_index SP effect_chain
7874    
7875          / SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
7876          chain_pos
7877    
7878          / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
7879    
7880        / DB_INSTRUMENT_DIRECTORY SP pathname        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
7881    
7882        / DB_INSTRUMENT SP pathname        / DB_INSTRUMENT_DIRECTORY SP db_path
7883    
7884          / DB_INSTRUMENT SP db_path
7885    
7886     get_instruction =     get_instruction =
7887    
7888        AVAILABLE_ENGINES        AVAILABLE_ENGINES
7889    
7890          / AVAILABLE_EFFECTS
7891    
7892    
7893    
7894    
7895    Schoenebeck             Expires December 26, 2011             [Page 141]
7896    
7897    Internet-Draft        LinuxSampler Control Protocol            June 2011
7898    
7899    
7900          / EFFECT_INSTANCES
7901    
7902          / EFFECT SP INFO SP effect_index
7903    
7904          / EFFECT_INSTANCE SP INFO SP effect_instance
7905    
7906          / EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP
7907          input_control
7908    
7909          / SEND_EFFECT_CHAINS SP device_index
7910    
7911          / SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
7912    
7913        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
7914    
7915        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
# Line 5761  Internet-Draft        LinuxSampler Contr Line 7932  Internet-Draft        LinuxSampler Contr
7932    
7933        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
7934    
   
   
   
 Schoenebeck             Expires October 18, 2007              [Page 103]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
7935        / AUDIO_OUTPUT_DEVICE SP INFO SP number        / AUDIO_OUTPUT_DEVICE SP INFO SP number
7936    
7937        / MIDI_INPUT_DEVICE SP INFO SP number        / MIDI_INPUT_DEVICE SP INFO SP number
# Line 5782  Internet-Draft        LinuxSampler Contr Line 7945  Internet-Draft        LinuxSampler Contr
7945        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
7946        string        string
7947    
7948    
7949    
7950    
7951    Schoenebeck             Expires December 26, 2011             [Page 142]
7952    
7953    Internet-Draft        LinuxSampler Control Protocol            June 2011
7954    
7955    
7956        / CHANNELS        / CHANNELS
7957    
7958        / CHANNEL SP INFO SP sampler_channel        / CHANNEL SP INFO SP sampler_channel
# Line 5796  Internet-Draft        LinuxSampler Contr Line 7967  Internet-Draft        LinuxSampler Contr
7967    
7968        / SERVER SP INFO        / SERVER SP INFO
7969    
7970          / TOTAL_STREAM_COUNT
7971    
7972        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
7973    
7974        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
# Line 5814  Internet-Draft        LinuxSampler Contr Line 7987  Internet-Draft        LinuxSampler Contr
7987    
7988        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / FX_SEND SP INFO SP sampler_channel SP fx_send_id
7989    
7990        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
7991    
7992          / DB_INSTRUMENT_DIRECTORIES SP db_path
7993    
7994          / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
7995    
7996          / DB_INSTRUMENTS SP RECURSIVE SP db_path
7997    
7998          / DB_INSTRUMENTS SP db_path
7999    
8000  Schoenebeck             Expires October 18, 2007              [Page 104]        / DB_INSTRUMENT SP INFO SP db_path
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
8001    
8002          / DB_INSTRUMENTS_JOB SP INFO SP number
8003    
       / DB_INSTRUMENT_DIRECTORY SP INFO SP pathname  
8004    
       / DB_INSTRUMENTS SP pathname  
8005    
8006        / DB_INSTRUMENT SP INFO SP pathname  
8007    Schoenebeck             Expires December 26, 2011             [Page 143]
8008    
8009    Internet-Draft        LinuxSampler Control Protocol            June 2011
8010    
8011    
8012        / VOLUME        / VOLUME
8013    
8014          / VOICES
8015    
8016          / STREAMS
8017    
8018          / FILE SP INSTRUMENTS SP filename
8019    
8020          / FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
8021    
8022     set_instruction =     set_instruction =
8023    
8024        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
# Line 5844  Internet-Draft        LinuxSampler Contr Line 8030  Internet-Draft        LinuxSampler Contr
8030        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
8031        param_val_list        param_val_list
8032    
8033          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
8034    
8035        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
8036        param_val_list        param_val_list
8037    
8038          / EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP
8039          input_control SP control_value
8040    
8041        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
8042    
8043        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name        / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
# Line 5862  Internet-Draft        LinuxSampler Contr Line 8053  Internet-Draft        LinuxSampler Contr
8053        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
8054        volume_value        volume_value
8055    
8056        / DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname        / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP
8057          effect_chain SP chain_pos
8058    
       / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval  
8059    
       / DB_INSTRUMENT SP NAME SP pathname SP dirname  
8060    
       / DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval  
8061    
       / ECHO SP boolean  
8062    
8063    Schoenebeck             Expires December 26, 2011             [Page 144]
8064    
8065    Internet-Draft        LinuxSampler Control Protocol            June 2011
8066    
8067    
8068          / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
8069    
8070          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
8071          stringval_escaped
8072    
8073  Schoenebeck             Expires October 18, 2007              [Page 105]        / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
8074    
8075          / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
8076    
8077          / DB_INSTRUMENT SP FILE_PATH SP filename SP filename
8078    
8079          / ECHO SP boolean
8080    
8081        / VOLUME SP volume_value        / VOLUME SP volume_value
8082    
8083          / VOICES SP number
8084    
8085          / STREAMS SP number
8086    
8087     create_instruction =     create_instruction =
8088    
8089        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 5897  Internet-Draft        LinuxSampler Contr Line 8098  Internet-Draft        LinuxSampler Contr
8098    
8099        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
8100    
8101          / EFFECT_INSTANCE SP effect_index
8102    
8103          / EFFECT_INSTANCE SP effect_system SP module SP effect_name
8104    
8105     reset_instruction =     reset_instruction =
8106    
8107        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
# Line 5907  Internet-Draft        LinuxSampler Contr Line 8112  Internet-Draft        LinuxSampler Contr
8112    
8113        / MIDI_INSTRUMENTS SP ALL        / MIDI_INSTRUMENTS SP ALL
8114    
8115       find_instruction =
8116    
8117    
8118    
8119    Schoenebeck             Expires December 26, 2011             [Page 145]
8120    
8121    Internet-Draft        LinuxSampler Control Protocol            June 2011
8122    
8123    
8124          DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
8125    
8126          / DB_INSTRUMENTS SP db_path SP query_val_list
8127    
8128          / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
8129          query_val_list
8130    
8131          / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
8132    
8133          / LOST SP DB_INSTRUMENT_FILES
8134    
8135     move_instruction =     move_instruction =
8136    
8137        DB_INSTRUMENT_DIRECTORY SP pathname SP pathname        DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8138    
8139          / DB_INSTRUMENT SP db_path SP db_path
8140    
8141       copy_instruction =
8142    
8143          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8144    
8145        / DB_INSTRUMENT SP pathname SP pathname        / DB_INSTRUMENT SP db_path SP db_path
8146    
8147     destroy_instruction =     destroy_instruction =
8148    
# Line 5921  Internet-Draft        LinuxSampler Contr Line 8152  Internet-Draft        LinuxSampler Contr
8152    
8153        / FX_SEND SP sampler_channel SP fx_send_id        / FX_SEND SP sampler_channel SP fx_send_id
8154    
8155          / EFFECT_INSTANCE SP number
8156    
8157     load_instruction =     load_instruction =
8158    
8159        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
8160    
8161        / ENGINE SP load_engine_args        / ENGINE SP load_engine_args
8162    
8163     set_chan_instruction =     append_instruction =
8164    
8165          SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8166          effect_instance
8167    
8168       insert_instruction =
8169    
8170          SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8171          chain_pos SP effect_instance
8172    
8173    
8174    
8175  Schoenebeck             Expires October 18, 2007              [Page 106]  Schoenebeck             Expires December 26, 2011             [Page 146]
8176    
8177  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
8178    
8179    
8180       set_chan_instruction =
8181    
8182        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
8183    
8184        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
# Line 5968  Internet-Draft        LinuxSampler Contr Line 8210  Internet-Draft        LinuxSampler Contr
8210    
8211        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT        / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
8212    
8213       edit_instruction =
8214    
8215          CHANNEL SP INSTRUMENT SP sampler_channel
8216    
8217       format_instruction =
8218    
8219          INSTRUMENTS_DB
8220    
8221     modal_arg =     modal_arg =
8222    
8223        /* epsilon (empty argument) */        /* epsilon (empty argument) */
# Line 5976  Internet-Draft        LinuxSampler Contr Line 8226  Internet-Draft        LinuxSampler Contr
8226    
8227     key_val_list =     key_val_list =
8228    
       string '=' param_val_list  
   
       / key_val_list SP string '=' param_val_list  
   
    buffer_size_type =  
8229    
       BYTES  
8230    
8231    Schoenebeck             Expires December 26, 2011             [Page 147]
8232    
8233    Internet-Draft        LinuxSampler Control Protocol            June 2011
8234    
8235    
8236          string '=' param_val_list
8237    
8238          / key_val_list SP string '=' param_val_list
8239    
8240  Schoenebeck             Expires October 18, 2007              [Page 107]     buffer_size_type =
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
8241    
8242          BYTES
8243    
8244        / PERCENTAGE        / PERCENTAGE
8245    
# Line 6005  Internet-Draft        LinuxSampler Contr Line 8253  Internet-Draft        LinuxSampler Contr
8253    
8254        / AVAILABLE_ENGINES        / AVAILABLE_ENGINES
8255    
8256          / AVAILABLE_EFFECTS
8257    
8258          / EFFECT_INSTANCES
8259    
8260          / SEND_EFFECT_CHAINS SP number
8261    
8262        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
8263    
8264        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 6017  Internet-Draft        LinuxSampler Contr Line 8271  Internet-Draft        LinuxSampler Contr
8271    
8272        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
8273    
8274        / DB_INSTRUMENT_DIRECTORIES SP pathname        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
8275    
8276          / DB_INSTRUMENT_DIRECTORIES SP db_path
8277    
8278          / DB_INSTRUMENTS SP RECURSIVE SP db_path
8279    
8280          / DB_INSTRUMENTS SP db_path
8281    
8282          / FILE SP INSTRUMENTS SP filename
8283    
8284    
8285    
8286    
8287        / DB_INSTRUMENTS SP pathname  Schoenebeck             Expires December 26, 2011             [Page 148]
8288    
8289    Internet-Draft        LinuxSampler Control Protocol            June 2011
8290    
8291    
8292       send_instruction =
8293    
8294          CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP
8295          number
8296    
8297     load_instr_args =     load_instr_args =
8298    
# Line 6039  Internet-Draft        LinuxSampler Contr Line 8312  Internet-Draft        LinuxSampler Contr
8312    
8313        / PERSISTENT        / PERSISTENT
8314    
8315     device_index =     effect_instance =
   
   
8316    
8317          number
8318    
8319  Schoenebeck             Expires October 18, 2007              [Page 108]     device_index =
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
8320    
8321        number        number
8322    
# Line 6067  Internet-Draft        LinuxSampler Contr Line 8336  Internet-Draft        LinuxSampler Contr
8336    
8337        number        number
8338    
8339    
8340    
8341    
8342    
8343    Schoenebeck             Expires December 26, 2011             [Page 149]
8344    
8345    Internet-Draft        LinuxSampler Control Protocol            June 2011
8346    
8347    
8348        / ALL        / ALL
8349    
8350     midi_input_type_name =     midi_input_type_name =
# Line 6095  Internet-Draft        LinuxSampler Contr Line 8373  Internet-Draft        LinuxSampler Contr
8373    
8374        / number        / number
8375    
8376     sampler_channel =     control_value =
   
8377    
8378          real
8379    
8380       sampler_channel =
 Schoenebeck             Expires October 18, 2007              [Page 109]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
8381    
8382        number        number
8383    
# Line 6119  Internet-Draft        LinuxSampler Contr Line 8393  Internet-Draft        LinuxSampler Contr
8393    
8394        string        string
8395    
    pathname =  
8396    
       stringval  
8397    
    dirname =  
8398    
8399        stringval  Schoenebeck             Expires December 26, 2011             [Page 150]
8400    
8401    Internet-Draft        LinuxSampler Control Protocol            June 2011
8402    
8403    
8404     filename =     filename =
8405    
8406        stringval        path
8407    
8408       db_path =
8409    
8410          path
8411    
8412     map_name =     map_name =
8413    
8414        stringval        stringval_escaped
8415    
8416     entry_name =     entry_name =
8417    
8418        stringval        stringval_escaped
8419    
8420     fx_send_name =     fx_send_name =
8421    
8422        stringval        stringval_escaped
8423    
8424       effect_name =
8425    
8426          stringval_escaped
8427    
8428       effect_index =
8429    
8430          number
8431    
8432       effect_chain =
8433    
8434          number
8435    
8436       chain_pos =
8437    
8438          number
8439    
8440       input_control =
8441    
8442          number
8443    
8444     param_val_list =     param_val_list =
8445    
# Line 6151  Internet-Draft        LinuxSampler Contr Line 8449  Internet-Draft        LinuxSampler Contr
8449    
8450     param_val =     param_val =
8451    
       string  
   
8452    
8453    
8454    
8455  Schoenebeck             Expires October 18, 2007              [Page 110]  Schoenebeck             Expires December 26, 2011             [Page 151]
8456    
8457  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
8458    
8459    
8460          string
8461    
8462        / stringval        / stringval
8463    
8464        / number        / number
8465    
8466        / dotnum        / dotnum
8467    
8468       query_val_list =
8469    
8470          string '=' query_val
8471    
8472          / query_val_list SP string '=' query_val
8473    
8474       query_val =
8475    
8476          text_escaped
8477    
8478          / stringval_escaped
8479    
8480       scan_mode =
8481    
8482          RECURSIVE
8483    
8484          / NON_RECURSIVE
8485    
8486          / FLAT
8487    
8488       effect_system =
8489    
8490          string
8491    
8492       module =
8493    
8494          filename
8495    
8496    7.1.  Character Set and Escape Sequences
8497    
8498       Older versions of this protocol up to and including v1.1 only
8499       supported the standard ASCII character set (ASCII code 0 - 127)
8500       [RFC20], all younger versions of this protocol however support the
8501       Extended ASCII character set (ASCII code 0 - 255).  The same group of
8502       younger protocols also support escape sequences, but only for
8503       certain, explicitly declared parts of the protocol.  The supported
8504       escape sequences are defined as follows:
8505    
8506    
8507    
8508    
8509    
8510    
8511    Schoenebeck             Expires December 26, 2011             [Page 152]
8512    
8513    Internet-Draft        LinuxSampler Control Protocol            June 2011
8514    
8515    
8516       +------------------------+------------------------------------------+
8517       | ASCII Character        | Translated into (Name)                   |
8518       | Sequence               |                                          |
8519       +------------------------+------------------------------------------+
8520       | \n                     | new line                                 |
8521       |                        |                                          |
8522       | \r                     | carriage return                          |
8523       |                        |                                          |
8524       | \f                     | form feed                                |
8525       |                        |                                          |
8526       | \t                     | horizontal tab                           |
8527       |                        |                                          |
8528       | \v                     | vertical tab                             |
8529       |                        |                                          |
8530       | \'                     | apostrophe                               |
8531       |                        |                                          |
8532       | \"                     | quotation mark                           |
8533       |                        |                                          |
8534       | \\                     | backslash                                |
8535       |                        |                                          |
8536       | \OOO                   | three digit octal ASCII code of the      |
8537       |                        | character                                |
8538       |                        |                                          |
8539       | \xHH                   | two digit hex ASCII code of the          |
8540       |                        | character                                |
8541       +------------------------+------------------------------------------+
8542    
8543       Notice: due to the transition of certain parts of the protocol which
8544       now support escape sequences, a slight backward incompatibility to
8545       protocols version v1.1 and younger has been introduced.  The only
8546       difference is that in parts of the protocol where escape characters
8547       are now supported, a backslash characters MUST be escaped as well
8548       (that is as double backslash), whereas in the old versions a single
8549       backslash was sufficient.
8550    
8551       The following LSCP commands support escape sequences as part of their
8552       filename / path based arguments and / or may contain a filename /
8553       path with escape sequences in their response:
8554    
8555          "LOAD INSTRUMENT" (Section 6.4.1)
8556    
8557          "GET CHANNEL INFO" (Section 6.4.10)
8558    
8559          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
8560    
8561          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
8562    
8563    
8564    
8565    
8566    
8567    Schoenebeck             Expires December 26, 2011             [Page 153]
8568    
8569    Internet-Draft        LinuxSampler Control Protocol            June 2011
8570    
8571    
8572          "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
8573    
8574          "ADD DB_INSTRUMENTS" (Section 6.8.11)
8575    
8576          "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
8577    
8578          "REMOVE DB_INSTRUMENT" (Section 6.8.12)
8579    
8580          "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
8581    
8582          "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
8583    
8584          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
8585    
8586          "GET DB_INSTRUMENTS" (Section 6.8.13)
8587    
8588          "LIST DB_INSTRUMENTS" (Section 6.8.14)
8589    
8590          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
8591    
8592          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
8593    
8594          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
8595    
8596          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
8597    
8598          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
8599    
8600          "FIND DB_INSTRUMENTS" (Section 6.8.20)
8601    
8602          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
8603    
8604          "MOVE DB_INSTRUMENT" (Section 6.8.17)
8605    
8606          "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
8607    
8608          "COPY DB_INSTRUMENT" (Section 6.8.18)
8609    
8610          "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
8611    
8612          "FIND LOST DB_INSTRUMENT_FILES" (Section 6.8.23)
8613    
8614          "SET DB_INSTRUMENT FILE_PATH" (Section 6.8.24)
8615    
8616          "GET FILE INSTRUMENTS" (Section 6.10.1)
8617    
8618          "LIST FILE INSTRUMENTS" (Section 6.10.2)
8619    
8620    
8621    
8622    
8623    Schoenebeck             Expires December 26, 2011             [Page 154]
8624    
8625    Internet-Draft        LinuxSampler Control Protocol            June 2011
8626    
8627    
8628          "GET FILE INSTRUMENT INFO" (Section 6.10.3)
8629    
8630          "GET EFFECT INFO" (Section 6.11.3)
8631    
8632          "GET EFFECT_INSTANCE INFO" (Section 6.11.9)
8633    
8634          "CREATE EFFECT_INSTANCE" (Section 6.11.4)
8635    
8636       Note that the forward slash character ('/') has a special meaning in
8637       filename / path based arguments: it acts as separator of the nodes in
8638       the path, thus if a directory- or filename includes a forward slash
8639       (not intended as path node separator), you MUST escape that slash
8640       either with the respective hex escape sequence ("\x2f") or with the
8641       respective octal escape sequence ("\057").
8642    
8643       Note for Windows: file path arguments in LSCP are expected to use
8644       forward slashes as directory node separator similar to Unix based
8645       operating systems.  In contrast to Unix however a Windows typical
8646       drive character is expected to be prefixed to the path.  That is an
8647       original Windows file path like "D:\Sounds\My.gig" would become in
8648       LSCP: "D:/Sounds/My.gig".
8649    
8650       The following LSCP commands even support escape sequences as part of
8651       at least one of their text-based arguments (i.e. entity name,
8652       description) and / or may contain escape sequences in at least one of
8653       their text-based fields in their response:
8654    
8655          "GET SERVER INFO" (Section 6.6.5)
8656    
8657          "GET ENGINE INFO" (Section 6.4.9)
8658    
8659          "GET CHANNEL INFO" (Section 6.4.10)
8660    
8661          "CREATE FX_SEND" (Section 6.4.25)
8662    
8663          "GET FX_SEND INFO" (Section 6.4.29)
8664    
8665          "SET FX_SEND NAME" (Section 6.4.30)
8666    
8667          "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
8668    
8669          "GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5)
8670    
8671          "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
8672    
8673          "MAP MIDI_INSTRUMENT" (Section 6.7.7)
8674    
8675    
8676    
8677  Schoenebeck             Expires October 18, 2007              [Page 111]  
8678    
8679    Schoenebeck             Expires December 26, 2011             [Page 155]
8680    
8681  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
8682    
8683    
8684          "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
8685    
8686          "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
8687    
8688          "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
8689    
8690          "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
8691    
8692          "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
8693    
8694          "GET DB_INSTRUMENT INFO" (Section 6.8.15)
8695    
8696          "SET DB_INSTRUMENT NAME" (Section 6.8.16)
8697    
8698          "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
8699    
8700          "FIND DB_INSTRUMENTS" (Section 6.8.20)
8701    
8702          "GET EFFECT INFO" (Section 6.11.3)
8703    
8704          "GET EFFECT_INSTANCE INFO" (Section 6.11.9)
8705    
8706          "CREATE EFFECT_INSTANCE" (Section 6.11.4)
8707    
8708       Please note that these lists are manually maintained.  If you find a
8709       command that also supports escape sequences we forgot to mention
8710       here, please report it!
8711    
8712    
8713    
8714    
8715    
8716    
8717    
8718    
8719    
8720    
8721    
8722    
8723    
8724    
8725    
8726    
8727    
8728    
8729    
8730    
8731    
8732    
8733    
8734    
8735    Schoenebeck             Expires December 26, 2011             [Page 156]
8736    
8737    Internet-Draft        LinuxSampler Control Protocol            June 2011
8738    
8739    
8740  8.  Events  8.  Events
# Line 6268  Internet-Draft        LinuxSampler Contr Line 8788  Internet-Draft        LinuxSampler Contr
8788    
8789    
8790    
8791  Schoenebeck             Expires October 18, 2007              [Page 112]  Schoenebeck             Expires December 26, 2011             [Page 157]
8792    
8793  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
8794    
8795    
8796        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
# Line 6311  Internet-Draft        LinuxSampler Contr Line 8831  Internet-Draft        LinuxSampler Contr
8831     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
8832     channels.     channels.
8833    
8834  8.6.  Number of active voices changed  8.6.  MIDI data on a sampler channel arrived
8835    
8836     Client may want to be notified when the number of voices on the back-     Client may want to be notified when MIDI data arrive on sampler
8837     end changes by issuing the following command:     channels on back-end side, by issuing the following command:
8838    
8839          SUBSCRIBE CHANNEL_MIDI
8840    
8841       Server will start sending one of the the following notification
8842       messages:
8843    
       SUBSCRIBE VOICE_COUNT  
8844    
    Server will start sending the following notification messages:  
8845    
8846    
8847    Schoenebeck             Expires December 26, 2011             [Page 158]
8848    
8849    Internet-Draft        LinuxSampler Control Protocol            June 2011
8850    
8851    
8852          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"
8853    
8854          "NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"
8855    
8856       where <channel-id> will be replaced by the ID of the sampler channel
8857       where the MIDI data arrived. <note> and <velocity> are integer values
8858       in the range between 0 .. 127, reflecting the analog meaning of the
8859       MIDI specification.
8860    
8861       CAUTION: no guarantee whatsoever will be made that MIDI events are
8862       actually all delivered by this mechanism!  With other words: events
8863       could be lost at any time!  This restriction was made to keep the RT-
8864       safeness of the backend's MIDI and audio thread unaffected by this
8865       feature.
8866    
8867  Schoenebeck             Expires October 18, 2007              [Page 113]  8.7.  MIDI data on a MIDI input device arrived
8868    
8869       Client may want to be notified when MIDI data arrive on MIDI input
8870       devices by issuing the following command:
8871    
8872          SUBSCRIBE DEVICE_MIDI
8873    
8874       Server will start sending one of the the following notification
8875       messages:
8876    
8877          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note>
8878          <velocity>"
8879    
8880          "NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note>
8881          <velocity>"
8882    
8883       where <device-id> <port-id> will be replaced by the IDs of the
8884       respective MIDI input device and the device's MIDI port where the
8885       MIDI data arrived. <note> and <velocity> are integer values in the
8886       range between 0 .. 127, reflecting the analog meaning of the MIDI
8887       specification.
8888    
8889       CAUTION: no guarantee whatsoever will be made that MIDI events are
8890       actually all delivered by this mechanism!  With other words: events
8891       could be lost at any time!  This restriction was made to keep the RT-
8892       safeness of the backend's MIDI and audio thread unaffected by this
8893       feature.
8894    
8895    8.8.  Number of active voices changed
8896    
8897       Client may want to be notified when the number of voices on the back-
8898       end changes by issuing the following command:
8899    
8900    
8901    
8902    
8903    Schoenebeck             Expires December 26, 2011             [Page 159]
8904    
8905  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
8906    
8907    
8908          SUBSCRIBE VOICE_COUNT
8909    
8910       Server will start sending the following notification messages:
8911    
8912        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
8913    
# Line 6335  Internet-Draft        LinuxSampler Contr Line 8915  Internet-Draft        LinuxSampler Contr
8915     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
8916     voices on that channel.     voices on that channel.
8917    
8918  8.7.  Number of active disk streams changed  8.9.  Number of active disk streams changed
8919    
8920     Client may want to be notified when the number of streams on the     Client may want to be notified when the number of streams on the
8921     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 6351  Internet-Draft        LinuxSampler Contr Line 8931  Internet-Draft        LinuxSampler Contr
8931     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
8932     active disk streams on that channel.     active disk streams on that channel.
8933    
8934  8.8.  Disk stream buffer fill state changed  8.10.  Disk stream buffer fill state changed
8935    
8936     Client may want to be notified when the buffer fill state of a disk     Client may want to be notified when the buffer fill state of a disk
8937     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 6368  Internet-Draft        LinuxSampler Contr Line 8948  Internet-Draft        LinuxSampler Contr
8948     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
8949     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
8950    
8951  8.9.  Channel information changed  8.11.  Channel information changed
8952    
8953     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
8954     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
8955    
       SUBSCRIBE CHANNEL_INFO  
8956    
    Server will start sending the following notification messages:  
8957    
8958    
8959    Schoenebeck             Expires December 26, 2011             [Page 160]
8960    
8961    Internet-Draft        LinuxSampler Control Protocol            June 2011
8962    
8963    
8964  Schoenebeck             Expires October 18, 2007              [Page 114]        SUBSCRIBE CHANNEL_INFO
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
8965    
8966       Server will start sending the following notification messages:
8967    
8968        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
8969    
# Line 6394  Internet-Draft        LinuxSampler Contr Line 8974  Internet-Draft        LinuxSampler Contr
8974     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
8975     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
8976    
8977  8.10.  Number of effect sends changed  8.12.  Number of effect sends changed
8978    
8979     Client may want to be notified when the number of effect sends on a     Client may want to be notified when the number of effect sends on a
8980     particular sampler channel is changed by issuing the following     particular sampler channel is changed by issuing the following
# Line 6411  Internet-Draft        LinuxSampler Contr Line 8991  Internet-Draft        LinuxSampler Contr
8991     sends> will be replaced by the new number of effect sends on that     sends> will be replaced by the new number of effect sends on that
8992     channel.     channel.
8993    
8994  8.11.  Effect send information changed  8.13.  Effect send information changed
8995    
8996     Client may want to be notified when changes were made to effect sends     Client may want to be notified when changes were made to effect sends
8997     on a a particular sampler channel by issuing the following command:     on a a particular sampler channel by issuing the following command:
# Line 6427  Internet-Draft        LinuxSampler Contr Line 9007  Internet-Draft        LinuxSampler Contr
9007     send-id> will be replaced by the numerical ID of the changed effect     send-id> will be replaced by the numerical ID of the changed effect
9008     send.     send.
9009    
 8.12.  Total number of active voices changed  
9010    
    Client may want to be notified when the total number of voices on the  
    back-end changes by issuing the following command:  
9011    
9012    
9013    
9014    
9015    Schoenebeck             Expires December 26, 2011             [Page 161]
 Schoenebeck             Expires October 18, 2007              [Page 115]  
9016    
9017  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
9018    
9019    
9020    8.14.  Total number of active voices changed
9021    
9022       Client may want to be notified when the total number of voices on the
9023       back-end changes by issuing the following command:
9024    
9025        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
9026    
# Line 6450  Internet-Draft        LinuxSampler Contr Line 9031  Internet-Draft        LinuxSampler Contr
9031     where <voices> will be replaced by the new number of all currently     where <voices> will be replaced by the new number of all currently
9032     active voices.     active voices.
9033    
9034  8.13.  Number of MIDI instrument maps changed  8.15.  Total number of active disk streams changed
9035    
9036       Client may want to be notified when the total number of disk streams
9037       on the back-end changes by issuing the following command:
9038    
9039          SUBSCRIBE TOTAL_STREAM_COUNT
9040    
9041       Server will start sending the following notification messages:
9042    
9043          "NOTIFY:TOTAL_STREAM_COUNT:<streams>"
9044    
9045       where <streams> will be replaced by the new number of all currently
9046       active disk streams.
9047    
9048    8.16.  Number of MIDI instrument maps changed
9049    
9050     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
9051     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
# Line 6464  Internet-Draft        LinuxSampler Contr Line 9059  Internet-Draft        LinuxSampler Contr
9059     where <maps> will be replaced by the new number of MIDI instrument     where <maps> will be replaced by the new number of MIDI instrument
9060     maps.     maps.
9061    
9062  8.14.  MIDI instrument map information changed  8.17.  MIDI instrument map information changed
9063    
9064     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
9065     instrument maps on the back-end by issuing the following command:     instrument maps on the back-end by issuing the following command:
9066    
9067    
9068    
9069    
9070    
9071    Schoenebeck             Expires December 26, 2011             [Page 162]
9072    
9073    Internet-Draft        LinuxSampler Control Protocol            June 2011
9074    
9075    
9076        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO        SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
9077    
9078     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 6483  Internet-Draft        LinuxSampler Contr Line 9087  Internet-Draft        LinuxSampler Contr
9087     happening on the server, it is believed that an empty notification     happening on the server, it is believed that an empty notification
9088     message is sufficient here.     message is sufficient here.
9089    
9090  8.15.  Number of MIDI instruments changed  8.18.  Number of MIDI instruments changed
9091    
9092     Client may want to be notified when the number of MIDI instrument     Client may want to be notified when the number of MIDI instrument
9093     maps on the back-end changes by issuing the following command:     maps on the back-end changes by issuing the following command:
9094    
   
   
   
   
 Schoenebeck             Expires October 18, 2007              [Page 116]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
9095        SUBSCRIBE MIDI_INSTRUMENT_COUNT        SUBSCRIBE MIDI_INSTRUMENT_COUNT
9096    
9097     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 6507  Internet-Draft        LinuxSampler Contr Line 9102  Internet-Draft        LinuxSampler Contr
9102     which the nuber of instruments has changed and <instruments> will be     which the nuber of instruments has changed and <instruments> will be
9103     replaced by the new number of MIDI instruments in the specified map.     replaced by the new number of MIDI instruments in the specified map.
9104    
9105  8.16.  MIDI instrument information changed  8.19.  MIDI instrument information changed
9106    
9107     Client may want to be notified when changes were made to MIDI     Client may want to be notified when changes were made to MIDI
9108     instruments on the back-end by issuing the following command:     instruments on the back-end by issuing the following command:
# Line 6527  Internet-Draft        LinuxSampler Contr Line 9122  Internet-Draft        LinuxSampler Contr
9122     real time events happening on the server, it is believed that an     real time events happening on the server, it is believed that an
9123     empty notification message is sufficient here.     empty notification message is sufficient here.
9124    
9125  8.17.  Global settings changed  
9126    
9127    Schoenebeck             Expires December 26, 2011             [Page 163]
9128    
9129    Internet-Draft        LinuxSampler Control Protocol            June 2011
9130    
9131    
9132    8.20.  Global settings changed
9133    
9134     Client may want to be notified when changes to the global settings of     Client may want to be notified when changes to the global settings of
9135     the sampler were made by issuing the following command:     the sampler were made by issuing the following command:
# Line 6542  Internet-Draft        LinuxSampler Contr Line 9144  Internet-Draft        LinuxSampler Contr
9144        by the optional dotted floating point value, reflecting the new        by the optional dotted floating point value, reflecting the new
9145        global volume parameter.        global volume parameter.
9146    
9147          "NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the
9148          golbal limit of the sampler for maximum voices is changed, where
9149          <max-voices> will be an integer value, reflecting the new global
9150          voice limit parameter.
9151    
9152          "NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the
9153          golbal limit of the sampler for maximum disk streams is changed,
9154          where <max-streams> will be an integer value, reflecting the new
9155          global disk streams limit parameter.
9156    
9157    8.21.  Number of database instrument directories changed
   
   
   
   
 Schoenebeck             Expires October 18, 2007              [Page 117]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
 8.18.  Number of database instrument directories changed  
9158    
9159     Client may want to be notified when the number of instrument     Client may want to be notified when the number of instrument
9160     directories in a particular directory in the instruments database is     directories in a particular directory in the instruments database is
# Line 6572  Internet-Draft        LinuxSampler Contr Line 9173  Internet-Draft        LinuxSampler Contr
9173     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
9174     sent for the subdirectories in that directory.     sent for the subdirectories in that directory.
9175    
9176  8.19.  Database instrument directory information changed  8.22.  Database instrument directory information changed
9177    
9178     Client may want to be notified when changes were made to directories     Client may want to be notified when changes were made to directories
9179     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
9180    
9181    
9182    
9183    Schoenebeck             Expires December 26, 2011             [Page 164]
9184    
9185    Internet-Draft        LinuxSampler Control Protocol            June 2011
9186    
9187    
9188        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO        SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
9189    
9190     Server will start sending the following notification messages:     Server will start sending the following notification messages:
# Line 6598  Internet-Draft        LinuxSampler Contr Line 9206  Internet-Draft        LinuxSampler Contr
9206     (encapsulated into apostrophes), which name is changes and <new-name>     (encapsulated into apostrophes), which name is changes and <new-name>
9207     is the new name of the directory, encapsulated into apostrophes.     is the new name of the directory, encapsulated into apostrophes.
9208    
9209    8.23.  Number of database instruments changed
   
   
   
   
   
 Schoenebeck             Expires October 18, 2007              [Page 118]  
   
 Internet-Draft        LinuxSampler Control Protocol           April 2007  
   
   
 8.20.  Number of database instruments changed  
9210    
9211     Client may want to be notified when the number of instruments in a     Client may want to be notified when the number of instruments in a
9212     particular directory in the instruments database is changed by     particular directory in the instruments database is changed by
# Line 6628  Internet-Draft        LinuxSampler Contr Line 9225  Internet-Draft        LinuxSampler Contr
9225     Note that when a non-empty directory is removed, this event is not     Note that when a non-empty directory is removed, this event is not
9226     sent for the instruments in that directory.     sent for the instruments in that directory.
9227    
9228  8.21.  Database instrument information changed  8.24.  Database instrument information changed
9229    
9230     Client may want to be notified when changes were made to instruments     Client may want to be notified when changes were made to instruments
9231     in the instruments database by issuing the following command:     in the instruments database by issuing the following command:
# Line 6637  Internet-Draft        LinuxSampler Contr Line 9234  Internet-Draft        LinuxSampler Contr
9234    
9235     Server will start sending the following notification messages:     Server will start sending the following notification messages:
9236    
9237    
9238    
9239    Schoenebeck             Expires December 26, 2011             [Page 165]
9240    
9241    Internet-Draft        LinuxSampler Control Protocol            June 2011
9242    
9243    
9244        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"        "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
9245    
9246     where <instr-path> will be replaced by the absolute path name of the     where <instr-path> will be replaced by the absolute path name of the
# Line 6654  Internet-Draft        LinuxSampler Contr Line 9258  Internet-Draft        LinuxSampler Contr
9258     <new-name> is the new name of the instrument, encapsulated into     <new-name> is the new name of the instrument, encapsulated into
9259     apostrophes.     apostrophes.
9260    
9261    8.25.  Database job status information changed
9262    
9263       Client may want to be notified when the status of particular database
9264       instruments job is changed by issuing the following command:
9265    
9266          SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
9267    
9268       Server will start sending the following notification messages:
9269    
9270          "NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"
9271    
9272       where <job-id> will be replaced by the numerical ID of the job, which
9273       status is changed.  The front-end will have to send the respective
9274       command to actually get the status info.  Because these messages will
9275       be triggered by LSCP commands issued by other clients rather than
9276       real time events happening on the server, it is believed that an
9277       empty notification message is sufficient here.
9278    
9279    8.26.  Number of effect instances changed
9280    
9281       Client may want to be notified when the number of effect instances is
9282       changed by issuing the following command:
9283    
9284          SUBSCRIBE EFFECT_INSTANCE_COUNT
9285    
9286       Server will start sending the following notification messages:
9287    
9288          "EFFECT_INSTANCE_COUNT:<instances>"
9289    
9290       where <instances> will be replaced by the new number of effect
9291       instances.
9292    
9293    
9294    
9295    Schoenebeck             Expires December 26, 2011             [Page 166]
9296    
9297    Internet-Draft        LinuxSampler Control Protocol            June 2011
9298    
9299    
9300    8.27.  Effect instance information changed
9301    
9302       Client may want to be notified when changes were made to effect
9303       instances on the back-end by issuing the following command:
9304    
9305          SUBSCRIBE EFFECT_INSTANCE_INFO
9306    
9307       Server will start sending the following notification messages:
9308    
9309          "EFFECT_INSTANCE_INFO:<instance-id>"
9310    
9311       where <instance-id> will be replaced by the numerical ID of the
9312       effect instance.
9313    
9314    8.28.  Number of send effect chains changed
9315    
9316       Client may want to be notified when the number of send effect chains
9317       is changed by issuing the following command:
9318    
9319          SUBSCRIBE SEND_EFFECT_CHAIN_COUNT
9320    
9321       Server will start sending the following notification messages:
9322    
9323          "NOTIFY:SEND_EFFECT_CHAIN_COUNT:<device-id> <chains>"
9324    
9325       where <device-id> will be replaced by the numerical ID of the audio
9326       output device, in which the number of send effect chains is changed
9327       and <chains> will be replaced by the new number of send effect
9328       chains.
9329    
9330    8.29.  Send effect chain information changed
9331    
9332       Client may want to be notified when changes were made to send effect
9333       chains on the back-end by issuing the following command:
9334    
9335          SUBSCRIBE SEND_EFFECT_CHAIN_INFO
9336    
9337       Server will start sending the following notification messages:
9338    
9339          "SEND_EFFECT_CHAIN_INFO:<device-id> <chain-id> <instances>" -
9340          Notifies that the number of effect instances in a particular send
9341          effect chain is changed, where <device-id> will be replaced by the
9342          numerical ID of the audio output device the send effect chain
9343          belongs to, <chain-id> will be replaced by the numerical ID of the
9344          send effect chain in which the number of effect instances has
9345          changed and <instances> will be replaced by the new number of
9346          effect instances in the specified send effect chain.
9347    
9348    
9349    
9350  Schoenebeck             Expires October 18, 2007              [Page 119]  
9351    Schoenebeck             Expires December 26, 2011             [Page 167]
9352    
9353  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
9354    
9355    
9356  8.22.  Miscellaneous and debugging events  8.30.  Miscellaneous and debugging events
9357    
9358     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
9359     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 6716  Internet-Draft        LinuxSampler Contr Line 9404  Internet-Draft        LinuxSampler Contr
9404    
9405    
9406    
9407  Schoenebeck             Expires October 18, 2007              [Page 120]  Schoenebeck             Expires December 26, 2011             [Page 168]
9408    
9409  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
9410    
9411    
9412  9.  Security Considerations  9.  Security Considerations
# Line 6772  Internet-Draft        LinuxSampler Contr Line 9460  Internet-Draft        LinuxSampler Contr
9460    
9461    
9462    
9463  Schoenebeck             Expires October 18, 2007              [Page 121]  Schoenebeck             Expires December 26, 2011             [Page 169]
9464    
9465  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
9466    
9467    
9468  10.  Acknowledgments  10.  Acknowledgments
# Line 6828  Internet-Draft        LinuxSampler Contr Line 9516  Internet-Draft        LinuxSampler Contr
9516    
9517    
9518    
9519  Schoenebeck             Expires October 18, 2007              [Page 122]  Schoenebeck             Expires December 26, 2011             [Page 170]
9520    
9521  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
9522    
9523    
9524  11.  References  11.  References
9525    
9526       [RFC20]    UCLA, "ASCII format for Network Interchange", RFC 20,
9527                  1969.
9528    
9529     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
9530                Requirement Levels", RFC 2119, 1997.                Requirement Levels", RFC 2119, 1997.
9531    
# Line 6881  Internet-Draft        LinuxSampler Contr Line 9572  Internet-Draft        LinuxSampler Contr
9572    
9573    
9574    
9575    Schoenebeck             Expires December 26, 2011             [Page 171]
   
   
 Schoenebeck             Expires October 18, 2007              [Page 123]  
9576    
9577  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
9578    
9579    
9580  Author's Address  Author's Address
# Line 6940  Author's Address Line 9628  Author's Address
9628    
9629    
9630    
9631  Schoenebeck             Expires October 18, 2007              [Page 124]  Schoenebeck             Expires December 26, 2011             [Page 172]
9632    
9633  Internet-Draft        LinuxSampler Control Protocol           April 2007  Internet-Draft        LinuxSampler Control Protocol            June 2011
9634    
9635    
9636  Full Copyright Statement  Full Copyright Statement
9637    
9638     Copyright (C) The IETF Trust (2007).     Copyright (C) The IETF Trust (2011).
9639    
9640     This document is subject to the rights, licenses and restrictions     This document is subject to the rights, licenses and restrictions
9641     contained in BCP 78, and except as set forth therein, the authors     contained in BCP 78, and except as set forth therein, the authors
# Line 6987  Intellectual Property Line 9675  Intellectual Property
9675     ietf-ipr@ietf.org.     ietf-ipr@ietf.org.
9676    
9677    
 Acknowledgment  
9678    
    Funding for the RFC Editor function is provided by the IETF  
    Administrative Support Activity (IASA).  
9679    
9680    
9681    
9682    
9683    
9684  Schoenebeck             Expires October 18, 2007              [Page 125]  
9685    
9686    
9687    Schoenebeck             Expires December 26, 2011             [Page 173]
9688    
Legend:
Removed from v.1162  
changed lines
  Added in v.2189
  ViewVC Help
Powered by ViewVC