/[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 2140 by schoenebeck, Mon Oct 4 22:17:58 2010 UTC revision 2141 by schoenebeck, Tue Oct 5 10:36:00 2010 UTC
# Line 147  Internet-Draft        LinuxSampler Contr Line 147  Internet-Draft        LinuxSampler Contr
147         6.4.31.  Altering effect send's audio routing . . . . . . . .  69         6.4.31.  Altering effect send's audio routing . . . . . . . .  69
148         6.4.32.  Assigning destination effect to an effect send . . .  70         6.4.32.  Assigning destination effect to an effect send . . .  70
149         6.4.33.  Removing destination effect from an effect send  . .  71         6.4.33.  Removing destination effect from an effect send  . .  71
150         6.4.34.  Altering effect send's MIDI controller . . . . . . .  71         6.4.34.  Altering effect send's MIDI controller . . . . . . .  72
151         6.4.35.  Altering effect send's send level  . . . . . . . . .  72         6.4.35.  Altering effect send's send level  . . . . . . . . .  72
152         6.4.36.  Sending MIDI messages to sampler channel . . . . . .  73         6.4.36.  Sending MIDI messages to sampler channel . . . . . .  73
153         6.4.37.  Resetting a sampler channel  . . . . . . . . . . . .  74         6.4.37.  Resetting a sampler channel  . . . . . . . . . . . .  74
154       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  75       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  75
155         6.5.1.   Register front-end for receiving event messages  . .  75         6.5.1.   Register front-end for receiving event messages  . .  75
156         6.5.2.   Unregister front-end for not receiving event         6.5.2.   Unregister front-end for not receiving event
157                  messages . . . . . . . . . . . . . . . . . . . . . .  75                  messages . . . . . . . . . . . . . . . . . . . . . .  76
158         6.5.3.   Enable or disable echo of commands . . . . . . . . .  76         6.5.3.   Enable or disable echo of commands . . . . . . . . .  76
159         6.5.4.   Close client connection  . . . . . . . . . . . . . .  77         6.5.4.   Close client connection  . . . . . . . . . . . . . .  77
160       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  77       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  77
161         6.6.1.   Current number of active voices  . . . . . . . . . .  77         6.6.1.   Current number of active voices  . . . . . . . . . .  77
162         6.6.2.   Maximum amount of active voices  . . . . . . . . . .  77         6.6.2.   Maximum amount of active voices  . . . . . . . . . .  78
163         6.6.3.   Current number of active disk streams  . . . . . . .  77         6.6.3.   Current number of active disk streams  . . . . . . .  78
164    
165    
166    
# Line 172  Internet-Draft        LinuxSampler Contr Line 172  Internet-Draft        LinuxSampler Contr
172         6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  78         6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  78
173         6.6.5.   General sampler informations . . . . . . . . . . . .  78         6.6.5.   General sampler informations . . . . . . . . . . . .  78
174         6.6.6.   Getting global volume attenuation  . . . . . . . . .  79         6.6.6.   Getting global volume attenuation  . . . . . . . . .  79
175         6.6.7.   Setting global volume attenuation  . . . . . . . . .  79         6.6.7.   Setting global volume attenuation  . . . . . . . . .  80
176         6.6.8.   Getting global voice limit . . . . . . . . . . . . .  80         6.6.8.   Getting global voice limit . . . . . . . . . . . . .  80
177         6.6.9.   Setting global voice limit . . . . . . . . . . . . .  80         6.6.9.   Setting global voice limit . . . . . . . . . . . . .  81
178         6.6.10.  Getting global disk stream limit . . . . . . . . . .  81         6.6.10.  Getting global disk stream limit . . . . . . . . . .  81
179         6.6.11.  Setting global disk stream limit . . . . . . . . . .  81         6.6.11.  Setting global disk stream limit . . . . . . . . . .  82
180       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  82       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  83
181         6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  83         6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  83
182         6.7.2.   Delete one particular or all MIDI instrument maps  .  84         6.7.2.   Delete one particular or all MIDI instrument maps  .  84
183         6.7.3.   Get amount of existing MIDI instrument maps  . . . .  84         6.7.3.   Get amount of existing MIDI instrument maps  . . . .  85
184         6.7.4.   Getting all created MIDI instrument maps . . . . . .  85         6.7.4.   Getting all created MIDI instrument maps . . . . . .  85
185         6.7.5.   Getting MIDI instrument map information  . . . . . .  85         6.7.5.   Getting MIDI instrument map information  . . . . . .  86
186         6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  86         6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  87
187         6.7.7.   Create or replace a MIDI instrument map entry  . . .  87         6.7.7.   Create or replace a MIDI instrument map entry  . . .  87
188         6.7.8.   Getting ammount of MIDI instrument map entries . . .  89         6.7.8.   Getting ammount of MIDI instrument map entries . . .  90
189         6.7.9.   Getting indeces of all entries of a MIDI         6.7.9.   Getting indeces of all entries of a MIDI
190                  instrument map . . . . . . . . . . . . . . . . . . .  90                  instrument map . . . . . . . . . . . . . . . . . . .  91
191         6.7.10.  Remove an entry from the MIDI instrument map . . . .  91         6.7.10.  Remove an entry from the MIDI instrument map . . . .  91
192         6.7.11.  Get current settings of MIDI instrument map entry  .  91         6.7.11.  Get current settings of MIDI instrument map entry  .  92
193         6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  93         6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  94
194       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  94       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  94
195         6.8.1.   Creating a new instrument directory  . . . . . . . .  94         6.8.1.   Creating a new instrument directory  . . . . . . . .  95
196         6.8.2.   Deleting an instrument directory . . . . . . . . . .  95         6.8.2.   Deleting an instrument directory . . . . . . . . . .  95
197         6.8.3.   Getting amount of instrument directories . . . . . .  95         6.8.3.   Getting amount of instrument directories . . . . . .  96
198         6.8.4.   Listing all directories in specific directory  . . .  96         6.8.4.   Listing all directories in specific directory  . . .  96
199         6.8.5.   Getting instrument directory information . . . . . .  97         6.8.5.   Getting instrument directory information . . . . . .  97
200         6.8.6.   Renaming an instrument directory . . . . . . . . . .  98         6.8.6.   Renaming an instrument directory . . . . . . . . . .  98
201         6.8.7.   Moving an instrument directory . . . . . . . . . . .  98         6.8.7.   Moving an instrument directory . . . . . . . . . . .  99
202         6.8.8.   Copying instrument directories . . . . . . . . . . .  99         6.8.8.   Copying instrument directories . . . . . . . . . . .  99
203         6.8.9.   Changing the description of directory  . . . . . . . 100         6.8.9.   Changing the description of directory  . . . . . . . 100
204         6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 100         6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 101
205         6.8.11.  Adding instruments to the instruments database . . . 102         6.8.11.  Adding instruments to the instruments database . . . 102
206         6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 103         6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 104
207         6.8.13.  Getting amount of instruments  . . . . . . . . . . . 104         6.8.13.  Getting amount of instruments  . . . . . . . . . . . 104
208         6.8.14.  Listing all instruments in specific directory  . . . 104         6.8.14.  Listing all instruments in specific directory  . . . 105
209         6.8.15.  Getting instrument information . . . . . . . . . . . 105         6.8.15.  Getting instrument information . . . . . . . . . . . 105
210         6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 107         6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 108
211         6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 108         6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 108
212         6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 109         6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 109
213         6.8.19.  Changing the description of instrument . . . . . . . 109         6.8.19.  Changing the description of instrument . . . . . . . 110
214         6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 110         6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 110
215         6.8.21.  Getting job status information . . . . . . . . . . . 112         6.8.21.  Getting job status information . . . . . . . . . . . 113
216         6.8.22.  Formatting the instruments database  . . . . . . . . 113         6.8.22.  Formatting the instruments database  . . . . . . . . 114
217         6.8.23.  Checking for lost instrument files . . . . . . . . . 114         6.8.23.  Checking for lost instrument files . . . . . . . . . 114
218         6.8.24.  Replacing an instrument file . . . . . . . . . . . . 114         6.8.24.  Replacing an instrument file . . . . . . . . . . . . 115
219       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 115       6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 115
220    
221    
# Line 226  Internet-Draft        LinuxSampler Contr Line 226  Internet-Draft        LinuxSampler Contr
226    
227    
228         6.9.1.   Opening an appropriate instrument editor         6.9.1.   Opening an appropriate instrument editor
229                  application  . . . . . . . . . . . . . . . . . . . . 115                  application  . . . . . . . . . . . . . . . . . . . . 116
230       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 116       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 117
231         6.10.1.  Retrieving amount of instruments of a file . . . . . 116         6.10.1.  Retrieving amount of instruments of a file . . . . . 117
232         6.10.2.  Retrieving all instruments of a file . . . . . . . . 117         6.10.2.  Retrieving all instruments of a file . . . . . . . . 117
233         6.10.3.  Retrieving informations about one instrument in a         6.10.3.  Retrieving informations about one instrument in a
234                  file . . . . . . . . . . . . . . . . . . . . . . . . 117                  file . . . . . . . . . . . . . . . . . . . . . . . . 118
235       6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 119       6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 120
236         6.11.1.  Retrieve amount of available effects . . . . . . . . 120         6.11.1.  Retrieve amount of available effects . . . . . . . . 120
237         6.11.2.  Get list of available effects  . . . . . . . . . . . 120         6.11.2.  Get list of available effects  . . . . . . . . . . . 121
238         6.11.3.  Retrieving general information about an effect . . . 121         6.11.3.  Retrieving general information about an effect . . . 121
239         6.11.4.  Creating an instance of an effect by its portable         6.11.4.  Creating an instance of an effect by its portable
240                  ID . . . . . . . . . . . . . . . . . . . . . . . . . 122                  ID . . . . . . . . . . . . . . . . . . . . . . . . . 122
# Line 242  Internet-Draft        LinuxSampler Contr Line 242  Internet-Draft        LinuxSampler Contr
242                  numerical ID . . . . . . . . . . . . . . . . . . . . 123                  numerical ID . . . . . . . . . . . . . . . . . . . . 123
243         6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 124         6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 124
244         6.11.7.  Retrieve amount of effect instances  . . . . . . . . 125         6.11.7.  Retrieve amount of effect instances  . . . . . . . . 125
245         6.11.8.  Get list of effect instances . . . . . . . . . . . . 125         6.11.8.  Get list of effect instances . . . . . . . . . . . . 126
246         6.11.9.  Retrieving current information about an effect         6.11.9.  Retrieving current information about an effect
247                  instance . . . . . . . . . . . . . . . . . . . . . . 125                  instance . . . . . . . . . . . . . . . . . . . . . . 126
248         6.11.10. Retrieving information about an effect parameter . . 127         6.11.10. Retrieving information about an effect parameter . . 127
249         6.11.11. Altering an effect parameter . . . . . . . . . . . . 129         6.11.11. Altering an effect parameter . . . . . . . . . . . . 129
250         6.11.12. Retrieve amount of send effect chains  . . . . . . . 129         6.11.12. Retrieve amount of send effect chains  . . . . . . . 130
251         6.11.13. Retrieve list of send effect chains  . . . . . . . . 130         6.11.13. Retrieve list of send effect chains  . . . . . . . . 130
252         6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 130         6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 131
253         6.11.15. Remove send effect chain . . . . . . . . . . . . . . 131         6.11.15. Remove send effect chain . . . . . . . . . . . . . . 131
254         6.11.16. Retrieving information about a send effect chain . . 132         6.11.16. Retrieving information about a send effect chain . . 132
255         6.11.17. Append effect instance to a send effect chain  . . . 133         6.11.17. Append effect instance to a send effect chain  . . . 133
256         6.11.18. Insert effect instance to a send effect chain  . . . 133         6.11.18. Insert effect instance to a send effect chain  . . . 134
257         6.11.19. Remove effect instance from send effect chain  . . . 134         6.11.19. Remove effect instance from send effect chain  . . . 135
258     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 136     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 136
259       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 152       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 152
260     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 157     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
# Line 3736  Internet-Draft        LinuxSampler Contr Line 3736  Internet-Draft        LinuxSampler Contr
3736              then this setting defines the audio channel routing to that              then this setting defines the audio channel routing to that
3737              effect instance respectively              effect instance respectively
3738    
3739           SEND_EFFECT -           EFFECT -
3740    
3741              destination send effect chain ID and destination effect              destination send effect chain ID and destination effect
3742              chain position, separated by comma in the form "<effect-              chain position, separated by comma in the form "<effect-
# Line 3765  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 3786  Internet-Draft        LinuxSampler Contr Line 3802  Internet-Draft        LinuxSampler Contr
3802    
3803     Possible Answers:     Possible Answers:
3804    
3805    
3806    
3807    Schoenebeck               Expires April 8, 2011                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol         October 2010
3810    
3811    
3812        "OK" -        "OK" -
3813    
3814           on success           on success
# Line 3801  Internet-Draft        LinuxSampler Contr Line 3824  Internet-Draft        LinuxSampler Contr
3824    
3825        S: "OK"        S: "OK"
3826    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
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 3842  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 April 8, 2011                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol         October 2010
3866    
3867    
3868     Possible Answers:     Possible Answers:
3869    
3870        "OK" -        "OK" -
# Line 3856  Internet-Draft        LinuxSampler Contr Line 3879  Internet-Draft        LinuxSampler Contr
3879    
3880        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3881    
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
3882           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3883           error message           error message
3884    
# Line 3879  Internet-Draft        LinuxSampler Contr Line 3893  Internet-Draft        LinuxSampler Contr
3893     The front-end can (re-)assign a destination effect to an effect send     The front-end can (re-)assign a destination effect to an effect send
3894     by sending the following command:     by sending the following command:
3895    
3896        SET FX_SEND SEND_EFFECT <sampler-chan> <fx-send-id> <effect-chain>        SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain>
3897        <chain-pos>        <chain-pos>
3898    
3899     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
# Line 3899  Internet-Draft        LinuxSampler Contr Line 3913  Internet-Draft        LinuxSampler Contr
3913    
3914           on success           on success
3915    
       "ERR:<error-code>:<error-message>" -  
   
          in case it failed, providing an appropriate error code and  
          error message  
3916    
    Example:  
3917    
       C: "SET FX_SEND SEND_EFFECT 0 0 2 5"  
   
       S: "OK"  
3918    
3919    Schoenebeck               Expires April 8, 2011                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol         October 2010
3922    
3923    
3924          "ERR:<error-code>:<error-message>" -
3925    
3926             in case it failed, providing an appropriate error code and
3927             error message
3928    
3929       Example:
3930    
3931          C: "SET FX_SEND EFFECT 0 0 2 5"
3932    
3933  Schoenebeck               Expires April 8, 2011                [Page 70]        S: "OK"
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
3934    
3935  6.4.33.  Removing destination effect from an effect send  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     The front-end can (re-)assign a destination effect to an effect send
3938     by sending the following command:     by sending the following command:
3939    
3940        REMOVE FX_SEND SEND_EFFECT <sampler-chan> <fx-send-id>        REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id>
3941    
3942     Where <sampler-chan> is the sampler channel number as returned by the     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)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
# Line 3952  Internet-Draft        LinuxSampler Contr Line 3963  Internet-Draft        LinuxSampler Contr
3963    
3964     Example:     Example:
3965    
3966        C: "REMOVE FX_SEND SEND_EFFECT 0 0"        C: "REMOVE FX_SEND EFFECT 0 0"
3967    
3968        S: "OK"        S: "OK"
3969    
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires April 8, 2011                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol         October 2010
3978    
3979    
3980  6.4.34.  Altering effect send's MIDI controller  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
# Line 3969  Internet-Draft        LinuxSampler Contr Line 3990  Internet-Draft        LinuxSampler Contr
3990     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
3991     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
3992     FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI     FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
3993     controller which shall be able to modify the effect send's send     controller which shall be able to modify the effect send's send
3994     level.     level.
3995    
# Line 4012  Internet-Draft        LinuxSampler Contr Line 4025  Internet-Draft        LinuxSampler Contr
4025    
4026     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4027     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4028    
4029    
4030    
4031    Schoenebeck               Expires April 8, 2011                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol         October 2010
4034    
4035    
4036     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4037     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
4038     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
# Line 4025  Internet-Draft        LinuxSampler Contr Line 4046  Internet-Draft        LinuxSampler Contr
4046    
4047           on success           on success
4048    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4049        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4050    
4051           if new send level was set, but there are noteworthy issue(s)           if new send level was set, but there are noteworthy issue(s)
# Line 4069  Internet-Draft        LinuxSampler Contr Line 4082  Internet-Draft        LinuxSampler Contr
4082           number and <arg2> the velocity as described in the MIDI           number and <arg2> the velocity as described in the MIDI
4083           specification.           specification.
4084    
4085    
4086    
4087    Schoenebeck               Expires April 8, 2011                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol         October 2010
4090    
4091    
4092        "NOTE_OFF" -        "NOTE_OFF" -
4093    
4094           For turning a currently playing MIDI note off, where <arg1>           For turning a currently playing MIDI note off, where <arg1>
# Line 4082  Internet-Draft        LinuxSampler Contr Line 4102  Internet-Draft        LinuxSampler Contr
4102           described in the Control Change section of the MIDI           described in the Control Change section of the MIDI
4103           specification.           specification.
4104    
   
   
 Schoenebeck               Expires April 8, 2011                [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4105     CAUTION: This command is provided for implementations of virtual MIDI     CAUTION: This command is provided for implementations of virtual MIDI
4106     keyboards and no realtime guarantee whatsoever will be made!     keyboards and no realtime guarantee whatsoever will be made!
4107    
# Line 4123  Internet-Draft        LinuxSampler Contr Line 4136  Internet-Draft        LinuxSampler Contr
4136    
4137     Possible Answers:     Possible Answers:
4138    
4139    
4140    
4141    
4142    
4143    Schoenebeck               Expires April 8, 2011                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol         October 2010
4146    
4147    
4148        "OK" -        "OK" -
4149    
4150           on success           on success
# Line 4138  Internet-Draft        LinuxSampler Contr Line 4160  Internet-Draft        LinuxSampler Contr
4160           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4161           error message           error message
4162    
   
   
 Schoenebeck               Expires April 8, 2011                [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4163     Examples:     Examples:
4164    
4165    
# Line 4176  Internet-Draft        LinuxSampler Contr Line 4191  Internet-Draft        LinuxSampler Contr
4191           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4192           message           message
4193    
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck               Expires April 8, 2011                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol         October 2010
4202    
4203    
4204        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4205    
4206           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 4193  Internet-Draft        LinuxSampler Contr Line 4218  Internet-Draft        LinuxSampler Contr
4218        UNSUBSCRIBE <event-id>        UNSUBSCRIBE <event-id>
4219    
4220     Where <event-id> will be replaced by the respective event that client     Where <event-id> will be replaced by the respective event that client
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4221     doesn't want to receive anymore.     doesn't want to receive anymore.
4222    
4223     Possible Answers:     Possible Answers:
# Line 4232  Internet-Draft        LinuxSampler Contr Line 4249  Internet-Draft        LinuxSampler Contr
4249        SET ECHO <value>        SET ECHO <value>
4250    
4251     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
4252    
4253    
4254    
4255    Schoenebeck               Expires April 8, 2011                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol         October 2010
4258    
4259    
4260     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
4261     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
4262     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 4252  Internet-Draft        LinuxSampler Contr Line 4277  Internet-Draft        LinuxSampler Contr
4277    
4278    
4279    
 Schoenebeck               Expires April 8, 2011                [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
   
   
4280  6.5.4.  Close client connection  6.5.4.  Close client connection
4281    
4282     The client can close its network connection to LinuxSampler by     The client can close its network connection to LinuxSampler by
# Line 4285  Internet-Draft        LinuxSampler Contr Line 4303  Internet-Draft        LinuxSampler Contr
4303        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4304        voices on the sampler.        voices on the sampler.
4305    
4306    
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires April 8, 2011                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol         October 2010
4314    
4315    
4316  6.6.2.  Maximum amount of active voices  6.6.2.  Maximum amount of active voices
4317    
4318     The front-end can ask for the maximum number of active voices by     The front-end can ask for the maximum number of active voices by
# Line 4306  Internet-Draft        LinuxSampler Contr Line 4334  Internet-Draft        LinuxSampler Contr
4334    
4335     Possible Answers:     Possible Answers:
4336    
   
   
 Schoenebeck               Expires April 8, 2011                [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4337        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4338        disk streams on the sampler.        disk streams on the sampler.
4339    
# Line 4338  Internet-Draft        LinuxSampler Contr Line 4359  Internet-Draft        LinuxSampler Contr
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 April 8, 2011                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol         October 2010
4370    
4371    
4372        GET SERVER INFO        GET SERVER INFO
4373    
4374     Possible Answers:     Possible Answers:
# Line 4360  Internet-Draft        LinuxSampler Contr Line 4391  Internet-Draft        LinuxSampler Contr
4391    
4392              version of the sampler              version of the sampler
4393    
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4394           PROTOCOL_VERSION -           PROTOCOL_VERSION -
4395    
4396              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
# Line 4395  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 April 8, 2011                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol         October 2010
4426    
4427    
4428     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4429     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
4430     this parameter.     this parameter.
# Line 4417  Internet-Draft        LinuxSampler Contr Line 4447  Internet-Draft        LinuxSampler Contr
4447    
4448           on success           on success
4449    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4450        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4451    
4452           if the global volume was set, but there are noteworthy issue(s)           if the global volume was set, but there are noteworthy issue(s)
# Line 4451  Internet-Draft        LinuxSampler Contr Line 4473  Internet-Draft        LinuxSampler Contr
4473     The voice limit setting defines how many voices should maximum be     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     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     notes which would exceed that voice limit, the sampler engine will
4476    
4477    
4478    
4479    Schoenebeck               Expires April 8, 2011                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol         October 2010
4482    
4483    
4484     react by stealing old voices for those newly triggered notes.  Note     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     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     one and is dependent to the respective instrument and probably
# Line 4473  Internet-Draft        LinuxSampler Contr Line 4503  Internet-Draft        LinuxSampler Contr
4503    
4504           on success           on success
4505    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 80]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4506        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4507    
4508           if the voice limit was set, but there are noteworthy issue(s)           if the voice limit was set, but there are noteworthy issue(s)
# Line 4505  Internet-Draft        LinuxSampler Contr Line 4527  Internet-Draft        LinuxSampler Contr
4527     The client can ask for the current global sampler-wide limit for     The client can ask for the current global sampler-wide limit for
4528     maximum disk streams by sending the following command:     maximum disk streams by sending the following command:
4529    
4530    
4531    
4532    
4533    
4534    
4535    Schoenebeck               Expires April 8, 2011                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol         October 2010
4538    
4539    
4540        GET STREAMS        GET STREAMS
4541    
4542     Possible Answers:     Possible Answers:
# Line 4529  Internet-Draft        LinuxSampler Contr Line 4561  Internet-Draft        LinuxSampler Contr
4561     reflecting the new global amount limit of maximum disk streams.  This     reflecting the new global amount limit of maximum disk streams.  This
4562     value has to be positive.     value has to be positive.
4563    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4564     Possible Answers:     Possible Answers:
4565    
4566        "OK" -        "OK" -
# Line 4562  Internet-Draft        LinuxSampler Contr Line 4586  Internet-Draft        LinuxSampler Contr
4586     Caution: when adjusting the disk stream limit, you SHOULD also adjust     Caution: when adjusting the disk stream limit, you SHOULD also adjust
4587     the voice limit respectively and vice versa.     the voice limit respectively and vice versa.
4588    
4589    
4590    
4591    Schoenebeck               Expires April 8, 2011                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol         October 2010
4594    
4595    
4596  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4597    
4598     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 4585  Internet-Draft        LinuxSampler Contr Line 4616  Internet-Draft        LinuxSampler Contr
4616     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4617     channel.     channel.
4618    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 82]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4619     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
4620     to switch to another instrument.  Instead when receiving a bank     to switch to another instrument.  Instead when receiving a bank
4621     select message the bank value will be stored and a subsequent program     select message the bank value will be stored and a subsequent program
# Line 4617  Internet-Draft        LinuxSampler Contr Line 4640  Internet-Draft        LinuxSampler Contr
4640    
4641        "OK[<map>]" -        "OK[<map>]" -
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires April 8, 2011                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol         October 2010
4650    
4651    
4652           in case a new MIDI instrument map could be added, where <map>           in case a new MIDI instrument map could be added, where <map>
4653           reflects the unique ID of the newly created MIDI instrument map           reflects the unique ID of the newly created MIDI instrument map
4654    
# Line 4639  Internet-Draft        LinuxSampler Contr Line 4671  Internet-Draft        LinuxSampler Contr
4671    
4672        S: "OK[5]"        S: "OK[5]"
4673    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 83]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4674  6.7.2.  Delete one particular or all MIDI instrument maps  6.7.2.  Delete one particular or all MIDI instrument maps
4675    
4676     The front-end can delete a particular MIDI instrument map by sending     The front-end can delete a particular MIDI instrument map by sending
# Line 4676  Internet-Draft        LinuxSampler Contr Line 4698  Internet-Draft        LinuxSampler Contr
4698    
4699     Examples:     Examples:
4700    
4701    
4702    
4703    Schoenebeck               Expires April 8, 2011                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol         October 2010
4706    
4707    
4708        C: "REMOVE MIDI_INSTRUMENT_MAP 0"        C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4709    
4710        S: "OK"        S: "OK"
# Line 4698  Internet-Draft        LinuxSampler Contr Line 4727  Internet-Draft        LinuxSampler Contr
4727    
4728     Example:     Example:
4729    
   
   
 Schoenebeck               Expires April 8, 2011                [Page 84]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4730        C: "GET MIDI_INSTRUMENT_MAPS"        C: "GET MIDI_INSTRUMENT_MAPS"
4731    
4732        S: "2"        S: "2"
# Line 4728  Internet-Draft        LinuxSampler Contr Line 4750  Internet-Draft        LinuxSampler Contr
4750    
4751        S: "0,1,5,12"        S: "0,1,5,12"
4752    
4753    
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires April 8, 2011                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol         October 2010
4762    
4763    
4764  6.7.5.  Getting MIDI instrument map information  6.7.5.  Getting MIDI instrument map information
4765    
4766     The front-end can ask for the current settings of a MIDI instrument     The front-end can ask for the current settings of a MIDI instrument
# Line 4753  Internet-Draft        LinuxSampler Contr Line 4786  Internet-Draft        LinuxSampler Contr
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 (note that this character string may contain escape              unique (note that this character string may contain escape
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 85]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4789              sequences (Section 7.1))              sequences (Section 7.1))
4790    
4791           DEFAULT -           DEFAULT -
# Line 4780  Internet-Draft        LinuxSampler Contr Line 4805  Internet-Draft        LinuxSampler Contr
4805    
4806           "."           "."
4807    
4808    
4809    
4810    
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires April 8, 2011                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol         October 2010
4818    
4819    
4820  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
4821    
4822     The front-end can alter the custom name of a MIDI instrument map by     The front-end can alter the custom name of a MIDI instrument map by
# Line 4809  Internet-Draft        LinuxSampler Contr Line 4846  Internet-Draft        LinuxSampler Contr
4846    
4847        S: "OK"        S: "OK"
4848    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 86]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4849  6.7.7.  Create or replace a MIDI instrument map entry  6.7.7.  Create or replace a MIDI instrument map entry
4850    
4851     The front-end can create a new or replace an existing entry in a     The front-end can create a new or replace an existing entry in a
# Line 4836  Internet-Draft        LinuxSampler Contr Line 4865  Internet-Draft        LinuxSampler Contr
4865     supporting escape sequences as described in chapter "Character Set     supporting escape sequences as described in chapter "Character Set
4866     and Escape Sequences (Section 7.1)"), <instrument_index> the index     and Escape Sequences (Section 7.1)"), <instrument_index> the index
4867     (integer value) of the instrument within the given file,     (integer value) of the instrument within the given file,
4868    
4869    
4870    
4871    Schoenebeck               Expires April 8, 2011                [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol         October 2010
4874    
4875    
4876     <volume_value> reflects the master volume of the instrument as     <volume_value> reflects the master volume of the instrument as
4877     optionally dotted number (where a value < 1.0 means attenuation and a     optionally dotted number (where a value < 1.0 means attenuation and a
4878     value > 1.0 means amplification).  This parameter easily allows to     value > 1.0 means amplification).  This parameter easily allows to
# Line 4864  Internet-Draft        LinuxSampler Contr Line 4901  Internet-Draft        LinuxSampler Contr
4901    
4902        "PERSISTENT" -        "PERSISTENT" -
4903    
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4904           The instrument will immediately be loaded into memory when this           The instrument will immediately be loaded into memory when this
4905           mapping command is sent and the instrument is kept all the           mapping command is sent and the instrument is kept all the
4906           time.  Instruments with this mode are only freed when the           time.  Instruments with this mode are only freed when the
# Line 4893  Internet-Draft        LinuxSampler Contr Line 4921  Internet-Draft        LinuxSampler Contr
4921     The <instr_load_mode> argument thus allows to define an appropriate     The <instr_load_mode> argument thus allows to define an appropriate
4922     strategy (low memory consumption vs. fast instrument switching) for     strategy (low memory consumption vs. fast instrument switching) for
4923     each instrument individually.  Note, the following restrictions apply     each instrument individually.  Note, the following restrictions apply
4924    
4925    
4926    
4927    Schoenebeck               Expires April 8, 2011                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol         October 2010
4930    
4931    
4932     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4933     supported by the respective sampler engine (which is technically the     supported by the respective sampler engine (which is technically the
4934     case when the engine provides an InstrumentManager for its format).     case when the engine provides an InstrumentManager for its format).
# Line 4921  Internet-Draft        LinuxSampler Contr Line 4957  Internet-Draft        LinuxSampler Contr
4957     a very long time.  It is recommended however to use the OPTIONAL     a very long time.  It is recommended however to use the OPTIONAL
4958     "NON_MODAL" argument only if really necessary, because it has the     "NON_MODAL" argument only if really necessary, because it has the
4959     following drawbacks: as "NON_MODAL" instructions return immediately,     following drawbacks: as "NON_MODAL" instructions return immediately,
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 88]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
4960     they may not necessarily return an error i.e. when the given     they may not necessarily return an error i.e. when the given
4961     instrument file turns out to be corrupt, beside that subsequent     instrument file turns out to be corrupt, beside that subsequent
4962     commands in a LSCP instruction sequence might fail, because mandatory     commands in a LSCP instruction sequence might fail, because mandatory
# Line 4947  Internet-Draft        LinuxSampler Contr Line 4975  Internet-Draft        LinuxSampler Contr
4975    
4976     Examples:     Examples:
4977    
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires April 8, 2011                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol         October 2010
4986    
4987    
4988        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4989        0.8 PERSISTENT"        0.8 PERSISTENT"
4990    
# Line 4977  Internet-Draft        LinuxSampler Contr Line 5015  Internet-Draft        LinuxSampler Contr
5015     The front-end can query the amount of currently existing entries in a     The front-end can query the amount of currently existing entries in a
5016     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
5017    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 89]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5018        GET MIDI_INSTRUMENTS <map>        GET MIDI_INSTRUMENTS <map>
5019    
5020     The front-end can query the amount of currently existing entries in     The front-end can query the amount of currently existing entries in
# Line 5003  Internet-Draft        LinuxSampler Contr Line 5033  Internet-Draft        LinuxSampler Contr
5033    
5034        S: "234"        S: "234"
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires April 8, 2011                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol         October 2010
5042    
5043    
5044        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
5045    
5046        S: "954"        S: "954"
# Line 5033  Internet-Draft        LinuxSampler Contr Line 5071  Internet-Draft        LinuxSampler Contr
5071    
5072     Example:     Example:
5073    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 90]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5074        C: "LIST MIDI_INSTRUMENTS 0"        C: "LIST MIDI_INSTRUMENTS 0"
5075    
5076        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
# Line 5059  Internet-Draft        LinuxSampler Contr Line 5089  Internet-Draft        LinuxSampler Contr
5089    
5090     Possible Answers:     Possible Answers:
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires April 8, 2011                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol         October 2010
5098    
5099    
5100        "OK" -        "OK" -
5101    
5102           usually           usually
# Line 5088  Internet-Draft        LinuxSampler Contr Line 5126  Internet-Draft        LinuxSampler Contr
5126    
5127     Possible Answers:     Possible Answers:
5128    
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 91]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5129        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
5130        answer line begins with the information category name followed by        answer line begins with the information category name followed by
5131        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 5116  Internet-Draft        LinuxSampler Contr Line 5145  Internet-Draft        LinuxSampler Contr
5145    
5146           Name of the engine to be deployed for this instrument.           Name of the engine to be deployed for this instrument.
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires April 8, 2011                [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol         October 2010
5154    
5155    
5156        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
5157    
5158           File name of the instrument (note that this path may contain           File name of the instrument (note that this path may contain
# Line 5143  Internet-Draft        LinuxSampler Contr Line 5180  Internet-Draft        LinuxSampler Contr
5180           (where a value < 1.0 means attenuation and a value > 1.0 means           (where a value < 1.0 means attenuation and a value > 1.0 means
5181           amplification)           amplification)
5182    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 92]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5183        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
5184    
5185     Example:     Example:
# Line 5173  Internet-Draft        LinuxSampler Contr Line 5200  Internet-Draft        LinuxSampler Contr
5200    
5201           "VOLUME: 1.0"           "VOLUME: 1.0"
5202    
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires April 8, 2011                [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol         October 2010
5210    
5211    
5212           "."           "."
5213    
5214  6.7.12.  Clear MIDI instrument map  6.7.12.  Clear MIDI instrument map
# Line 5201  Internet-Draft        LinuxSampler Contr Line 5237  Internet-Draft        LinuxSampler Contr
5237    
5238     Examples:     Examples:
5239    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 93]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5240        C: "CLEAR MIDI_INSTRUMENTS 0"        C: "CLEAR MIDI_INSTRUMENTS 0"
5241    
5242        S: "OK"        S: "OK"
# Line 5228  Internet-Draft        LinuxSampler Contr Line 5256  Internet-Draft        LinuxSampler Contr
5256        name support escape sequences as described in chapter "Character        name support escape sequences as described in chapter "Character
5257        Set and Escape Sequences (Section 7.1)".        Set and Escape Sequences (Section 7.1)".
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires April 8, 2011                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol         October 2010
5266    
5267    
5268        All occurrences of a forward slash in instrument and directory        All occurrences of a forward slash in instrument and directory
5269        names are escaped with its hex (\x2f) or octal (\057) escape        names are escaped with its hex (\x2f) or octal (\057) escape
5270        sequence.        sequence.
# Line 5256  Internet-Draft        LinuxSampler Contr Line 5293  Internet-Draft        LinuxSampler Contr
5293    
5294     Examples:     Examples:
5295    
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 94]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5296        C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"        C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
5297    
5298        S: "OK"        S: "OK"
# Line 5284  Internet-Draft        LinuxSampler Contr Line 5312  Internet-Draft        LinuxSampler Contr
5312    
5313        "OK" -        "OK" -
5314    
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires April 8, 2011                [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol         October 2010
5322    
5323    
5324           if the directory is deleted successfully           if the directory is deleted successfully
5325    
5326        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5311  Internet-Draft        LinuxSampler Contr Line 5348  Internet-Draft        LinuxSampler Contr
5348    
5349     Possible Answers:     Possible Answers:
5350    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 95]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5351        The current number of instrument directories in the specified        The current number of instrument directories in the specified
5352        directory.        directory.
5353    
# Line 5342  Internet-Draft        LinuxSampler Contr Line 5369  Internet-Draft        LinuxSampler Contr
5369        LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>        LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
5370    
5371     Where <dir> should be replaced by the absolute path name of the     Where <dir> should be replaced by the absolute path name of the
5372    
5373    
5374    
5375    Schoenebeck               Expires April 8, 2011                [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol         October 2010
5378    
5379    
5380     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
5381     directories, including those located in subdirectories of the     directories, including those located in subdirectories of the
5382     specified directory, will be returned.     specified directory, will be returned.
# Line 5366  Internet-Draft        LinuxSampler Contr Line 5401  Internet-Draft        LinuxSampler Contr
5401        S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano        S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
5402        Collection/Acoustic/New','/Percussion Collection'"        Collection/Acoustic/New','/Percussion Collection'"
5403    
   
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 96]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
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 5402  Internet-Draft        LinuxSampler Contr Line 5426  Internet-Draft        LinuxSampler Contr
5426              A brief description of the directory content.  Note that the              A brief description of the directory content.  Note that the
5427              character string may contain escape sequences (Section 7.1).              character string may contain escape sequences (Section 7.1).
5428    
5429    
5430    
5431    Schoenebeck               Expires April 8, 2011                [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol         October 2010
5434    
5435    
5436           CREATED -           CREATED -
5437    
5438              The creation date and time of the directory, represented in              The creation date and time of the directory, represented in
# Line 5425  Internet-Draft        LinuxSampler Contr Line 5456  Internet-Draft        LinuxSampler Contr
5456    
5457           "MODIFIED: 2007-04-07 12:50:21"           "MODIFIED: 2007-04-07 12:50:21"
5458    
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 97]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5459           "."           "."
5460    
5461  6.8.6.  Renaming an instrument directory  6.8.6.  Renaming an instrument directory
# Line 5458  Internet-Draft        LinuxSampler Contr Line 5481  Internet-Draft        LinuxSampler Contr
5481    
5482     Example:     Example:
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires April 8, 2011                [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol         October 2010
5490    
5491    
5492        C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'        C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5493        'Acoustic'"        'Acoustic'"
5494    
# Line 5479  Internet-Draft        LinuxSampler Contr Line 5510  Internet-Draft        LinuxSampler Contr
5510    
5511           on success           on success
5512    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 98]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5513        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5514    
5515           in case a given directory does not exists, or if a directory           in case a given directory does not exists, or if a directory
# Line 5515  Internet-Draft        LinuxSampler Contr Line 5536  Internet-Draft        LinuxSampler Contr
5536    
5537     Possible Answers:     Possible Answers:
5538    
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires April 8, 2011                [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol         October 2010
5546    
5547    
5548        "OK" -        "OK" -
5549    
5550           on success           on success
# Line 5533  Internet-Draft        LinuxSampler Contr Line 5563  Internet-Draft        LinuxSampler Contr
5563    
5564        S: "OK"        S: "OK"
5565    
   
   
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011                [Page 99]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5566  6.8.9.  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
# Line 5574  Internet-Draft        LinuxSampler Contr Line 5592  Internet-Draft        LinuxSampler Contr
5592    
5593        S: "OK"        S: "OK"
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck               Expires April 8, 2011               [Page 100]
5600    
5601    Internet-Draft        LinuxSampler Control Protocol         October 2010
5602    
5603    
5604  6.8.10.  Finding directories  6.8.10.  Finding directories
5605    
5606     The front-end can search for directories in specific directory by     The front-end can search for directories in specific directory by
# Line 5593  Internet-Draft        LinuxSampler Contr Line 5620  Internet-Draft        LinuxSampler Contr
5620    
5621        Restricts the search to directories, which names satisfy the        Restricts the search to directories, which names satisfy the
5622        supplied search string (encapsulated into apostrophes, supporting        supplied search string (encapsulated into apostrophes, supporting
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 100]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5623        escape sequences as described in chapter "Character Set and Escape        escape sequences as described in chapter "Character Set and Escape
5624        Sequences (Section 7.1)").        Sequences (Section 7.1)").
5625    
# Line 5630  Internet-Draft        LinuxSampler Contr Line 5649  Internet-Draft        LinuxSampler Contr
5649        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
5650        "Character Set and Escape Sequences (Section 7.1)").        "Character Set and Escape Sequences (Section 7.1)").
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires April 8, 2011               [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol         October 2010
5658    
5659    
5660     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
5661     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
5662    
# Line 5649  Internet-Draft        LinuxSampler Contr Line 5676  Internet-Draft        LinuxSampler Contr
5676    
5677        S: "'/Piano Collection'"        S: "'/Piano Collection'"
5678    
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 101]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5679        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:        C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5680        30:13'"        30:13'"
5681    
# Line 5684  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 April 8, 2011               [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol         October 2010
5714    
5715    
5716        "RECURSIVE" -        "RECURSIVE" -
5717    
5718           All instruments will be processed, including those in the           All instruments will be processed, including those in the
# Line 5705  Internet-Draft        LinuxSampler Contr Line 5734  Internet-Draft        LinuxSampler Contr
5734     If FILE_AS_DIR argument is supplied, all instruments in an instrument     If FILE_AS_DIR argument is supplied, all instruments in an instrument
5735     file will be added to a separate directory in the instruments     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     database, which name will be the name of the instrument file with the
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 102]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5737     file extension stripped off.     file extension stripped off.
5738    
5739     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
# Line 5739  Internet-Draft        LinuxSampler Contr Line 5760  Internet-Draft        LinuxSampler Contr
5760    
5761     Examples:     Examples:
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck               Expires April 8, 2011               [Page 103]
5768    
5769    Internet-Draft        LinuxSampler Control Protocol         October 2010
5770    
5771    
5772        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5773        Bosendorfer 290.gig' 0"        Bosendorfer 290.gig' 0"
5774    
# Line 5760  Internet-Draft        LinuxSampler Contr Line 5790  Internet-Draft        LinuxSampler Contr
5790    
5791           if the instrument is removed successfully           if the instrument is removed successfully
5792    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 103]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5793        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5794    
5795           if the given path does not exist or is a directory.           if the given path does not exist or is a directory.
# Line 5795  Internet-Draft        LinuxSampler Contr Line 5816  Internet-Draft        LinuxSampler Contr
5816    
5817        The current number of instruments in the specified directory.        The current number of instruments in the specified directory.
5818    
5819    
5820    
5821    
5822    
5823    Schoenebeck               Expires April 8, 2011               [Page 104]
5824    
5825    Internet-Draft        LinuxSampler Control Protocol         October 2010
5826    
5827    
5828        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
5829    
5830           if the given directory does not exist.           if the given directory does not exist.
# Line 5817  Internet-Draft        LinuxSampler Contr Line 5847  Internet-Draft        LinuxSampler Contr
5847     instruments, including those located in subdirectories of the     instruments, including those located in subdirectories of the
5848     specified directory, will be returned.     specified directory, will be returned.
5849    
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 104]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5850     Possible Answers:     Possible Answers:
5851    
5852        A comma separated list of all instruments (encapsulated into        A comma separated list of all instruments (encapsulated into
# Line 5850  Internet-Draft        LinuxSampler Contr Line 5872  Internet-Draft        LinuxSampler Contr
5872     The front-end can ask for the current settings of an instrument by     The front-end can ask for the current settings of an instrument by
5873     sending the following command:     sending the following command:
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck               Expires April 8, 2011               [Page 105]
5880    
5881    Internet-Draft        LinuxSampler Control Protocol         October 2010
5882    
5883    
5884        GET DB_INSTRUMENT INFO <instr_path>        GET DB_INSTRUMENT INFO <instr_path>
5885    
5886     Where <instr_path> should be replaced by the absolute path name of     Where <instr_path> should be replaced by the absolute path name of
# Line 5872  Internet-Draft        LinuxSampler Contr Line 5903  Internet-Draft        LinuxSampler Contr
5903    
5904           INSTRUMENT_NR -           INSTRUMENT_NR -
5905    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 105]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5906              Index of the instrument within the file.              Index of the instrument within the file.
5907    
5908           FORMAT_FAMILY -           FORMAT_FAMILY -
# Line 5907  Internet-Draft        LinuxSampler Contr Line 5929  Internet-Draft        LinuxSampler Contr
5929              instrument's database settings, represented in "YYYY-MM-DD              instrument's database settings, represented in "YYYY-MM-DD
5930              HH:MM:SS" format              HH:MM:SS" format
5931    
5932    
5933    
5934    
5935    Schoenebeck               Expires April 8, 2011               [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol         October 2010
5938    
5939    
5940           DESCRIPTION -           DESCRIPTION -
5941    
5942              A brief description of the instrument.  Note that the              A brief description of the instrument.  Note that the
# Line 5927  Internet-Draft        LinuxSampler Contr Line 5957  Internet-Draft        LinuxSampler Contr
5957              Lists the artist names.  Note that the character string may              Lists the artist names.  Note that the character string may
5958              contain escape sequences (Section 7.1).              contain escape sequences (Section 7.1).
5959    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 106]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
5960           KEYWORDS -           KEYWORDS -
5961    
5962              Provides a list of keywords that refer to the instrument.              Provides a list of keywords that refer to the instrument.
# Line 5964  Internet-Draft        LinuxSampler Contr Line 5984  Internet-Draft        LinuxSampler Contr
5984    
5985           "MODIFIED: 2007-04-07 12:50:21"           "MODIFIED: 2007-04-07 12:50:21"
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck               Expires April 8, 2011               [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol         October 2010
5994    
5995    
5996           "DESCRIPTION: "           "DESCRIPTION: "
5997    
5998           "IS_DRUM: false"           "IS_DRUM: false"
# Line 5986  Internet-Draft        LinuxSampler Contr Line 6015  Internet-Draft        LinuxSampler Contr
6015     Where <instr> is the absolute path name of the instrument and <name>     Where <instr> is the absolute path name of the instrument and <name>
6016     is the new name for that instrument.     is the new name for that instrument.
6017    
   
   
 Schoenebeck               Expires April 8, 2011               [Page 107]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6018     Possible Answers:     Possible Answers:
6019    
6020        "OK" -        "OK" -
# Line 6019  Internet-Draft        LinuxSampler Contr Line 6041  Internet-Draft        LinuxSampler Contr
6041        MOVE DB_INSTRUMENT <instr> <dst>        MOVE DB_INSTRUMENT <instr> <dst>
6042    
6043     Where <instr> is the absolute path name of the instrument to move and     Where <instr> is the absolute path name of the instrument to move and
6044    
6045    
6046    
6047    Schoenebeck               Expires April 8, 2011               [Page 108]
6048    
6049    Internet-Draft        LinuxSampler Control Protocol         October 2010
6050    
6051    
6052     <dst> is the directory where the instrument will be moved to.     <dst> is the directory where the instrument will be moved to.
6053    
6054     Possible Answers:     Possible Answers:
# Line 6040  Internet-Draft        LinuxSampler Contr Line 6070  Internet-Draft        LinuxSampler Contr
6070    
6071        S: "OK"        S: "OK"
6072    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 108]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6073  6.8.18.  Copying instruments  6.8.18.  Copying instruments
6074    
6075     The front-end can copy a specific instrument to another directory by     The front-end can copy a specific instrument to another directory by
# Line 6076  Internet-Draft        LinuxSampler Contr Line 6097  Internet-Draft        LinuxSampler Contr
6097        C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'        C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
6098        '/Acoustic/Pianos/'"        '/Acoustic/Pianos/'"
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires April 8, 2011               [Page 109]
6104    
6105    Internet-Draft        LinuxSampler Control Protocol         October 2010
6106    
6107    
6108        S: "OK"        S: "OK"
6109    
6110  6.8.19.  Changing the description of instrument  6.8.19.  Changing the description of instrument
# Line 6096  Internet-Draft        LinuxSampler Contr Line 6125  Internet-Draft        LinuxSampler Contr
6125    
6126           on success           on success
6127    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 109]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6128        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6129    
6130           in case the given instrument does not exists.           in case the given instrument does not exists.
# Line 6132  Internet-Draft        LinuxSampler Contr Line 6152  Internet-Draft        LinuxSampler Contr
6152    
6153     NAME='<search-string>'     NAME='<search-string>'
6154    
6155    
6156    
6157    
6158    
6159    Schoenebeck               Expires April 8, 2011               [Page 110]
6160    
6161    Internet-Draft        LinuxSampler Control Protocol         October 2010
6162    
6163    
6164        Restricts the search to instruments, which names satisfy the        Restricts the search to instruments, which names satisfy the
6165        supplied search string (encapsulated into apostrophes, supporting        supplied search string (encapsulated into apostrophes, supporting
6166        escape sequences as described in chapter "Character Set and Escape        escape sequences as described in chapter "Character Set and Escape
# Line 6154  Internet-Draft        LinuxSampler Contr Line 6183  Internet-Draft        LinuxSampler Contr
6183        If <date-before> is omitted, the search is restricted to        If <date-before> is omitted, the search is restricted to
6184        instruments created after <date-after>.        instruments created after <date-after>.
6185    
   
   
 Schoenebeck               Expires April 8, 2011               [Page 110]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6186     MODIFIED='[<date-after>]..[<date-before>]'     MODIFIED='[<date-after>]..[<date-before>]'
6187    
6188        Restricts the search to instruments, which date of last        Restricts the search to instruments, which date of last
# Line 6187  Internet-Draft        LinuxSampler Contr Line 6209  Internet-Draft        LinuxSampler Contr
6209    
6210     ARTISTS='<search-string>'     ARTISTS='<search-string>'
6211    
6212    
6213    
6214    
6215    Schoenebeck               Expires April 8, 2011               [Page 111]
6216    
6217    Internet-Draft        LinuxSampler Control Protocol         October 2010
6218    
6219    
6220        Restricts the search to instruments with artists info that        Restricts the search to instruments with artists info that
6221        satisfies the supplied search string (encapsulated into        satisfies the supplied search string (encapsulated into
6222        apostrophes, supporting escape sequences as described in chapter        apostrophes, supporting escape sequences as described in chapter
# Line 6210  Internet-Draft        LinuxSampler Contr Line 6240  Internet-Draft        LinuxSampler Contr
6240        families, where <format-list> is a comma separated list of format        families, where <format-list> is a comma separated list of format
6241        families.        families.
6242    
   
   
 Schoenebeck               Expires April 8, 2011               [Page 111]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6243     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
6244     separated with spaces for OR search and with '+' for AND search.     separated with spaces for OR search and with '+' for AND search.
6245    
# Line 6243  Internet-Draft        LinuxSampler Contr Line 6266  Internet-Draft        LinuxSampler Contr
6266        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/        S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
6267        Steinway D'"        Steinway D'"
6268    
6269    
6270    
6271    Schoenebeck               Expires April 8, 2011               [Page 112]
6272    
6273    Internet-Draft        LinuxSampler Control Protocol         October 2010
6274    
6275    
6276  6.8.21.  Getting job status information  6.8.21.  Getting job status information
6277    
6278     The front-end can ask for the current status of a particular database     The front-end can ask for the current status of a particular database
# Line 6265  Internet-Draft        LinuxSampler Contr Line 6295  Internet-Draft        LinuxSampler Contr
6295    
6296           FILES_TOTAL -           FILES_TOTAL -
6297    
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 112]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6298              The total number of files scheduled for scanning              The total number of files scheduled for scanning
6299    
6300           FILES_SCANNED -           FILES_SCANNED -
# Line 6298  Internet-Draft        LinuxSampler Contr Line 6320  Internet-Draft        LinuxSampler Contr
6320    
6321        S: "FILES_TOTAL: 12"        S: "FILES_TOTAL: 12"
6322    
6323    
6324    
6325    
6326    
6327    Schoenebeck               Expires April 8, 2011               [Page 113]
6328    
6329    Internet-Draft        LinuxSampler Control Protocol         October 2010
6330    
6331    
6332           "FILES_SCANNED: 7"           "FILES_SCANNED: 7"
6333    
6334           "SCANNING: /home/me/gigs/Bosendorfer 290.gig"           "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
# Line 6320  Internet-Draft        LinuxSampler Contr Line 6351  Internet-Draft        LinuxSampler Contr
6351    
6352           on success           on success
6353    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 113]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6354        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6355    
6356           If the formatting of the instruments database failed.           If the formatting of the instruments database failed.
# Line 6353  Internet-Draft        LinuxSampler Contr Line 6375  Internet-Draft        LinuxSampler Contr
6375    
6376     Example:     Example:
6377    
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck               Expires April 8, 2011               [Page 114]
6384    
6385    Internet-Draft        LinuxSampler Control Protocol         October 2010
6386    
6387    
6388        C: "FIND LOST DB_INSTRUMENT_FILES"        C: "FIND LOST DB_INSTRUMENT_FILES"
6389    
6390        S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free        S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free
# Line 6375  Internet-Draft        LinuxSampler Contr Line 6407  Internet-Draft        LinuxSampler Contr
6407    
6408           on success           on success
6409    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 114]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6410        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6411    
6412           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 6409  Internet-Draft        LinuxSampler Contr Line 6431  Internet-Draft        LinuxSampler Contr
6431     At the moment there is only one command for this feature set, but     At the moment there is only one command for this feature set, but
6432     this will most probably change in future.     this will most probably change in future.
6433    
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck               Expires April 8, 2011               [Page 115]
6440    
6441    Internet-Draft        LinuxSampler Control Protocol         October 2010
6442    
6443    
6444  6.9.1.  Opening an appropriate instrument editor application  6.9.1.  Opening an appropriate instrument editor application
6445    
6446     The front-end can request to open an appropriate instrument editor     The front-end can request to open an appropriate instrument editor
# Line 6434  Internet-Draft        LinuxSampler Contr Line 6466  Internet-Draft        LinuxSampler Contr
6466     Note: consequently instrument editors are always spawned locally on     Note: consequently instrument editors are always spawned locally on
6467     the same machine where the sampler is running on!     the same machine where the sampler is running on!
6468    
   
   
 Schoenebeck               Expires April 8, 2011               [Page 115]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6469     Possible Answers:     Possible Answers:
6470    
6471        "OK" -        "OK" -
# Line 6462  Internet-Draft        LinuxSampler Contr Line 6487  Internet-Draft        LinuxSampler Contr
6487    
6488        S: "OK"        S: "OK"
6489    
6490    
6491    
6492    
6493    
6494    
6495    Schoenebeck               Expires April 8, 2011               [Page 116]
6496    
6497    Internet-Draft        LinuxSampler Control Protocol         October 2010
6498    
6499    
6500  6.10.  Managing Files  6.10.  Managing Files
6501    
6502     You can query detailed informations about files located at the same     You can query detailed informations about files located at the same
# Line 6489  Internet-Draft        LinuxSampler Contr Line 6524  Internet-Draft        LinuxSampler Contr
6524        On success, the sampler will answer by returning the amount of        On success, the sampler will answer by returning the amount of
6525        instruments.        instruments.
6526    
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 116]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6527        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
6528    
6529           if the file could not be handled           if the file could not be handled
# Line 6518  Internet-Draft        LinuxSampler Contr Line 6545  Internet-Draft        LinuxSampler Contr
6545     into apostrophes, supporting escape sequences as described in chapter     into apostrophes, supporting escape sequences as described in chapter
6546     "Character Set and Escape Sequences (Section 7.1)").     "Character Set and Escape Sequences (Section 7.1)").
6547    
6548    
6549    
6550    
6551    Schoenebeck               Expires April 8, 2011               [Page 117]
6552    
6553    Internet-Draft        LinuxSampler Control Protocol         October 2010
6554    
6555    
6556     The sampler will try to ask all sampler engines, whether they support     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     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.     list of IDs for the instruments in the given file.
# Line 6543  Internet-Draft        LinuxSampler Contr Line 6578  Internet-Draft        LinuxSampler Contr
6578     instrument within a given instrument file by sending the following     instrument within a given instrument file by sending the following
6579     command:     command:
6580    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 117]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6581        GET FILE INSTRUMENT INFO <filename> <instr-id>        GET FILE INSTRUMENT INFO <filename> <instr-id>
6582    
6583     Where <filename> is the name of the instrument file (encapsulated     Where <filename> is the name of the instrument file (encapsulated
# Line 6575  Internet-Draft        LinuxSampler Contr Line 6600  Internet-Draft        LinuxSampler Contr
6600    
6601    
6602    
6603    
6604    
6605    
6606    
6607    Schoenebeck               Expires April 8, 2011               [Page 118]
6608    
6609    Internet-Draft        LinuxSampler Control Protocol         October 2010
6610    
6611    
6612           NAME -           NAME -
6613    
6614              name of the instrument as stored in the instrument file              name of the instrument as stored in the instrument file
# Line 6602  Internet-Draft        LinuxSampler Contr Line 6636  Internet-Draft        LinuxSampler Contr
6636              instrument's key mapping in the range between 0 .. 127,              instrument's key mapping in the range between 0 .. 127,
6637              reflecting the analog meaning of the MIDI specification.              reflecting the analog meaning of the MIDI specification.
6638    
   
   
 Schoenebeck               Expires April 8, 2011               [Page 118]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6639           KEYSWITCH_BINDINGS -           KEYSWITCH_BINDINGS -
6640    
6641              comma separated list of integer values representing the              comma separated list of integer values representing the
# Line 6630  Internet-Draft        LinuxSampler Contr Line 6657  Internet-Draft        LinuxSampler Contr
6657    
6658           "PRODUCT: The Backbone Bongo Beats"           "PRODUCT: The Backbone Bongo Beats"
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires April 8, 2011               [Page 119]
6664    
6665    Internet-Draft        LinuxSampler Control Protocol         October 2010
6666    
6667    
6668           "ARTISTS: Jimmy the Fish"           "ARTISTS: Jimmy the Fish"
6669    
6670           "."           "."
# Line 6657  Internet-Draft        LinuxSampler Contr Line 6692  Internet-Draft        LinuxSampler Contr
6692     effect instances.  The output of the first effect instance in an     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     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.     chain and so on.  So effects in one chain are processed sequentially.
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 119]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6695     Send effect chains however are processed in parallel to other send     Send effect chains however are processed in parallel to other send
6696     effect chains.  Audio signals of sampler channels are fed to send     effect chains.  Audio signals of sampler channels are fed to send
6697     effects by creating FX sends to the respective sampler channel and     effects by creating FX sends to the respective sampler channel and
6698     assigning a destination send effect to that FX by using the "SET     assigning a destination send effect to that FX by using the "SET
6699     FX_SEND SEND_EFFECT" (Section 6.4.32) command.  The latter allows to     FX_SEND EFFECT" (Section 6.4.32) command.  The latter allows to route
6700     route the FX send to the beginning of a send effect chain, as well as     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.     directly to any other position of the send effect chain.
6702    
6703  6.11.1.  Retrieve amount of available effects  6.11.1.  Retrieve amount of available effects
# Line 6687  Internet-Draft        LinuxSampler Contr Line 6714  Internet-Draft        LinuxSampler Contr
6714    
6715     Examples:     Examples:
6716    
6717    
6718    
6719    Schoenebeck               Expires April 8, 2011               [Page 120]
6720    
6721    Internet-Draft        LinuxSampler Control Protocol         October 2010
6722    
6723    
6724        C: "GET AVAILABLE_EFFECTS"        C: "GET AVAILABLE_EFFECTS"
6725    
6726        S: "129"        S: "129"
# Line 6713  Internet-Draft        LinuxSampler Contr Line 6747  Internet-Draft        LinuxSampler Contr
6747    
6748        S: "5,6,7,120,121,122,123,124"        S: "5,6,7,120,121,122,123,124"
6749    
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 120]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6750  6.11.3.  Retrieving general information about an effect  6.11.3.  Retrieving general information about an effect
6751    
6752     The front-end can ask for general informations about an effect by     The front-end can ask for general informations about an effect by
# Line 6743  Internet-Draft        LinuxSampler Contr Line 6769  Internet-Draft        LinuxSampler Contr
6769    
6770           SYSTEM -           SYSTEM -
6771    
6772    
6773    
6774    
6775    Schoenebeck               Expires April 8, 2011               [Page 121]
6776    
6777    Internet-Draft        LinuxSampler Control Protocol         October 2010
6778    
6779    
6780              name of the effect plugin system the effect is based on              name of the effect plugin system the effect is based on
6781              (e.g.  "LADSPA")              (e.g.  "LADSPA")
6782    
# Line 6770  Internet-Draft        LinuxSampler Contr Line 6804  Internet-Draft        LinuxSampler Contr
6804    
6805     Example:     Example:
6806    
   
   
 Schoenebeck               Expires April 8, 2011               [Page 121]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6807        C: "GET EFFECT INFO 121"        C: "GET EFFECT INFO 121"
6808    
6809        S: "SYSTEM: LADSPA"        S: "SYSTEM: LADSPA"
# Line 6798  Internet-Draft        LinuxSampler Contr Line 6825  Internet-Draft        LinuxSampler Contr
6825    
6826     Where <effect-system> is the "SYSTEM" field, <module> the "MODULE"     Where <effect-system> is the "SYSTEM" field, <module> the "MODULE"
6827     field and <effect-name> the "NAME" field as returned by the "GET     field and <effect-name> the "NAME" field as returned by the "GET
6828    
6829    
6830    
6831    Schoenebeck               Expires April 8, 2011               [Page 122]
6832    
6833    Internet-Draft        LinuxSampler Control Protocol         October 2010
6834    
6835    
6836     EFFECT INFO" (Section 6.11.3) command.  The filename of argument     EFFECT INFO" (Section 6.11.3) command.  The filename of argument
6837     <module> and the character string of argument <effect-name> may     <module> and the character string of argument <effect-name> may
6838     contain escape sequences (Section 7.1).     contain escape sequences (Section 7.1).
# Line 6824  Internet-Draft        LinuxSampler Contr Line 6859  Internet-Draft        LinuxSampler Contr
6859           <effect-instance> is the numerical ID of the new effect           <effect-instance> is the numerical ID of the new effect
6860           instance           instance
6861    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 122]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6862        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
6863    
6864           in case the effect instance was spawned successfully, but there           in case the effect instance was spawned successfully, but there
# Line 6855  Internet-Draft        LinuxSampler Contr Line 6881  Internet-Draft        LinuxSampler Contr
6881     The front-end can spawn an instance of the desired effect by sending     The front-end can spawn an instance of the desired effect by sending
6882     the following command:     the following command:
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires April 8, 2011               [Page 123]
6888    
6889    Internet-Draft        LinuxSampler Control Protocol         October 2010
6890    
6891    
6892        CREATE EFFECT_INSTANCE <effect-index>        CREATE EFFECT_INSTANCE <effect-index>
6893    
6894     Where <effect-index> is the numerical ID of the effect as returned by     Where <effect-index> is the numerical ID of the effect as returned by
# Line 6880  Internet-Draft        LinuxSampler Contr Line 6914  Internet-Draft        LinuxSampler Contr
6914           <effect-instance> is the numerical ID of the new effect           <effect-instance> is the numerical ID of the new effect
6915           instance           instance
6916    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 123]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6917        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
6918    
6919           in case the effect instance was spawned successfully, but there           in case the effect instance was spawned successfully, but there
# Line 6910  Internet-Draft        LinuxSampler Contr Line 6935  Internet-Draft        LinuxSampler Contr
6935     The front-end can destroy an unusued effect instance and thus freeing     The front-end can destroy an unusued effect instance and thus freeing
6936     it from memory by sending the following command:     it from memory by sending the following command:
6937    
6938    
6939    
6940    
6941    
6942    
6943    Schoenebeck               Expires April 8, 2011               [Page 124]
6944    
6945    Internet-Draft        LinuxSampler Control Protocol         October 2010
6946    
6947    
6948        DESTROY EFFECT_INSTANCE <effect-instance>        DESTROY EFFECT_INSTANCE <effect-instance>
6949    
6950     Where <effect-instance> is the numerical ID of the effect instance as     Where <effect-instance> is the numerical ID of the effect instance as
# Line 6936  Internet-Draft        LinuxSampler Contr Line 6971  Internet-Draft        LinuxSampler Contr
6971    
6972        C: "DESTROY EFFECT_INSTANCE 5"        C: "DESTROY EFFECT_INSTANCE 5"
6973    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 124]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
6974        S: "OK"        S: "OK"
6975    
6976  6.11.7.  Retrieve amount of effect instances  6.11.7.  Retrieve amount of effect instances
# Line 6966  Internet-Draft        LinuxSampler Contr Line 6992  Internet-Draft        LinuxSampler Contr
6992    
6993        S: "14"        S: "14"
6994    
6995    
6996    
6997    
6998    
6999    Schoenebeck               Expires April 8, 2011               [Page 125]
7000    
7001    Internet-Draft        LinuxSampler Control Protocol         October 2010
7002    
7003    
7004  6.11.8.  Get list of effect instances  6.11.8.  Get list of effect instances
7005    
7006     The front-end can retrieve the current list of effect instances by     The front-end can retrieve the current list of effect instances by
# Line 6993  Internet-Draft        LinuxSampler Contr Line 7028  Internet-Draft        LinuxSampler Contr
7028    
7029     Where <effect-instance> is the numerical ID of an effect instance as     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     returned by the "CREATE EFFECT_INSTANCE" (Section 6.11.4) or "LIST
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 125]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7031     EFFECT_INSTANCES" (Section 6.11.8) command.     EFFECT_INSTANCES" (Section 6.11.8) command.
7032    
7033     Possible Answers:     Possible Answers:
# Line 7022  Internet-Draft        LinuxSampler Contr Line 7049  Internet-Draft        LinuxSampler Contr
7049    
7050              module of the effect plugin system that contains this              module of the effect plugin system that contains this
7051              effect, the module is usually the dynamic-linked library              effect, the module is usually the dynamic-linked library
7052    
7053    
7054    
7055    Schoenebeck               Expires April 8, 2011               [Page 126]
7056    
7057    Internet-Draft        LinuxSampler Control Protocol         October 2010
7058    
7059    
7060              (DLL) filename of the effect plugin, including full path              (DLL) filename of the effect plugin, including full path
7061              (note that this filename may contain escape sequences              (note that this filename may contain escape sequences
7062              (Section 7.1))              (Section 7.1))
# Line 7047  Internet-Draft        LinuxSampler Contr Line 7082  Internet-Draft        LinuxSampler Contr
7082    
7083     Example:     Example:
7084    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 126]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7085        C: "GET EFFECT_INSTANCE INFO 3"        C: "GET EFFECT_INSTANCE INFO 3"
7086    
7087        S: "SYSTEM: LADSPA"        S: "SYSTEM: LADSPA"
# Line 7080  Internet-Draft        LinuxSampler Contr Line 7105  Internet-Draft        LinuxSampler Contr
7105     front-end can ask for the current informations of an effect     front-end can ask for the current informations of an effect
7106     instance's input control by sending the following command:     instance's input control by sending the following command:
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires April 8, 2011               [Page 127]
7112    
7113    Internet-Draft        LinuxSampler Control Protocol         October 2010
7114    
7115    
7116        GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-        GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-
7117        control>        control>
7118    
# Line 7105  Internet-Draft        LinuxSampler Contr Line 7138  Internet-Draft        LinuxSampler Contr
7138    
7139           DESCRIPTION -           DESCRIPTION -
7140    
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 127]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7141              (always returned) human readable name of the effect              (always returned) human readable name of the effect
7142              parameter, intended to be displayed in user interfaces (note              parameter, intended to be displayed in user interfaces (note
7143              that the character string may contain escape sequences              that the character string may contain escape sequences
# Line 7135  Internet-Draft        LinuxSampler Contr Line 7160  Internet-Draft        LinuxSampler Contr
7160    
7161           POSSIBILITIES -           POSSIBILITIES -
7162    
7163    
7164    
7165    
7166    
7167    Schoenebeck               Expires April 8, 2011               [Page 128]
7168    
7169    Internet-Draft        LinuxSampler Control Protocol         October 2010
7170    
7171    
7172              (optionally returned) comma separated list of (optional              (optionally returned) comma separated list of (optional
7173              dotted) floating point numbers, reflecting the exact set of              dotted) floating point numbers, reflecting the exact set of
7174              possible values for this effect parameter              possible values for this effect parameter
# Line 7159  Internet-Draft        LinuxSampler Contr Line 7193  Internet-Draft        LinuxSampler Contr
7193    
7194           "."           "."
7195    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 128]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7196  6.11.11.  Altering an effect parameter  6.11.11.  Altering an effect parameter
7197    
7198     The front-end can alter the current value of an effect parameter by     The front-end can alter the current value of an effect parameter by
# Line 7191  Internet-Draft        LinuxSampler Contr Line 7215  Internet-Draft        LinuxSampler Contr
7215    
7216           in case the effect was altered successfully           in case the effect was altered successfully
7217    
7218    
7219    
7220    
7221    
7222    
7223    Schoenebeck               Expires April 8, 2011               [Page 129]
7224    
7225    Internet-Draft        LinuxSampler Control Protocol         October 2010
7226    
7227    
7228        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
7229    
7230           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 7216  Internet-Draft        LinuxSampler Contr Line 7250  Internet-Draft        LinuxSampler Contr
7250    
7251     Possible Answers:     Possible Answers:
7252    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 129]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7253        The sampler will answer by returning the current number of send        The sampler will answer by returning the current number of send
7254        effect chains of the supplied audio output device.        effect chains of the supplied audio output device.
7255    
# Line 7248  Internet-Draft        LinuxSampler Contr Line 7273  Internet-Draft        LinuxSampler Contr
7273    
7274     Possible Answers:     Possible Answers:
7275    
7276    
7277    
7278    
7279    Schoenebeck               Expires April 8, 2011               [Page 130]
7280    
7281    Internet-Draft        LinuxSampler Control Protocol         October 2010
7282    
7283    
7284        The sampler will answer by returning a comma separated list with        The sampler will answer by returning a comma separated list with
7285        numerical IDs of send effect chains of the supplied audio output        numerical IDs of send effect chains of the supplied audio output
7286        device.        device.
# Line 7272  Internet-Draft        LinuxSampler Contr Line 7305  Internet-Draft        LinuxSampler Contr
7305    
7306     Possible Answers:     Possible Answers:
7307    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 130]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7308        "OK[<effect-chain>]" -        "OK[<effect-chain>]" -
7309    
7310           in case the send effect chain was added successfully, where           in case the send effect chain was added successfully, where
# Line 7305  Internet-Draft        LinuxSampler Contr Line 7329  Internet-Draft        LinuxSampler Contr
7329    
7330     Where <audio-device> should be replaced by the numerical ID of the     Where <audio-device> should be replaced by the numerical ID of the
7331     audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"     audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7332    
7333    
7334    
7335    Schoenebeck               Expires April 8, 2011               [Page 131]
7336    
7337    Internet-Draft        LinuxSampler Control Protocol         October 2010
7338    
7339    
7340     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
7341     command and <effect-chain> by the numerical ID as returned by the     command and <effect-chain> by the numerical ID as returned by the
7342     "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST     "ADD SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST
# Line 7326  Internet-Draft        LinuxSampler Contr Line 7358  Internet-Draft        LinuxSampler Contr
7358    
7359        S: "OK"        S: "OK"
7360    
   
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 131]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7361  6.11.16.  Retrieving information about a send effect chain  6.11.16.  Retrieving information about a send effect chain
7362    
7363     The front-end can ask for informations of a send effect chain by     The front-end can ask for informations of a send effect chain by
# Line 7363  Internet-Draft        LinuxSampler Contr Line 7384  Internet-Draft        LinuxSampler Contr
7384    
7385           EFFECT_COUNT -           EFFECT_COUNT -
7386    
7387    
7388    
7389    
7390    
7391    Schoenebeck               Expires April 8, 2011               [Page 132]
7392    
7393    Internet-Draft        LinuxSampler Control Protocol         October 2010
7394    
7395    
7396              amount of effects in this send effect chain              amount of effects in this send effect chain
7397    
7398           EFFECT_SEQUENCE -           EFFECT_SEQUENCE -
# Line 7383  Internet-Draft        LinuxSampler Contr Line 7413  Internet-Draft        LinuxSampler Contr
7413    
7414           "."           "."
7415    
   
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 132]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7416  6.11.17.  Append effect instance to a send effect chain  6.11.17.  Append effect instance to a send effect chain
7417    
7418     The front-end can add an unused effect instance to the end of a send     The front-end can add an unused effect instance to the end of a send
# Line 7420  Internet-Draft        LinuxSampler Contr Line 7440  Internet-Draft        LinuxSampler Contr
7440    
7441           in case the effect instance was added successfully to the chain           in case the effect instance was added successfully to the chain
7442    
7443    
7444    
7445    
7446    
7447    Schoenebeck               Expires April 8, 2011               [Page 133]
7448    
7449    Internet-Draft        LinuxSampler Control Protocol         October 2010
7450    
7451    
7452        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
7453    
7454           if the effect instance could not be added           if the effect instance could not be added
# Line 7441  Internet-Draft        LinuxSampler Contr Line 7470  Internet-Draft        LinuxSampler Contr
7470     Where <audio-device> should be replaced by the numerical ID of the     Where <audio-device> should be replaced by the numerical ID of the
7471     audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"     audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
7472     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 133]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7473     command, <effect-chain> by the numerical ID as returned by the "ADD     command, <effect-chain> by the numerical ID as returned by the "ADD
7474     SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"     SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
7475     (Section 6.11.13) command, <effect-instance> as returned by the     (Section 6.11.13) command, <effect-instance> as returned by the
# Line 7476  Internet-Draft        LinuxSampler Contr Line 7497  Internet-Draft        LinuxSampler Contr
7497    
7498        S: "OK"        S: "OK"
7499    
7500    
7501    
7502    
7503    Schoenebeck               Expires April 8, 2011               [Page 134]
7504    
7505    Internet-Draft        LinuxSampler Control Protocol         October 2010
7506    
7507    
7508  6.11.19.  Remove effect instance from send effect chain  6.11.19.  Remove effect instance from send effect chain
7509    
7510     The front-end can remove an effect instance from a certain position     The front-end can remove an effect instance from a certain position
# Line 7496  Internet-Draft        LinuxSampler Contr Line 7525  Internet-Draft        LinuxSampler Contr
7525    
7526        "OK" -        "OK" -
7527    
   
   
   
   
 Schoenebeck               Expires April 8, 2011               [Page 134]  
   
 Internet-Draft        LinuxSampler Control Protocol         October 2010  
   
   
7528           in case the effect instance was removed successfully           in case the effect instance was removed successfully
7529    
7530        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 7536  Internet-Draft        LinuxSampler Contr Line 7556  Internet-Draft        LinuxSampler Contr
7556    
7557    
7558    
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
7559  Schoenebeck               Expires April 8, 2011               [Page 135]  Schoenebeck               Expires April 8, 2011               [Page 135]
7560    
7561  Internet-Draft        LinuxSampler Control Protocol         October 2010  Internet-Draft        LinuxSampler Control Protocol         October 2010
# Line 7858  Internet-Draft        LinuxSampler Contr Line 7858  Internet-Draft        LinuxSampler Contr
7858        / SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP        / SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
7859        chain_pos        chain_pos
7860    
7861        / FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id        / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
7862    
7863        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
7864    
# Line 8038  Internet-Draft        LinuxSampler Contr Line 8038  Internet-Draft        LinuxSampler Contr
8038        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP        / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
8039        volume_value        volume_value
8040    
8041        / FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP        / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP
8042        effect_chain SP chain_pos        effect_chain SP chain_pos
8043    
8044        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped        / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
Legend:
Removed from v.2140  
changed lines
  Added in v.2141
  ViewVC Help
Powered by ViewVC