/[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 708 by schoenebeck, Thu Jul 21 09:18:40 2005 UTC revision 1363 by schoenebeck, Sun Sep 30 21:51:14 2007 UTC
# Line 3  Line 3 
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Expires: November 2, 2005                              Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                                  May 2005  Expires: March 4, 2008                                    September 2007
8    
9    
10                       LinuxSampler Control Protocol                   LinuxSampler Control Protocol (draft)
11                                  LSCP 1.1                                LSCP 1.2cvs
12    
13  Status of this Memo  Status of this Memo
14    
15     This document is an Internet-Draft and is in full conformance with     By submitting this Internet-Draft, each author represents that any
16     all provisions of Section 10 of RFC 2026.     applicable patent or other IPR claims of which he or she is aware
17       have been or will be disclosed, and any of which he or she becomes
18       aware will be disclosed, in accordance with Section 6 of BCP 79.
19    
20     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
21     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF), its areas, and its working groups.  Note that
# Line 31  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on November 2, 2005.     This Internet-Draft will expire on March 4, 2008.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2005).  All Rights Reserved.     Copyright (C) The IETF Trust (2007).
41    
42    
43    
44    
45    
46    
47    
48    
49    
50    
51    
52    
53    
54    
55    Schoenebeck               Expires March 4, 2008                 [Page 1]
56    
57    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
58    
59    
60  Abstract  Abstract
61    
# Line 46  Abstract Line 66  Abstract
66     manipulating the samples in real time to certain extent.     manipulating the samples in real time to certain extent.
67    
68    
69    Table of Contents
70    
71       1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   6
72       2.  Versioning of this specification  . . . . . . . . . . . . . .   7
73       3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   8
74       4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   9
75       5.  Communication Overview  . . . . . . . . . . . . . . . . . . .  10
76         5.1.  Request/response communication method . . . . . . . . . .  10
77           5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  11
78         5.2.  Subscribe/notify communication method . . . . . . . . . .  13
79       6.  Description for control commands  . . . . . . . . . . . . . .  15
80         6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  15
81         6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  15
82           6.2.1.  Getting amount of available audio output drivers  . .  16
83           6.2.2.  Getting all available audio output drivers  . . . . .  16
84           6.2.3.  Getting information about a specific audio output
85                   driver  . . . . . . . . . . . . . . . . . . . . . . .  16
86           6.2.4.  Getting information about specific audio output
87                   driver parameter  . . . . . . . . . . . . . . . . . .  17
88           6.2.5.  Creating an audio output device . . . . . . . . . . .  21
89           6.2.6.  Destroying an audio output device . . . . . . . . . .  22
90           6.2.7.  Getting all created audio output device count . . . .  23
91           6.2.8.  Getting all created audio output device list  . . . .  23
92           6.2.9.  Getting current settings of an audio output device  .  23
93           6.2.10. Changing settings of audio output devices . . . . . .  25
94           6.2.11. Getting information about an audio channel  . . . . .  26
95           6.2.12. Getting information about specific audio channel
96                   parameter . . . . . . . . . . . . . . . . . . . . . .  27
97           6.2.13. Changing settings of audio output channels  . . . . .  29
98         6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  30
99           6.3.1.  Getting amount of available MIDI input drivers  . . .  31
100           6.3.2.  Getting all available MIDI input drivers  . . . . . .  31
101           6.3.3.  Getting information about a specific MIDI input
102                   driver  . . . . . . . . . . . . . . . . . . . . . . .  32
103           6.3.4.  Getting information about specific MIDI input
104                   driver parameter  . . . . . . . . . . . . . . . . . .  33
105           6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  35
106           6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  36
107           6.3.7.  Getting all created MIDI input device count . . . . .  37
108    
109    
110    
111    Schoenebeck               Expires March 4, 2008                 [Page 2]
112    
113    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
114    
115    
116           6.3.8.  Getting all created MIDI input device list  . . . . .  37
117           6.3.9.  Getting current settings of a MIDI input device . . .  38
118           6.3.10. Changing settings of MIDI input devices . . . . . . .  39
119           6.3.11. Getting information about a MIDI port . . . . . . . .  39
120           6.3.12. Getting information about specific MIDI port
121                   parameter . . . . . . . . . . . . . . . . . . . . . .  40
122           6.3.13. Changing settings of MIDI input ports . . . . . . . .  42
123         6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  43
124           6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  43
125           6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  44
126           6.4.3.  Getting all created sampler channel count . . . . . .  45
127           6.4.4.  Getting all created sampler channel list  . . . . . .  45
128           6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  46
129           6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  47
130           6.4.7.  Getting amount of available engines . . . . . . . . .  47
131           6.4.8.  Getting all available engines . . . . . . . . . . . .  48
132           6.4.9.  Getting information about an engine . . . . . . . . .  48
133           6.4.10. Getting sampler channel information . . . . . . . . .  49
134           6.4.11. Current number of active voices . . . . . . . . . . .  52
135           6.4.12. Current number of active disk streams . . . . . . . .  53
136           6.4.13. Current fill state of disk stream buffers . . . . . .  53
137           6.4.14. Setting audio output device . . . . . . . . . . . . .  54
138           6.4.15. Setting audio output type . . . . . . . . . . . . . .  55
139           6.4.16. Setting audio output channel  . . . . . . . . . . . .  55
140           6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  56
141           6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  57
142           6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  58
143           6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  58
144           6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  59
145           6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  60
146           6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  60
147           6.4.24. Assigning a MIDI instrument map to a sampler
148                   channel . . . . . . . . . . . . . . . . . . . . . . .  61
149           6.4.25. Adding an effect send to a sampler channel  . . . . .  62
150           6.4.26. Removing an effect send from a sampler channel  . . .  63
151           6.4.27. Getting amount of effect sends on a sampler channel .  64
152           6.4.28. Listing all effect sends on a sampler channel . . . .  64
153           6.4.29. Getting effect send information . . . . . . . . . . .  65
154           6.4.30. Changing effect send's name . . . . . . . . . . . . .  66
155           6.4.31. Altering effect send's audio routing  . . . . . . . .  67
156           6.4.32. Altering effect send's MIDI controller  . . . . . . .  68
157           6.4.33. Altering effect send's send level . . . . . . . . . .  69
158           6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  70
159         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  70
160           6.5.1.  Register front-end for receiving event messages . . .  70
161           6.5.2.  Unregister front-end for not receiving event
162                   messages  . . . . . . . . . . . . . . . . . . . . . .  71
163           6.5.3.  Enable or disable echo of commands  . . . . . . . . .  72
164    
165    
166    
167    Schoenebeck               Expires March 4, 2008                 [Page 3]
168    
169    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
170    
171    
172           6.5.4.  Close client connection . . . . . . . . . . . . . . .  72
173         6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  73
174           6.6.1.  Current number of active voices . . . . . . . . . . .  73
175           6.6.2.  Maximum amount of active voices . . . . . . . . . . .  73
176           6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  73
177           6.6.4.  General sampler informations  . . . . . . . . . . . .  74
178           6.6.5.  Getting global volume attenuation . . . . . . . . . .  74
179           6.6.6.  Setting global volume attenuation . . . . . . . . . .  75
180         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  75
181           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  76
182           6.7.2.  Delete one particular or all MIDI instrument maps . .  77
183           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  77
184           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  78
185           6.7.5.  Getting MIDI instrument map information . . . . . . .  78
186           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  79
187           6.7.7.  Create or replace a MIDI instrument map entry . . . .  80
188           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  82
189           6.7.9.  Getting indeces of all entries of a MIDI
190                   instrument map  . . . . . . . . . . . . . . . . . . .  83
191           6.7.10. Remove an entry from the MIDI instrument map  . . . .  84
192           6.7.11. Get current settings of MIDI instrument map entry . .  84
193           6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  86
194         6.8.  Managing Instruments Database . . . . . . . . . . . . . .  87
195           6.8.1.  Creating a new instrument directory . . . . . . . . .  87
196           6.8.2.  Deleting an instrument directory  . . . . . . . . . .  88
197           6.8.3.  Getting amount of instrument directories  . . . . . .  88
198           6.8.4.  Listing all directories in specific directory . . . .  89
199           6.8.5.  Getting instrument directory information  . . . . . .  89
200           6.8.6.  Renaming an instrument directory  . . . . . . . . . .  90
201           6.8.7.  Moving an instrument directory  . . . . . . . . . . .  91
202           6.8.8.  Copying instrument directories  . . . . . . . . . . .  92
203           6.8.9.  Changing the description of directory . . . . . . . .  92
204           6.8.10. Finding directories . . . . . . . . . . . . . . . . .  93
205           6.8.11. Adding instruments to the instruments database  . . .  94
206           6.8.12. Removing an instrument  . . . . . . . . . . . . . . .  96
207           6.8.13. Getting amount of instruments . . . . . . . . . . . .  96
208           6.8.14. Listing all instruments in specific directory . . . .  97
209           6.8.15. Getting instrument information  . . . . . . . . . . .  98
210           6.8.16. Renaming an instrument  . . . . . . . . . . . . . . . 100
211           6.8.17. Moving an instrument  . . . . . . . . . . . . . . . . 101
212           6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 101
213           6.8.19. Changing the description of instrument  . . . . . . . 102
214           6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102
215           6.8.21. Getting job status information  . . . . . . . . . . . 105
216           6.8.22. Formatting the instruments database . . . . . . . . . 106
217         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 106
218           6.9.1.  Opening an appropriate instrument editor
219                   application . . . . . . . . . . . . . . . . . . . . . 106
220    
221    
222    
223    Schoenebeck               Expires March 4, 2008                 [Page 4]
224    
225    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
226    
227    
228       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 108
229         7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 121
230       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
231         8.1.  Number of audio output devices changed  . . . . . . . . . 123
232         8.2.  Audio output device's settings changed  . . . . . . . . . 123
233         8.3.  Number of MIDI input devices changed  . . . . . . . . . . 123
234         8.4.  MIDI input device's settings changed  . . . . . . . . . . 124
235         8.5.  Number of sampler channels changed  . . . . . . . . . . . 124
236         8.6.  Number of active voices changed . . . . . . . . . . . . . 124
237         8.7.  Number of active disk streams changed . . . . . . . . . . 125
238         8.8.  Disk stream buffer fill state changed . . . . . . . . . . 125
239         8.9.  Channel information changed . . . . . . . . . . . . . . . 125
240         8.10. Number of effect sends changed  . . . . . . . . . . . . . 126
241         8.11. Effect send information changed . . . . . . . . . . . . . 126
242         8.12. Total number of active voices changed . . . . . . . . . . 126
243         8.13. Number of MIDI instrument maps changed  . . . . . . . . . 127
244         8.14. MIDI instrument map information changed . . . . . . . . . 127
245         8.15. Number of MIDI instruments changed  . . . . . . . . . . . 127
246         8.16. MIDI instrument information changed . . . . . . . . . . . 128
247         8.17. Global settings changed . . . . . . . . . . . . . . . . . 128
248         8.18. Number of database instrument directories changed . . . . 129
249         8.19. Database instrument directory information changed . . . . 129
250         8.20. Number of database instruments changed  . . . . . . . . . 130
251         8.21. Database instrument information changed . . . . . . . . . 130
252         8.22. Database job status information changed . . . . . . . . . 131
253         8.23. Miscellaneous and debugging events  . . . . . . . . . . . 131
254       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 132
255       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 133
256       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 134
257       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 135
258       Intellectual Property and Copyright Statements  . . . . . . . . . 136
259    
260    
261    
262    
263    
264    
 Schoenebeck             Expires November 2, 2005                [Page 1]  
265    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
266    
267    
 Table of Contents  
268    
    1.   Requirements notation  . . . . . . . . . . . . . . . . . . .   4  
    2.   Versioning of this specification . . . . . . . . . . . . . .   5  
    3.   Introduction . . . . . . . . . . . . . . . . . . . . . . . .   6  
    4.   Focus of this protocol . . . . . . . . . . . . . . . . . . .   7  
    5.   Communication Overview . . . . . . . . . . . . . . . . . . .   8  
      5.1  Request/response communication method  . . . . . . . . . .   8  
        5.1.1  Result format  . . . . . . . . . . . . . . . . . . . .   9  
      5.2  Subscribe/notify communication method  . . . . . . . . . .  11  
    6.   Description for control commands . . . . . . . . . . . . . .  13  
      6.1  Ignored lines and comments . . . . . . . . . . . . . . . .  13  
      6.2  Configuring audio drivers  . . . . . . . . . . . . . . . .  13  
        6.2.1  Getting amount of available audio output drivers . . .  13  
        6.2.2  Getting all available audio output drivers . . . . . .  14  
        6.2.3  Getting information about a specific audio output  
               driver . . . . . . . . . . . . . . . . . . . . . . . .  14  
        6.2.4  Getting information about specific audio output  
               driver parameter . . . . . . . . . . . . . . . . . . .  15  
        6.2.5  Creating an audio output device  . . . . . . . . . . .  19  
        6.2.6  Destroying an audio output device  . . . . . . . . . .  20  
        6.2.7  Getting all created audio output device count  . . . .  21  
        6.2.8  Getting all created audio output device list . . . . .  21  
        6.2.9  Getting current settings of an audio output device . .  21  
        6.2.10   Changing settings of audio output devices  . . . . .  23  
        6.2.11   Getting information about an audio channel . . . . .  24  
        6.2.12   Getting information about specific audio channel  
                 parameter  . . . . . . . . . . . . . . . . . . . . .  25  
        6.2.13   Changing settings of audio output channels . . . . .  27  
      6.3  Configuring MIDI input drivers . . . . . . . . . . . . . .  28  
        6.3.1  Getting amount of available MIDI input drivers . . . .  29  
        6.3.2  Getting all available MIDI input drivers . . . . . . .  29  
        6.3.3  Getting information about a specific MIDI input  
               driver . . . . . . . . . . . . . . . . . . . . . . . .  30  
        6.3.4  Getting information about specific MIDI input  
               driver parameter . . . . . . . . . . . . . . . . . . .  31  
        6.3.5  Creating a MIDI input device . . . . . . . . . . . . .  33  
        6.3.6  Destroying a MIDI input device . . . . . . . . . . . .  34  
        6.3.7  Getting all created MIDI input device count  . . . . .  35  
        6.3.8  Getting all created MIDI input device list . . . . . .  35  
        6.3.9  Getting current settings of a MIDI input device  . . .  36  
        6.3.10   Changing settings of MIDI input devices  . . . . . .  37  
        6.3.11   Getting information about a MIDI port  . . . . . . .  38  
        6.3.12   Getting information about specific MIDI port  
                 parameter  . . . . . . . . . . . . . . . . . . . . .  38  
        6.3.13   Changing settings of MIDI input ports  . . . . . . .  40  
      6.4  Configuring sampler channels . . . . . . . . . . . . . . .  41  
        6.4.1  Loading an instrument  . . . . . . . . . . . . . . . .  41  
   
   
   
 Schoenebeck             Expires November 2, 2005                [Page 2]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
        6.4.2  Loading a sampler engine . . . . . . . . . . . . . . .  42  
        6.4.3  Getting all created sampler channel count  . . . . . .  43  
        6.4.4  Getting all created sampler channel list . . . . . . .  43  
        6.4.5  Adding a new sampler channel . . . . . . . . . . . . .  44  
        6.4.6  Removing a sampler channel . . . . . . . . . . . . . .  45  
        6.4.7  Getting amount of available engines  . . . . . . . . .  45  
        6.4.8  Getting all available engines  . . . . . . . . . . . .  46  
        6.4.9  Getting information about an engine  . . . . . . . . .  46  
        6.4.10   Getting sampler channel information  . . . . . . . .  47  
        6.4.11   Current number of active voices  . . . . . . . . . .  50  
        6.4.12   Current number of active disk streams  . . . . . . .  50  
        6.4.13   Current fill state of disk stream buffers  . . . . .  51  
        6.4.14   Setting audio output device  . . . . . . . . . . . .  52  
        6.4.15   Setting audio output type  . . . . . . . . . . . . .  53  
        6.4.16   Setting audio output channel . . . . . . . . . . . .  53  
        6.4.17   Setting MIDI input device  . . . . . . . . . . . . .  54  
        6.4.18   Setting MIDI input type  . . . . . . . . . . . . . .  55  
        6.4.19   Setting MIDI input port  . . . . . . . . . . . . . .  56  
        6.4.20   Setting MIDI input channel . . . . . . . . . . . . .  56  
        6.4.21   Setting channel volume . . . . . . . . . . . . . . .  57  
        6.4.22   Muting a sampler channel . . . . . . . . . . . . . .  58  
        6.4.23   Soloing a sampler channel  . . . . . . . . . . . . .  58  
        6.4.24   Resetting a sampler channel  . . . . . . . . . . . .  59  
      6.5  Controlling connection . . . . . . . . . . . . . . . . . .  60  
        6.5.1  Register front-end for receiving event messages  . . .  60  
        6.5.2  Unregister front-end for not receiving event  
               messages . . . . . . . . . . . . . . . . . . . . . . .  61  
        6.5.3  Enable or disable echo of commands . . . . . . . . . .  61  
        6.5.4  Close client connection  . . . . . . . . . . . . . . .  62  
      6.6  Global commands  . . . . . . . . . . . . . . . . . . . . .  62  
        6.6.1  Reset sampler  . . . . . . . . . . . . . . . . . . . .  62  
        6.6.2  General sampler informations . . . . . . . . . . . . .  62  
    7.   Command Syntax . . . . . . . . . . . . . . . . . . . . . . .  64  
    8.   Events . . . . . . . . . . . . . . . . . . . . . . . . . . .  71  
      8.1  Number of sampler channels changed . . . . . . . . . . . .  71  
      8.2  Number of active voices changed  . . . . . . . . . . . . .  71  
      8.3  Number of active disk streams changed  . . . . . . . . . .  71  
      8.4  Disk stream buffer fill state changed  . . . . . . . . . .  72  
      8.5  Channel information changed  . . . . . . . . . . . . . . .  72  
      8.6  Miscellaneous and debugging events . . . . . . . . . . . .  72  
    9.   Security Considerations  . . . . . . . . . . . . . . . . . .  74  
    10.  Acknowledgments  . . . . . . . . . . . . . . . . . . . . . .  75  
    11.  References . . . . . . . . . . . . . . . . . . . . . . . . .  75  
         Author's Address . . . . . . . . . . . . . . . . . . . . . .  75  
         Intellectual Property and Copyright Statements . . . . . . .  76  
269    
270    
271    
272    
273    
274    
 Schoenebeck             Expires November 2, 2005                [Page 3]  
275    
276  Internet-Draft        LinuxSampler Control Protocol             May 2005  
277    
278    
279    Schoenebeck               Expires March 4, 2008                 [Page 5]
280    
281    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
282    
283    
284  1.  Requirements notation  1.  Requirements notation
# Line 182  Internet-Draft        LinuxSampler Contr Line 294  Internet-Draft        LinuxSampler Contr
294     end) and server (LinuxSampler) respectively.  Lines in examples must     end) and server (LinuxSampler) respectively.  Lines in examples must
295     be interpreted as every line being CRLF terminated (carriage return     be interpreted as every line being CRLF terminated (carriage return
296     character followed by line feed character as defined in the ASCII     character followed by line feed character as defined in the ASCII
297     standard), thus the following example:     standard [RFC20]), thus the following example:
298    
299        C: "some line"        C: "some line"
300    
# Line 220  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck             Expires November 2, 2005                [Page 4]  Schoenebeck               Expires March 4, 2008                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
338    
339    
340  2.  Versioning of this specification  2.  Versioning of this specification
# Line 251  Internet-Draft        LinuxSampler Contr Line 363  Internet-Draft        LinuxSampler Contr
363         sampler's LSCP minor version.         sampler's LSCP minor version.
364    
365     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
366     frontend can use the "GET SERVER INFO" (Section 6.6.2) command to get     frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get
367     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
368    
369    
# Line 276  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck             Expires November 2, 2005                [Page 5]  Schoenebeck               Expires March 4, 2008                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
394    
395    
396  3.  Introduction  3.  Introduction
# Line 332  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck             Expires November 2, 2005                [Page 6]  Schoenebeck               Expires March 4, 2008                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
450    
451    
452  4.  Focus of this protocol  4.  Focus of this protocol
# Line 388  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck             Expires November 2, 2005                [Page 7]  Schoenebeck               Expires March 4, 2008                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
506    
507    
508  5.  Communication Overview  5.  Communication Overview
# Line 405  Internet-Draft        LinuxSampler Contr Line 517  Internet-Draft        LinuxSampler Contr
517     more effort to be implemented in the front-end application.  The two     more effort to be implemented in the front-end application.  The two
518     communication methods will be described next.     communication methods will be described next.
519    
520  5.1  Request/response communication method  5.1.  Request/response communication method
521    
522     This simple communication method is based on TCP [RFC793].  The     This simple communication method is based on TCP [RFC793].  The
523     front-end application establishes a TCP connection to the     front-end application establishes a TCP connection to the
# Line 444  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck             Expires November 2, 2005                [Page 8]  Schoenebeck               Expires March 4, 2008                [Page 10]
560    
561    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
562    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
563    
564    5.1.1.  Result format
 5.1.1  Result format  
565    
566     Result set could be one of the following types:     Result set could be one of the following types:
567    
# Line 500  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck             Expires November 2, 2005                [Page 9]  Schoenebeck               Expires March 4, 2008                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
618    
619    
620     set has the following format:     set has the following format:
# Line 556  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck             Expires November 2, 2005               [Page 10]  Schoenebeck               Expires March 4, 2008                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
674    
675    
676     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 573  Internet-Draft        LinuxSampler Contr Line 685  Internet-Draft        LinuxSampler Contr
685    
686        S: "WRN[0]:32:Sample rate not supported, using 44100 instead."        S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
687    
688    5.2.  Subscribe/notify communication method
 5.2  Subscribe/notify communication method  
689    
690     This more sophisticated communication method is actually only an     This more sophisticated communication method is actually only an
691     extension of the simple request/response communication method.  The     extension of the simple request/response communication method.  The
# Line 609  Internet-Draft        LinuxSampler Contr Line 720  Internet-Draft        LinuxSampler Contr
720    
721     3.  When response is being sent to the client, event MUST be inserted     3.  When response is being sent to the client, event MUST be inserted
722         in the stream before or after the response, but NOT in the         in the stream before or after the response, but NOT in the
723           middle.  Same is true about the response.  It should never be
724    
725    
726    
727  Schoenebeck             Expires November 2, 2005               [Page 11]  Schoenebeck               Expires March 4, 2008                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
730    
731    
        middle.  Same is true about the response.  It should never be  
732         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
733         response.         response.
734    
# Line 668  Internet-Draft        LinuxSampler Contr Line 779  Internet-Draft        LinuxSampler Contr
779    
780    
781    
 Schoenebeck             Expires November 2, 2005               [Page 12]  
782    
783  Internet-Draft        LinuxSampler Control Protocol             May 2005  Schoenebeck               Expires March 4, 2008                [Page 14]
784    
785    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
786    
787    
788  6.  Description for control commands  6.  Description for control commands
# Line 682  Internet-Draft        LinuxSampler Contr Line 794  Internet-Draft        LinuxSampler Contr
794     LinuxSampler signals the end of the response by a "." (single dot)     LinuxSampler signals the end of the response by a "." (single dot)
795     line.     line.
796    
797  6.1  Ignored lines and comments  6.1.  Ignored lines and comments
798    
799     White lines, that is lines which only contain space and tabulator     White lines, that is lines which only contain space and tabulator
800     characters, and lines that start with a "#" character are ignored,     characters, and lines that start with a "#" character are ignored,
801     thus it's possible for example to group commands and to place     thus it's possible for example to group commands and to place
802     comments in a LSCP script file.     comments in a LSCP script file.
803    
804  6.2  Configuring audio drivers  6.2.  Configuring audio drivers
805    
806     Instances of drivers in LinuxSampler are called devices.  You can use     Instances of drivers in LinuxSampler are called devices.  You can use
807     multiple audio devices simultaneously, e.g. to output the sound of     multiple audio devices simultaneously, e.g. to output the sound of
# Line 718  Internet-Draft        LinuxSampler Contr Line 830  Internet-Draft        LinuxSampler Contr
830     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
831     possible values, etc.     possible values, etc.
832    
 6.2.1  Getting amount of available audio output drivers  
833    
    Use the following command to get the number of audio output drivers  
834    
835    
836    
 Schoenebeck             Expires November 2, 2005               [Page 13]  
837    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
838    
839    Schoenebeck               Expires March 4, 2008                [Page 15]
840    
841    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
842    
843    
844    6.2.1.  Getting amount of available audio output drivers
845    
846       Use the following command to get the number of audio output drivers
847     currently available for the LinuxSampler instance:     currently available for the LinuxSampler instance:
848    
849        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 744  Internet-Draft        LinuxSampler Contr Line 859  Internet-Draft        LinuxSampler Contr
859    
860        S: "2"        S: "2"
861    
862    6.2.2.  Getting all available audio output drivers
 6.2.2  Getting all available audio output drivers  
863    
864     Use the following command to list all audio output drivers currently     Use the following command to list all audio output drivers currently
865     available for the LinuxSampler instance:     available for the LinuxSampler instance:
# Line 763  Internet-Draft        LinuxSampler Contr Line 877  Internet-Draft        LinuxSampler Contr
877    
878        S: "ALSA,JACK"        S: "ALSA,JACK"
879    
880    6.2.3.  Getting information about a specific audio output driver
 6.2.3  Getting information about a specific audio output driver  
881    
882     Use the following command to get detailed information about a     Use the following command to get detailed information about a
883     specific audio output driver:     specific audio output driver:
# Line 779  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895    Schoenebeck               Expires March 4, 2008                [Page 16]
896  Schoenebeck             Expires November 2, 2005               [Page 14]  
897    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
898    
899    
900        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 823  Internet-Draft        LinuxSampler Contr Line 935  Internet-Draft        LinuxSampler Contr
935    
936           "."           "."
937    
938    6.2.4.  Getting information about specific audio output driver parameter
 6.2.4  Getting information about specific audio output driver parameter  
939    
940     Use the following command to get detailed information about a     Use the following command to get detailed information about a
941     specific audio output driver parameter:     specific audio output driver parameter:
# Line 833  Internet-Draft        LinuxSampler Contr Line 944  Internet-Draft        LinuxSampler Contr
944    
945     Where <audio> is the name of the audio output driver as returned by     Where <audio> is the name of the audio output driver as returned by
946     the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,     the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,
947       <prm> a specific parameter name for which information should be
948    
949    
950    
951  Schoenebeck             Expires November 2, 2005               [Page 15]  Schoenebeck               Expires March 4, 2008                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
954    
955    
    <prm> a specific parameter name for which information should be  
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
957     (Section 6.2.3) command) and <deplist> is an optional list of     (Section 6.2.3) command) and <deplist> is an optional list of
958     parameters on which the sought parameter <prm> depends on, <deplist>     parameters on which the sought parameter <prm> depends on, <deplist>
# Line 892  Internet-Draft        LinuxSampler Contr Line 1003  Internet-Draft        LinuxSampler Contr
1003    
1004    
1005    
 Schoenebeck             Expires November 2, 2005               [Page 16]  
1006    
1007  Internet-Draft        LinuxSampler Control Protocol             May 2005  Schoenebeck               Expires March 4, 2008                [Page 18]
1008    
1009    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1010    
1011    
1012        MULTIPLICITY -        MULTIPLICITY -
# Line 948  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck             Expires November 2, 2005               [Page 17]  Schoenebeck               Expires March 4, 2008                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1066    
1067    
1068           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck             Expires November 2, 2005               [Page 18]  Schoenebeck               Expires March 4, 2008                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1122    
1123    
1124           "TYPE: INT"           "TYPE: INT"
# Line 1027  Internet-Draft        LinuxSampler Contr Line 1139  Internet-Draft        LinuxSampler Contr
1139    
1140           "."           "."
1141    
1142    6.2.5.  Creating an audio output device
1143    
1144  6.2.5  Creating an audio output device     Use the following command to create a new audio output device for the
1145       desired audio output system:
    Use the following command to create a new audio output device for  
    the desired audio output system:  
1146    
1147        CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]        CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]
1148    
# Line 1057  Internet-Draft        LinuxSampler Contr Line 1168  Internet-Draft        LinuxSampler Contr
1168           in case the device was created successfully, where <device-id>           in case the device was created successfully, where <device-id>
1169           is the numerical ID of the new device, but there are noteworthy           is the numerical ID of the new device, but there are noteworthy
1170           issue(s) related (e.g. sound card doesn't support given           issue(s) related (e.g. sound card doesn't support given
1171             hardware parameters and the driver is using fall-back values),
1172    
1173    
1174    
1175  Schoenebeck             Expires November 2, 2005               [Page 19]  Schoenebeck               Expires March 4, 2008                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1178    
1179    
          hardware parameters and the driver is using fall-back values),  
1180           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
1181    
1182        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 1083  Internet-Draft        LinuxSampler Contr Line 1194  Internet-Draft        LinuxSampler Contr
1194    
1195        S: "OK[1]"        S: "OK[1]"
1196    
1197    6.2.6.  Destroying an audio output device
 6.2.6  Destroying an audio output device  
1198    
1199     Use the following command to destroy a created output device:     Use the following command to destroy a created output device:
1200    
# Line 1114  Internet-Draft        LinuxSampler Contr Line 1224  Internet-Draft        LinuxSampler Contr
1224           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1225           error message           error message
1226    
1227       Example:
1228    
1229    
 Schoenebeck             Expires November 2, 2005               [Page 20]  
1230    
1231  Internet-Draft        LinuxSampler Control Protocol             May 2005  Schoenebeck               Expires March 4, 2008                [Page 22]
1232    
1233    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1234    
1235    
    Example:  
   
1236        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
1237    
1238        S: "OK"        S: "OK"
1239    
1240    6.2.7.  Getting all created audio output device count
 6.2.7  Getting all created audio output device count  
1241    
1242     Use the following command to count all created audio output devices:     Use the following command to count all created audio output devices:
1243    
# Line 1145  Internet-Draft        LinuxSampler Contr Line 1254  Internet-Draft        LinuxSampler Contr
1254    
1255        S: "4"        S: "4"
1256    
1257    6.2.8.  Getting all created audio output device list
 6.2.8  Getting all created audio output device list  
1258    
1259     Use the following command to list all created audio output devices:     Use the following command to list all created audio output devices:
1260    
# Line 1163  Internet-Draft        LinuxSampler Contr Line 1271  Internet-Draft        LinuxSampler Contr
1271    
1272        S: "0,1,4,5"        S: "0,1,4,5"
1273    
1274    6.2.9.  Getting current settings of an audio output device
 6.2.9  Getting current settings of an audio output device  
1275    
1276     Use the following command to get current settings of a specific,     Use the following command to get current settings of a specific,
1277     created audio output device:     created audio output device:
1278    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 21]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1279        GET AUDIO_OUTPUT_DEVICE INFO <device-id>        GET AUDIO_OUTPUT_DEVICE INFO <device-id>
1280    
1281     Where <device-id> should be replaced by numerical ID of the audio     Where <device-id> should be replaced by numerical ID of the audio
1282     output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"     output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"
1283     (Section 6.2.8) command.     (Section 6.2.8) command.
1284    
1285    
1286    
1287    Schoenebeck               Expires March 4, 2008                [Page 23]
1288    
1289    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1290    
1291    
1292     Possible Answers:     Possible Answers:
1293    
1294     LinuxSampler will answer by sending a <CRLF> separated list.  Each     LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 1225  Internet-Draft        LinuxSampler Contr Line 1331  Internet-Draft        LinuxSampler Contr
1331    
1332        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
1333    
1334             "CHANNELS: 2"
1335    
1336             "SAMPLERATE: 44100"
1337    
1338             "ACTIVE: true"
1339    
 Schoenebeck             Expires November 2, 2005               [Page 22]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
1340    
1341    
          "CHANNELS: 2"  
1342    
1343           "SAMPLERATE: 44100"  Schoenebeck               Expires March 4, 2008                [Page 24]
1344    
1345    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1346    
          "ACTIVE: true"  
1347    
1348           "FRAGMENTS: 2"           "FRAGMENTS: 2"
1349    
# Line 1247  Internet-Draft        LinuxSampler Contr Line 1353  Internet-Draft        LinuxSampler Contr
1353    
1354           "."           "."
1355    
1356    6.2.10.  Changing settings of audio output devices
 6.2.10  Changing settings of audio output devices  
1357    
1358     Use the following command to alter a specific setting of a created     Use the following command to alter a specific setting of a created
1359     audio output device:     audio output device:
# Line 1280  Internet-Draft        LinuxSampler Contr Line 1385  Internet-Draft        LinuxSampler Contr
1385    
1386     Example:     Example:
1387    
1388          C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
1389    
1390          S: "OK"
1391    
1392    
1393    
 Schoenebeck             Expires November 2, 2005               [Page 23]  
1394    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
1395    
1396    
       C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"  
1397    
       S: "OK"  
1398    
1399    Schoenebeck               Expires March 4, 2008                [Page 25]
1400    
1401    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1402    
1403  6.2.11  Getting information about an audio channel  
1404    6.2.11.  Getting information about an audio channel
1405    
1406     Use the following command to get information about an audio channel:     Use the following command to get information about an audio channel:
1407    
# Line 1337  Internet-Draft        LinuxSampler Contr Line 1444  Internet-Draft        LinuxSampler Contr
1444              actually will be routed / added to (only returned in case              actually will be routed / added to (only returned in case
1445              the audio channel is mix channel)              the audio channel is mix channel)
1446    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 24]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1447     The mentioned fields above don't have to be in particular order.  The     The mentioned fields above don't have to be in particular order.  The
1448     fields above are only those fields which are generally returned for     fields above are only those fields which are generally returned for
1449     the described cases by all audio channels regardless of the audio     the described cases by all audio channels regardless of the audio
1450     driver.  Every audio channel might have its own, additional driver     driver.  Every audio channel might have its own, additional driver
1451     and channel specific parameters.     and channel specific parameters.
1452    
1453    
1454    
1455    Schoenebeck               Expires March 4, 2008                [Page 26]
1456    
1457    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1458    
1459    
1460     Examples:     Examples:
1461    
1462        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
# Line 1389  Internet-Draft        LinuxSampler Contr Line 1495  Internet-Draft        LinuxSampler Contr
1495    
1496           "."           "."
1497    
1498    6.2.12.  Getting information about specific audio channel parameter
 6.2.12  Getting information about specific audio channel parameter  
1499    
1500     Use the following command to get detailed information about specific     Use the following command to get detailed information about specific
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 25]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1501     audio channel parameter:     audio channel parameter:
1502    
1503        GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>        GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>
# Line 1408  Internet-Draft        LinuxSampler Contr Line 1505  Internet-Draft        LinuxSampler Contr
1505     Where <dev-id> is the numerical ID of the audio output device as     Where <dev-id> is the numerical ID of the audio output device as
1506     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1507     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
1508    
1509    
1510    
1511    Schoenebeck               Expires March 4, 2008                [Page 27]
1512    
1513    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1514    
1515    
1516     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
1517     which information should be obtained (as returned by the "GET     which information should be obtained (as returned by the "GET
1518     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
# Line 1448  Internet-Draft        LinuxSampler Contr Line 1553  Internet-Draft        LinuxSampler Contr
1553              values and false only a single value allowed (always              values and false only a single value allowed (always
1554              returned)              returned)
1555    
   
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 26]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1556           RANGE_MIN -           RANGE_MIN -
1557    
1558              defines lower limit of the allowed value range for this              defines lower limit of the allowed value range for this
# Line 1465  Internet-Draft        LinuxSampler Contr Line 1561  Internet-Draft        LinuxSampler Contr
1561              may also appear without (optionally returned, dependent to              may also appear without (optionally returned, dependent to
1562              driver and channel parameter)              driver and channel parameter)
1563    
1564    
1565    
1566    
1567    Schoenebeck               Expires March 4, 2008                [Page 28]
1568    
1569    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1570    
1571    
1572           RANGE_MAX -           RANGE_MAX -
1573    
1574              defines upper limit of the allowed value range for this              defines upper limit of the allowed value range for this
# Line 1498  Internet-Draft        LinuxSampler Contr Line 1602  Internet-Draft        LinuxSampler Contr
1602    
1603           "."           "."
1604    
1605    6.2.13.  Changing settings of audio output channels
 6.2.13  Changing settings of audio output channels  
1606    
1607     Use the following command to alter a specific setting of an audio     Use the following command to alter a specific setting of an audio
1608     output channel:     output channel:
1609    
   
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 27]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1610        SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>        SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>
1611    
1612     Where <dev-id> should be replaced by the numerical ID of the audio     Where <dev-id> should be replaced by the numerical ID of the audio
# Line 1523  Internet-Draft        LinuxSampler Contr Line 1617  Internet-Draft        LinuxSampler Contr
1617    
1618     Possible Answers:     Possible Answers:
1619    
1620    
1621    
1622    
1623    Schoenebeck               Expires March 4, 2008                [Page 29]
1624    
1625    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1626    
1627    
1628        "OK" -        "OK" -
1629    
1630           in case setting was successfully changed           in case setting was successfully changed
# Line 1548  Internet-Draft        LinuxSampler Contr Line 1650  Internet-Draft        LinuxSampler Contr
1650    
1651        S: "OK"        S: "OK"
1652    
1653    6.3.  Configuring MIDI input drivers
 6.3  Configuring MIDI input drivers  
1654    
1655     Instances of drivers in LinuxSampler are called devices.  You can use     Instances of drivers in LinuxSampler are called devices.  You can use
1656     multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet     multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet
# Line 1561  Internet-Draft        LinuxSampler Contr Line 1662  Internet-Draft        LinuxSampler Contr
1662    
1663     Instead of defining commands and parameters for each driver     Instead of defining commands and parameters for each driver
1664     individually, all possible parameters, their meanings and possible     individually, all possible parameters, their meanings and possible
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 28]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1665     values have to be obtained at runtime.  This makes the protocol a bit     values have to be obtained at runtime.  This makes the protocol a bit
1666     abstract, but has the advantage, that front-ends can be written     abstract, but has the advantage, that front-ends can be written
1667     independently of what drivers are currently implemented and what     independently of what drivers are currently implemented and what
# Line 1580  Internet-Draft        LinuxSampler Contr Line 1673  Internet-Draft        LinuxSampler Contr
1673     as the commands for configuring audio output drivers, already     as the commands for configuring audio output drivers, already
1674     described in the last chapter.     described in the last chapter.
1675    
1676    
1677    
1678    
1679    Schoenebeck               Expires March 4, 2008                [Page 30]
1680    
1681    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1682    
1683    
1684     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
1685     drivers are not meant as specification of the drivers' parameters.     drivers are not meant as specification of the drivers' parameters.
1686     Driver implementations in LinuxSampler might have complete different     Driver implementations in LinuxSampler might have complete different
# Line 1588  Internet-Draft        LinuxSampler Contr Line 1689  Internet-Draft        LinuxSampler Contr
1689     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
1690     possible values, etc.     possible values, etc.
1691    
1692  6.3.1  Getting amount of available MIDI input drivers  6.3.1.  Getting amount of available MIDI input drivers
1693    
1694     Use the following command to get the number of MIDI input drivers     Use the following command to get the number of MIDI input drivers
1695     currently available for the LinuxSampler instance:     currently available for the LinuxSampler instance:
# Line 1606  Internet-Draft        LinuxSampler Contr Line 1707  Internet-Draft        LinuxSampler Contr
1707    
1708        S: "2"        S: "2"
1709    
1710    6.3.2.  Getting all available MIDI input drivers
 6.3.2  Getting all available MIDI input drivers  
1711    
1712     Use the following command to list all MIDI input drivers currently     Use the following command to list all MIDI input drivers currently
1713     available for the LinuxSampler instance:     available for the LinuxSampler instance:
# Line 1616  Internet-Draft        LinuxSampler Contr Line 1716  Internet-Draft        LinuxSampler Contr
1716    
1717     Possible Answers:     Possible Answers:
1718    
1719          LinuxSampler will answer by sending comma separated character
1720          strings, each symbolizing a MIDI input driver.
1721    
1722       Example:
1723    
1724          C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
1725    
1726          S: "ALSA,JACK"
1727    
 Schoenebeck             Expires November 2, 2005               [Page 29]  
1728    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
1729    
1730    
       LinuxSampler will answer by sending comma separated character  
       strings, each symbolizing a MIDI input driver.  
1731    
    Example:  
1732    
       C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"  
1733    
1734        S: "ALSA,JACK"  
1735    Schoenebeck               Expires March 4, 2008                [Page 31]
1736    
1737    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1738    
1739    
1740  6.3.3  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
1741    
1742     Use the following command to get detailed information about a     Use the following command to get detailed information about a
1743     specific MIDI input driver:     specific MIDI input driver:
# Line 1673  Internet-Draft        LinuxSampler Contr Line 1775  Internet-Draft        LinuxSampler Contr
1775    
1776     Example:     Example:
1777    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 30]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1778        C: "GET MIDI_INPUT_DRIVER INFO ALSA"        C: "GET MIDI_INPUT_DRIVER INFO ALSA"
1779    
1780        S: "DESCRIPTION: Advanced Linux Sound Architecture"        S: "DESCRIPTION: Advanced Linux Sound Architecture"
# Line 1692  Internet-Draft        LinuxSampler Contr Line 1786  Internet-Draft        LinuxSampler Contr
1786           "."           "."
1787    
1788    
1789  6.3.4  Getting information about specific MIDI input driver parameter  
1790    
1791    Schoenebeck               Expires March 4, 2008                [Page 32]
1792    
1793    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1794    
1795    
1796    6.3.4.  Getting information about specific MIDI input driver parameter
1797    
1798     Use the following command to get detailed information about a     Use the following command to get detailed information about a
1799     specific parameter of a specific MIDI input driver:     specific parameter of a specific MIDI input driver:
# Line 1729  Internet-Draft        LinuxSampler Contr Line 1830  Internet-Draft        LinuxSampler Contr
1830           character string(s) (always returned, no matter which driver           character string(s) (always returned, no matter which driver
1831           parameter)           parameter)
1832    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 31]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1833        DESCRIPTION -        DESCRIPTION -
1834    
1835           arbitrary text describing the purpose of the parameter (always           arbitrary text describing the purpose of the parameter (always
# Line 1749  Internet-Draft        LinuxSampler Contr Line 1842  Internet-Draft        LinuxSampler Contr
1842           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1843           matter which driver parameter)           matter which driver parameter)
1844    
1845    
1846    
1847    Schoenebeck               Expires March 4, 2008                [Page 33]
1848    
1849    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1850    
1851    
1852        FIX -        FIX -
1853    
1854           either true or false, if false then this parameter can be           either true or false, if false then this parameter can be
# Line 1784  Internet-Draft        LinuxSampler Contr Line 1884  Internet-Draft        LinuxSampler Contr
1884           character strings are encapsulated into apostrophes (')           character strings are encapsulated into apostrophes (')
1885           (optionally returned, dependent to driver parameter)           (optionally returned, dependent to driver parameter)
1886    
   
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 32]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1887        RANGE_MIN -        RANGE_MIN -
1888    
1889           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
# Line 1806  Internet-Draft        LinuxSampler Contr Line 1897  Internet-Draft        LinuxSampler Contr
1897           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
1898           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1899           this parameter is often used in conjunction with RANGE_MIN, but           this parameter is often used in conjunction with RANGE_MIN, but
1900    
1901    
1902    
1903    Schoenebeck               Expires March 4, 2008                [Page 34]
1904    
1905    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1906    
1907    
1908           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
1909           driver parameter)           driver parameter)
1910    
# Line 1835  Internet-Draft        LinuxSampler Contr Line 1934  Internet-Draft        LinuxSampler Contr
1934    
1935           "."           "."
1936    
1937    6.3.5.  Creating a MIDI input device
1938    
1939  6.3.5  Creating a MIDI input device     Use the following command to create a new MIDI input device for the
   
    Use the following command to create a new MIDI input device for  the  
1940     desired MIDI input system:     desired MIDI input system:
1941    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 33]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1942        CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]        CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]
1943    
1944     Where <midi-input-driver> should be replaced by the desired MIDI     Where <midi-input-driver> should be replaced by the desired MIDI
# Line 1862  Internet-Draft        LinuxSampler Contr Line 1952  Internet-Draft        LinuxSampler Contr
1952    
1953     Possible Answers:     Possible Answers:
1954    
1955    
1956    
1957    
1958    
1959    Schoenebeck               Expires March 4, 2008                [Page 35]
1960    
1961    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
1962    
1963    
1964        "OK[<device-id>]" -        "OK[<device-id>]" -
1965    
1966           in case the device was successfully created, where <device-id>           in case the device was successfully created, where <device-id>
# Line 1885  Internet-Draft        LinuxSampler Contr Line 1984  Internet-Draft        LinuxSampler Contr
1984    
1985        S: "OK[0]"        S: "OK[0]"
1986    
1987    6.3.6.  Destroying a MIDI input device
 6.3.6  Destroying a MIDI input device  
1988    
1989     Use the following command to destroy a created MIDI input device:     Use the following command to destroy a created MIDI input device:
1990    
# Line 1898  Internet-Draft        LinuxSampler Contr Line 1996  Internet-Draft        LinuxSampler Contr
1996    
1997     Possible Answers:     Possible Answers:
1998    
   
   
 Schoenebeck             Expires November 2, 2005               [Page 34]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
1999        "OK" -        "OK" -
2000    
2001           in case the device was successfully destroyed           in case the device was successfully destroyed
# Line 1917  Internet-Draft        LinuxSampler Contr Line 2008  Internet-Draft        LinuxSampler Contr
2008    
2009        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2010    
2011    
2012    
2013    
2014    
2015    Schoenebeck               Expires March 4, 2008                [Page 36]
2016    
2017    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2018    
2019    
2020           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2021           error message           error message
2022    
# Line 1926  Internet-Draft        LinuxSampler Contr Line 2026  Internet-Draft        LinuxSampler Contr
2026    
2027        S: "OK"        S: "OK"
2028    
2029    6.3.7.  Getting all created MIDI input device count
 6.3.7  Getting all created MIDI input device count  
2030    
2031     Use the following command to count all created MIDI input devices:     Use the following command to count all created MIDI input devices:
2032    
# Line 1944  Internet-Draft        LinuxSampler Contr Line 2043  Internet-Draft        LinuxSampler Contr
2043    
2044        S: "3"        S: "3"
2045    
2046    6.3.8.  Getting all created MIDI input device list
 6.3.8  Getting all created MIDI input device list  
2047    
2048     Use the following command to list all created MIDI input devices:     Use the following command to list all created MIDI input devices:
2049    
# Line 1953  Internet-Draft        LinuxSampler Contr Line 2051  Internet-Draft        LinuxSampler Contr
2051    
2052     Possible Answers:     Possible Answers:
2053    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 35]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2054        LinuxSampler will answer by sending a comma separated list with        LinuxSampler will answer by sending a comma separated list with
2055        the numerical Ids of all created MIDI input devices.        the numerical Ids of all created MIDI input devices.
2056    
# Line 1975  Internet-Draft        LinuxSampler Contr Line 2065  Internet-Draft        LinuxSampler Contr
2065        S: "1,3"        S: "1,3"
2066    
2067    
2068  6.3.9  Getting current settings of a MIDI input device  
2069    
2070    
2071    Schoenebeck               Expires March 4, 2008                [Page 37]
2072    
2073    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2074    
2075    
2076    6.3.9.  Getting current settings of a MIDI input device
2077    
2078     Use the following command to get current settings of a specific,     Use the following command to get current settings of a specific,
2079     created MIDI input device:     created MIDI input device:
# Line 2010  Internet-Draft        LinuxSampler Contr Line 2108  Internet-Draft        LinuxSampler Contr
2108              inactive and doesn't listen to any incoming MIDI events and              inactive and doesn't listen to any incoming MIDI events and
2109              thus doesn't forward them to connected sampler channels              thus doesn't forward them to connected sampler channels
2110    
   
   
 Schoenebeck             Expires November 2, 2005               [Page 36]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2111     The mentioned fields above don't have to be in particular order.  The     The mentioned fields above don't have to be in particular order.  The
2112     fields above are only those fields which are returned by all MIDI     fields above are only those fields which are returned by all MIDI
2113     input devices.  Every MIDI input driver might have its own,     input devices.  Every MIDI input driver might have its own,
# Line 2030  Internet-Draft        LinuxSampler Contr Line 2121  Internet-Draft        LinuxSampler Contr
2121    
2122        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
2123    
2124    
2125    
2126    
2127    Schoenebeck               Expires March 4, 2008                [Page 38]
2128    
2129    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2130    
2131    
2132           "ACTIVE: true"           "ACTIVE: true"
2133    
2134           "."           "."
2135    
2136    6.3.10.  Changing settings of MIDI input devices
 6.3.10  Changing settings of MIDI input devices  
2137    
2138     Use the following command to alter a specific setting of a created     Use the following command to alter a specific setting of a created
2139     MIDI input device:     MIDI input device:
# Line 2065  Internet-Draft        LinuxSampler Contr Line 2163  Internet-Draft        LinuxSampler Contr
2163           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2164           error message           error message
2165    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 37]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2166     Example:     Example:
2167    
2168        C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"        C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
2169    
2170        S: "OK"        S: "OK"
2171    
2172    6.3.11.  Getting information about a MIDI port
 6.3.11  Getting information about a MIDI port  
2173    
2174     Use the following command to get information about a MIDI port:     Use the following command to get information about a MIDI port:
2175    
# Line 2088  Internet-Draft        LinuxSampler Contr Line 2177  Internet-Draft        LinuxSampler Contr
2177    
2178     Where <device-id> is the numerical ID of the MIDI input device as     Where <device-id> is the numerical ID of the MIDI input device as
2179     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2180    
2181    
2182    
2183    Schoenebeck               Expires March 4, 2008                [Page 39]
2184    
2185    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2186    
2187    
2188     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
2189     input port number.     input port number.
2190    
# Line 2117  Internet-Draft        LinuxSampler Contr Line 2214  Internet-Draft        LinuxSampler Contr
2214    
2215           "."           "."
2216    
2217    6.3.12.  Getting information about specific MIDI port parameter
 6.3.12  Getting information about specific MIDI port parameter  
2218    
2219     Use the following command to get detailed information about specific     Use the following command to get detailed information about specific
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 38]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2220     MIDI port parameter:     MIDI port parameter:
2221    
2222        GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>        GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>
# Line 2145  Internet-Draft        LinuxSampler Contr Line 2233  Internet-Draft        LinuxSampler Contr
2233        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2234        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2235        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
2236    
2237    
2238    
2239    Schoenebeck               Expires March 4, 2008                [Page 40]
2240    
2241    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2242    
2243    
2244        character string to that info category.  There is information        character string to that info category.  There is information
2245        which is always returned, independently of the given channel        which is always returned, independently of the given channel
2246        parameter and there is optional information which are only shown        parameter and there is optional information which are only shown
# Line 2177  Internet-Draft        LinuxSampler Contr Line 2273  Internet-Draft        LinuxSampler Contr
2273    
2274           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
2275           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 39]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2276           this parameter is usually used in conjunction with 'RANGE_MAX'           this parameter is usually used in conjunction with 'RANGE_MAX'
2277           but may also appear without (optionally returned, dependent to           but may also appear without (optionally returned, dependent to
2278           driver and port parameter)           driver and port parameter)
# Line 2201  Internet-Draft        LinuxSampler Contr Line 2289  Internet-Draft        LinuxSampler Contr
2289    
2290           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
2291           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
2292    
2293    
2294    
2295    Schoenebeck               Expires March 4, 2008                [Page 41]
2296    
2297    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2298    
2299    
2300           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
2301    
2302     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 2221  Internet-Draft        LinuxSampler Contr Line 2317  Internet-Draft        LinuxSampler Contr
2317    
2318           "."           "."
2319    
2320    6.3.13.  Changing settings of MIDI input ports
 6.3.13  Changing settings of MIDI input ports  
2321    
2322     Use the following command to alter a specific setting of a MIDI input     Use the following command to alter a specific setting of a MIDI input
2323     port:     port:
# Line 2233  Internet-Draft        LinuxSampler Contr Line 2328  Internet-Draft        LinuxSampler Contr
2328     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2329     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2330     MIDI port number, <key> by the name of the parameter to change and     MIDI port number, <key> by the name of the parameter to change and
2331       <value> by the new value for this parameter (encapsulated into
2332       apostrophes) or NONE (not encapsulated into apostrophes) for
2333       specifying no value for parameters allowing a list of values.
 Schoenebeck             Expires November 2, 2005               [Page 40]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
    <value> by the new value for this parameter.  
2334    
2335     Possible Answers:     Possible Answers:
2336    
# Line 2255  Internet-Draft        LinuxSampler Contr Line 2344  Internet-Draft        LinuxSampler Contr
2344           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2345           code and warning message           code and warning message
2346    
2347    
2348    
2349    
2350    
2351    Schoenebeck               Expires March 4, 2008                [Page 42]
2352    
2353    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2354    
2355    
2356        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2357    
2358           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2262  Internet-Draft        LinuxSampler Contr Line 2360  Internet-Draft        LinuxSampler Contr
2360    
2361     Example:     Example:
2362    
2363          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2364    
2365          S: "OK"
2366    
2367          C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2368    
2369  6.4  Configuring sampler channels        S: "OK"
2370    
2371    6.4.  Configuring sampler channels
2372    
2373     The following commands describe how to add and remove sampler     The following commands describe how to add and remove sampler
2374     channels, associate a sampler channel with a sampler engine, load     channels, associate a sampler channel with a sampler engine, load
2375     instruments and connect sampler channels to MIDI and audio devices.     instruments and connect sampler channels to MIDI and audio devices.
2376    
2377  6.4.1  Loading an instrument  6.4.1.  Loading an instrument
2378    
2379     An instrument file can be loaded and assigned to a sampler channel by     An instrument file can be loaded and assigned to a sampler channel by
2380     one of the following commands:     one of the following commands:
# Line 2285  Internet-Draft        LinuxSampler Contr Line 2388  Internet-Draft        LinuxSampler Contr
2388     of the sampler channel the instrument should be assigned to.  Each     of the sampler channel the instrument should be assigned to.  Each
2389     sampler channel can only have one instrument.     sampler channel can only have one instrument.
2390    
2391       Notice: since LSCP 1.2 the <filename> argument supports escape
2392       characters for special characters (see chapter "Character Set and
2393       Escape Sequences (Section 7.1)" for details) and accordingly
2394       backslash characters in the filename MUST now be escaped as well!
2395    
2396     The difference between regular and NON_MODAL versions of the command     The difference between regular and NON_MODAL versions of the command
2397     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2398     been fully loaded and the channel is ready to be used while NON_MODAL     been fully loaded and the channel is ready to be used while NON_MODAL
2399     version returns immediately and a background process is launched to     version returns immediately and a background process is launched to
2400       load the instrument on the channel.  The GET CHANNEL INFO
2401       (Section 6.4.10) command can be used to obtain loading progress from
2402       INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2403       such as making sure that the file could be read and it is of a proper
2404    
2405    
2406    
2407  Schoenebeck             Expires November 2, 2005               [Page 41]  Schoenebeck               Expires March 4, 2008                [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2410    
2411    
    load the instrument on the channel.  The GET CHANNEL INFO  
    (Section 6.4.10) command can be used to obtain loading progress from  
    INSTRUMENT_STATUS field.  LOAD command will perform sanity checks  
    such as making sure that the file could be read and it is of a proper  
2412     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
2413     process should any errors be detected at that point.     process should any errors be detected at that point.
2414    
# Line 2327  Internet-Draft        LinuxSampler Contr Line 2435  Internet-Draft        LinuxSampler Contr
2435    
2436    
2437    
2438    6.4.2.  Loading a sampler engine
 6.4.2  Loading a sampler engine  
2439    
2440     A sampler engine type can be associated to a specific sampler channel     A sampler engine type can be associated to a specific sampler channel
2441     by the following command:     by the following command:
# Line 2345  Internet-Draft        LinuxSampler Contr Line 2452  Internet-Draft        LinuxSampler Contr
2452     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
2453     force if a new engine instance should be created and assigned to the     force if a new engine instance should be created and assigned to the
2454     given sampler channel or if an already existing instance of that     given sampler channel or if an already existing instance of that
2455       engine type, shared with other sampler channels, should be used.
2456    
2457       Possible Answers:
2458    
2459    
 Schoenebeck             Expires November 2, 2005               [Page 42]  
2460    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
2461    
2462    
2463     engine type, shared with other sampler channels, should be used.  Schoenebeck               Expires March 4, 2008                [Page 44]
2464    
2465    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2466    
    Possible Answers:  
2467    
2468        "OK" -        "OK" -
2469    
# Line 2376  Internet-Draft        LinuxSampler Contr Line 2484  Internet-Draft        LinuxSampler Contr
2484    
2485    
2486    
2487    6.4.3.  Getting all created sampler channel count
 6.4.3  Getting all created sampler channel count  
2488    
2489     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
2490     current amount of sampler channels, the front-end can send the     current amount of sampler channels, the front-end can send the
# Line 2396  Internet-Draft        LinuxSampler Contr Line 2503  Internet-Draft        LinuxSampler Contr
2503    
2504        S: "12"        S: "12"
2505    
2506    6.4.4.  Getting all created sampler channel list
 6.4.4  Getting all created sampler channel list  
2507    
2508     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
2509     current list of sampler channels, the front-end can send the     current list of sampler channels, the front-end can send the
2510       following command:
2511    
2512          LIST CHANNELS
2513    
2514       Possible Answers:
2515    
 Schoenebeck             Expires November 2, 2005               [Page 43]  
2516    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
2517    
2518    
2519     following command:  Schoenebeck               Expires March 4, 2008                [Page 45]
2520    
2521    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2522    
       LIST CHANNELS  
   
    Possible Answers:  
2523    
2524        LinuxSampler will answer by returning a comma separated list with        LinuxSampler will answer by returning a comma separated list with
2525        all sampler channels numerical IDs.        all sampler channels numerical IDs.
# Line 2424  Internet-Draft        LinuxSampler Contr Line 2530  Internet-Draft        LinuxSampler Contr
2530    
2531        S: "0,1,2,3,4,5,6,9,10,11,15,20"        S: "0,1,2,3,4,5,6,9,10,11,15,20"
2532    
2533    6.4.5.  Adding a new sampler channel
 6.4.5  Adding a new sampler channel  
2534    
2535     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2536     list by sending the following command:     list by sending the following command:
# Line 2457  Internet-Draft        LinuxSampler Contr Line 2562  Internet-Draft        LinuxSampler Contr
2562           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2563           code and warning message           code and warning message
2564    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 44]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2565        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2566    
2567           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2475  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  6.4.6  Removing a sampler channel  Schoenebeck               Expires March 4, 2008                [Page 46]
2576    
2577    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2578    
2579    
2580    
2581    
2582    6.4.6.  Removing a sampler channel
2583    
2584     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
2585    
# Line 2507  Internet-Draft        LinuxSampler Contr Line 2611  Internet-Draft        LinuxSampler Contr
2611    
2612    
2613    
2614    6.4.7.  Getting amount of available engines
 6.4.7  Getting amount of available engines  
2615    
2616     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
2617     the following command:     the following command:
2618    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2619        GET AVAILABLE_ENGINES        GET AVAILABLE_ENGINES
2620    
2621     Possible Answers:     Possible Answers:
# Line 2530  Internet-Draft        LinuxSampler Contr Line 2625  Internet-Draft        LinuxSampler Contr
2625    
2626     Example:     Example:
2627    
2628    
2629    
2630    
2631    Schoenebeck               Expires March 4, 2008                [Page 47]
2632    
2633    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2634    
2635    
2636        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2637    
2638        S: "4"        S: "4"
2639    
2640    6.4.8.  Getting all available engines
 6.4.8  Getting all available engines  
2641    
2642     The front-end can ask for a list of all available engines by sending     The front-end can ask for a list of all available engines by sending
2643     the following command:     the following command:
# Line 2555  Internet-Draft        LinuxSampler Contr Line 2657  Internet-Draft        LinuxSampler Contr
2657    
2658        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
2659    
2660    6.4.9.  Getting information about an engine
 6.4.9  Getting information about an engine  
2661    
2662     The front-end can ask for information about a specific engine by     The front-end can ask for information about a specific engine by
2663     sending the following command:     sending the following command:
# Line 2568  Internet-Draft        LinuxSampler Contr Line 2669  Internet-Draft        LinuxSampler Contr
2669    
2670     Possible Answers:     Possible Answers:
2671    
   
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2672        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2673        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2674        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 2589  Internet-Draft        LinuxSampler Contr Line 2681  Internet-Draft        LinuxSampler Contr
2681    
2682              arbitrary description text about the engine              arbitrary description text about the engine
2683    
2684    
2685    
2686    
2687    Schoenebeck               Expires March 4, 2008                [Page 48]
2688    
2689    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2690    
2691    
2692           VERSION -           VERSION -
2693    
2694              arbitrary character string regarding the engine's version              arbitrary character string regarding the engine's version
# Line 2605  Internet-Draft        LinuxSampler Contr Line 2705  Internet-Draft        LinuxSampler Contr
2705    
2706           "."           "."
2707    
2708    6.4.10.  Getting sampler channel information
 6.4.10  Getting sampler channel information  
2709    
2710     The front-end can ask for the current settings of a sampler channel     The front-end can ask for the current settings of a sampler channel
2711     by sending the following command:     by sending the following command:
# Line 2627  Internet-Draft        LinuxSampler Contr Line 2726  Internet-Draft        LinuxSampler Contr
2726    
2727    
2728    
   
 Schoenebeck             Expires November 2, 2005               [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
   
   
2729           ENGINE_NAME -           ENGINE_NAME -
2730    
2731              name of the engine that is associated with the sampler              name of the engine that is associated with the sampler
# Line 2646  Internet-Draft        LinuxSampler Contr Line 2737  Internet-Draft        LinuxSampler Contr
2737              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2738              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2739              signal, "NONE" if there's no device connected to this              signal, "NONE" if there's no device connected to this
2740    
2741    
2742    
2743    Schoenebeck               Expires March 4, 2008                [Page 49]
2744    
2745    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2746    
2747    
2748              sampler channel              sampler channel
2749    
2750           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
# Line 2682  Internet-Draft        LinuxSampler Contr Line 2781  Internet-Draft        LinuxSampler Contr
2781              loading exception.  Value of 100 indicates that the              loading exception.  Value of 100 indicates that the
2782              instrument is fully loaded.              instrument is fully loaded.
2783    
   
   
 Schoenebeck             Expires November 2, 2005               [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
2784           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2785    
2786              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
# Line 2700  Internet-Draft        LinuxSampler Contr Line 2792  Internet-Draft        LinuxSampler Contr
2792    
2793              port number of the MIDI input device              port number of the MIDI input device
2794    
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires March 4, 2008                [Page 50]
2800    
2801    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2802    
2803    
2804           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2805    
2806              the MIDI input channel number this sampler channel should              the MIDI input channel number this sampler channel should
# Line 2724  Internet-Draft        LinuxSampler Contr Line 2825  Internet-Draft        LinuxSampler Contr
2825              Determines whether this is a solo channel, "true" if the              Determines whether this is a solo channel, "true" if the
2826              channel is a solo channel; "false" otherwise              channel is a solo channel; "false" otherwise
2827    
2828             MIDI_INSTRUMENT_MAP -
2829    
2830                Determines to which MIDI instrument map this sampler channel
2831                is assigned to.  Read chapter "SET CHANNEL
2832                MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2833                values.
2834    
2835     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2836    
2837     Example:     Example:
# Line 2736  Internet-Draft        LinuxSampler Contr Line 2844  Internet-Draft        LinuxSampler Contr
2844    
2845           "AUDIO_OUTPUT_DEVICE: 0"           "AUDIO_OUTPUT_DEVICE: 0"
2846    
2847             "AUDIO_OUTPUT_CHANNELS: 2"
2848    
2849             "AUDIO_OUTPUT_ROUTING: 0,1"
2850    
2851    
2852    
 Schoenebeck             Expires November 2, 2005               [Page 49]  
2853    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
2854    
2855    Schoenebeck               Expires March 4, 2008                [Page 51]
2856    
2857    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2858    
          "AUDIO_OUTPUT_CHANNELS: 2"  
   
          "AUDIO_OUTPUT_ROUTING: 0,1"  
2859    
2860           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2861    
# Line 2763  Internet-Draft        LinuxSampler Contr Line 2871  Internet-Draft        LinuxSampler Contr
2871    
2872           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2873    
2874           "."           "VOLUME: 1.0"
2875    
2876             "MUTE: false"
2877    
2878  6.4.11  Current number of active voices           "SOLO: false"
2879    
2880             "MIDI_INSTRUMENT_MAP: NONE"
2881    
2882             "."
2883    
2884    6.4.11.  Current number of active voices
2885    
2886     The front-end can ask for the current number of active voices on a     The front-end can ask for the current number of active voices on a
2887     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 2787  Internet-Draft        LinuxSampler Contr Line 2902  Internet-Draft        LinuxSampler Contr
2902    
2903    
2904    
 6.4.12  Current number of active disk streams  
2905    
    The front-end can ask for the current number of active disk streams  
    on a sampler channel by sending the following command:  
2906    
2907    
2908    
2909    
2910    
2911  Schoenebeck             Expires November 2, 2005               [Page 50]  Schoenebeck               Expires March 4, 2008                [Page 52]
2912    
2913    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2914    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
2915    
2916    6.4.12.  Current number of active disk streams
2917    
2918       The front-end can ask for the current number of active disk streams
2919       on a sampler channel by sending the following command:
2920    
2921        GET CHANNEL STREAM_COUNT <sampler-channel>        GET CHANNEL STREAM_COUNT <sampler-channel>
2922    
# Line 2818  Internet-Draft        LinuxSampler Contr Line 2935  Internet-Draft        LinuxSampler Contr
2935    
2936    
2937    
2938    6.4.13.  Current fill state of disk stream buffers
 6.4.13  Current fill state of disk stream buffers  
2939    
2940     The front-end can ask for the current fill state of all disk streams     The front-end can ask for the current fill state of all disk streams
2941     on a sampler channel by sending the following command:     on a sampler channel by sending the following command:
# Line 2845  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961        will begin with the stream's ID in brackets followed by the        will begin with the stream's ID in brackets followed by the
2962        numerical representation of the fill size (either in bytes or        numerical representation of the fill size (either in bytes or
2963        percentage).  Note: due to efficiency reasons the fill states in        percentage).  Note: due to efficiency reasons the fill states in
       the response are not in particular order, thus the front-end has  
       to sort them by itself if necessary.  
2964    
    Examples:  
2965    
2966    
2967    Schoenebeck               Expires March 4, 2008                [Page 53]
2968    
2969    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
2970    
 Schoenebeck             Expires November 2, 2005               [Page 51]  
2971    
2972  Internet-Draft        LinuxSampler Control Protocol             May 2005        the response are not in particular order, thus the front-end has
2973          to sort them by itself if necessary.
2974    
2975       Examples:
2976    
2977        C: "GET CHANNEL BUFFER_FILL BYTES 4"        C: "GET CHANNEL BUFFER_FILL BYTES 4"
2978    
# Line 2869  Internet-Draft        LinuxSampler Contr Line 2986  Internet-Draft        LinuxSampler Contr
2986    
2987        S: ""        S: ""
2988    
2989    6.4.14.  Setting audio output device
 6.4.14  Setting audio output device  
2990    
2991     The front-end can set the audio output device on a specific sampler     The front-end can set the audio output device on a specific sampler
2992     channel by sending the following command:     channel by sending the following command:
# Line 2902  Internet-Draft        LinuxSampler Contr Line 3018  Internet-Draft        LinuxSampler Contr
3018           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3019           error message           error message
3020    
    Examples:  
   
   
   
3021    
3022    
3023  Schoenebeck             Expires November 2, 2005               [Page 52]  Schoenebeck               Expires March 4, 2008                [Page 54]
3024    
3025  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3026    
3027    
3028       Examples:
3029    
3030    
3031    
3032  6.4.15  Setting audio output type  6.4.15.  Setting audio output type
3033    
3034     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3035    
# Line 2950  Internet-Draft        LinuxSampler Contr Line 3063  Internet-Draft        LinuxSampler Contr
3063    
3064    
3065    
3066    6.4.16.  Setting audio output channel
 6.4.16  Setting audio output channel  
3067    
3068     The front-end can alter the audio output channel on a specific     The front-end can alter the audio output channel on a specific
3069     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 2964  Internet-Draft        LinuxSampler Contr Line 3076  Internet-Draft        LinuxSampler Contr
3076    
3077    
3078    
3079  Schoenebeck             Expires November 2, 2005               [Page 53]  Schoenebeck               Expires March 4, 2008                [Page 55]
3080    
3081  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3082    
3083    
3084     command, <audio-out> is the numerical ID of the sampler channel's     command, <audio-out> is the numerical ID of the sampler channel's
# Line 2995  Internet-Draft        LinuxSampler Contr Line 3107  Internet-Draft        LinuxSampler Contr
3107    
3108    
3109    
3110    6.4.17.  Setting MIDI input device
 6.4.17  Setting MIDI input device  
3111    
3112     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
3113     channel by sending the following command:     channel by sending the following command:
# Line 3005  Internet-Draft        LinuxSampler Contr Line 3116  Internet-Draft        LinuxSampler Contr
3116    
3117     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
3118     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3119     command and <midi-device-id> is  the numerical ID of the MIDI input     command and <midi-device-id> is the numerical ID of the MIDI input
3120     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3121     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3122    
# Line 3015  Internet-Draft        LinuxSampler Contr Line 3126  Internet-Draft        LinuxSampler Contr
3126    
3127           on success           on success
3128    
3129          "WRN:<warning-code>:<warning-message>" -
3130    
3131    
3132    
3133    
3134    
3135  Schoenebeck             Expires November 2, 2005               [Page 54]  Schoenebeck               Expires March 4, 2008                [Page 56]
3136    
3137  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
   
3138    
       "WRN:<warning-code>:<warning-message>" -  
3139    
3140           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
3141           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
# Line 3040  Internet-Draft        LinuxSampler Contr Line 3150  Internet-Draft        LinuxSampler Contr
3150    
3151    
3152    
3153    6.4.18.  Setting MIDI input type
 6.4.18  Setting MIDI input type  
3154    
3155     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3156    
# Line 3076  Internet-Draft        LinuxSampler Contr Line 3185  Internet-Draft        LinuxSampler Contr
3185    
3186    
3187    
 Schoenebeck             Expires November 2, 2005               [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
3188    
3189    
3190    
3191    Schoenebeck               Expires March 4, 2008                [Page 57]
3192    
3193    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3194    
3195    
3196  6.4.19  Setting MIDI input port  6.4.19.  Setting MIDI input port
3197    
3198     The front-end can alter the MIDI input port on a specific sampler     The front-end can alter the MIDI input port on a specific sampler
3199     channel by sending the following command:     channel by sending the following command:
# Line 3115  Internet-Draft        LinuxSampler Contr Line 3224  Internet-Draft        LinuxSampler Contr
3224    
3225    
3226    
3227    6.4.20.  Setting MIDI input channel
 6.4.20  Setting MIDI input channel  
3228    
3229     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3230     listen to by sending the following command:     listen to by sending the following command:
# Line 3129  Internet-Draft        LinuxSampler Contr Line 3237  Internet-Draft        LinuxSampler Contr
3237    
3238     Possible Answers:     Possible Answers:
3239    
3240          "OK" -
3241    
3242             on success
3243    
3244    
 Schoenebeck             Expires November 2, 2005               [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
3245    
3246    
3247        "OK" -  Schoenebeck               Expires March 4, 2008                [Page 58]
3248    
3249    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3250    
          on success  
3251    
3252        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3253    
# Line 3156  Internet-Draft        LinuxSampler Contr Line 3264  Internet-Draft        LinuxSampler Contr
3264    
3265    
3266    
3267    6.4.21.  Setting channel volume
 6.4.21  Setting channel volume  
3268    
3269     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
3270     the following command:     the following command:
# Line 3186  Internet-Draft        LinuxSampler Contr Line 3293  Internet-Draft        LinuxSampler Contr
3293           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3294           error message           error message
3295    
3296       Examples:
3297    
3298    
3299    
 Schoenebeck             Expires November 2, 2005               [Page 57]  
3300    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
3301    
3302    
3303     Examples:  Schoenebeck               Expires March 4, 2008                [Page 59]
3304    
3305    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3306    
3307    
3308    
3309    
3310  6.4.22  Muting a sampler channel  6.4.22.  Muting a sampler channel
3311    
3312     The front-end can mute/unmute a specific sampler channel by sending     The front-end can mute/unmute a specific sampler channel by sending
3313     the following command:     the following command:
# Line 3231  Internet-Draft        LinuxSampler Contr Line 3340  Internet-Draft        LinuxSampler Contr
3340    
3341    
3342    
3343    6.4.23.  Soloing a sampler channel
 6.4.23  Soloing a sampler channel  
3344    
3345     The front-end can solo/unsolo a specific sampler channel by sending     The front-end can solo/unsolo a specific sampler channel by sending
3346     the following command:     the following command:
# Line 3241  Internet-Draft        LinuxSampler Contr Line 3349  Internet-Draft        LinuxSampler Contr
3349    
3350     Where <sampler-channel> is the respective sampler channel number as     Where <sampler-channel> is the respective sampler channel number as
3351     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3352       (Section 6.4.4) command and <solo> should be replaced either by "1"
3353       to solo the channel or "0" to unsolo the channel.
3354    
3355       Possible Answers:
3356    
3357    
 Schoenebeck             Expires November 2, 2005               [Page 58]  
3358    
3359  Internet-Draft        LinuxSampler Control Protocol             May 2005  Schoenebeck               Expires March 4, 2008                [Page 60]
3360    
3361    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3362    
3363    
3364     (Section 6.4.4) command and <solo> should be replaced either by "1"        "OK" -
3365     to solo the channel or "0" to unsolo the channel.  
3366             on success
3367    
3368          "WRN:<warning-code>:<warning-message>" -
3369    
3370             if the channel was soloed/unsoloed, but there are noteworthy
3371             issue(s) related, providing an appropriate warning code and
3372             warning message
3373    
3374          "ERR:<error-code>:<error-message>" -
3375    
3376             in case it failed, providing an appropriate error code and
3377             error message
3378    
3379       Examples:
3380    
3381    
3382    
3383    6.4.24.  Assigning a MIDI instrument map to a sampler channel
3384    
3385       The front-end can assign a MIDI instrument map to a specific sampler
3386       channel by sending the following command:
3387    
3388          SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3389    
3390       Where <sampler-channel> is the respective sampler channel number as
3391       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3392       (Section 6.4.4) command and <map> can have the following
3393       possibilites:
3394    
3395          "NONE" -
3396    
3397             This is the default setting.  In this case the sampler channel
3398             is not assigned any MIDI instrument map and thus will ignore
3399             all MIDI program change messages.
3400    
3401          "DEFAULT" -
3402    
3403             The sampler channel will always use the default MIDI instrument
3404             map to handle MIDI program change messages.
3405    
3406          numeric ID -
3407    
3408             You can assign a specific MIDI instrument map by replacing
3409             <map> with the respective numeric ID of the MIDI instrument map
3410             as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3411             command.  Once that map will be deleted, the sampler channel
3412    
3413    
3414    
3415    Schoenebeck               Expires March 4, 2008                [Page 61]
3416    
3417    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3418    
3419    
3420             would fall back to "NONE".
3421    
3422       Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3423       regarding MIDI instrument mapping.
3424    
3425     Possible Answers:     Possible Answers:
3426    
# Line 3258  Internet-Draft        LinuxSampler Contr Line 3428  Internet-Draft        LinuxSampler Contr
3428    
3429           on success           on success
3430    
3431          "ERR:<error-code>:<error-message>" -
3432    
3433             in case it failed, providing an appropriate error code and
3434             error message
3435    
3436       Examples:
3437    
3438    
3439    
3440    6.4.25.  Adding an effect send to a sampler channel
3441    
3442       The front-end can create an additional effect send on a specific
3443       sampler channel by sending the following command:
3444    
3445          CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3446    
3447       Where <sampler-channel> is the respective sampler channel number as
3448       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3449       (Section 6.4.4) command, that is the sampler channel on which the
3450       effect send should be created on, <midi-ctrl> is a number between
3451       0..127 defining the MIDI controller which can alter the effect send
3452       level and <name> is an optional argument defining a name for the
3453       effect send entity.  The name does not have to be unique.
3454    
3455       By default, that is as initial routing, the effect send's audio
3456       channels are automatically routed to the last audio channels of the
3457       sampler channel's audio output device, that way you can i.e. first
3458       increase the amount of audio channels on the audio output device for
3459       having dedicated effect send output channels and when "CREATE
3460       FX_SEND" is called, those channels will automatically be picked.  You
3461       can alter the destination channels however with "SET FX_SEND
3462       AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3463    
3464       Note: Create effect sends on a sampler channel only when needed,
3465       because having effect sends on a sampler channel will decrease
3466       runtime performance, because for implementing channel effect sends,
3467       separate (sampler channel local) audio buffers are needed to render
3468    
3469    
3470    
3471    Schoenebeck               Expires March 4, 2008                [Page 62]
3472    
3473    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3474    
3475    
3476       and mix the voices and route the audio signal afterwards to the
3477       master outputs and effect send outputs (along with their respective
3478       effect send levels).  A sampler channel without effect sends however
3479       can mix its voices directly into the audio output devices's audio
3480       buffers and is thus faster.
3481    
3482       Possible Answers:
3483    
3484          "OK[<fx-send-id>]" -
3485    
3486             in case a new effect send could be added to the sampler
3487             channel, where <fx-send-id> reflects the unique ID of the newly
3488             created effect send entity
3489    
3490          "ERR:<error-code>:<error-message>" -
3491    
3492             when a new effect send could not be added, i.e. due to invalid
3493             parameters
3494    
3495       Examples:
3496    
3497          C: "CREATE FX_SEND 0 91 'Reverb Send'"
3498    
3499          S: "OK[0]"
3500    
3501          C: "CREATE FX_SEND 0 93"
3502    
3503          S: "OK[1]"
3504    
3505    6.4.26.  Removing an effect send from a sampler channel
3506    
3507       The front-end can remove an existing effect send on a specific
3508       sampler channel by sending the following command:
3509    
3510          DESTROY FX_SEND <sampler-channel> <fx-send-id>
3511    
3512       Where <sampler-channel> is the respective sampler channel number as
3513       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3514       (Section 6.4.4) command, that is the sampler channel from which the
3515       effect send should be removed from and <fx-send-id> is the respective
3516       effect send number as returned by the "CREATE FX_SEND"
3517       (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3518    
3519       Possible Answers:
3520    
3521          "OK" -
3522    
3523    
3524    
3525    
3526    
3527    Schoenebeck               Expires March 4, 2008                [Page 63]
3528    
3529    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3530    
3531    
3532             on success
3533    
3534          "ERR:<error-code>:<error-message>" -
3535    
3536             in case it failed, providing an appropriate error code and
3537             error message
3538    
3539       Example:
3540    
3541          C: "DESTROY FX_SEND 0 0"
3542    
3543          S: "OK"
3544    
3545    6.4.27.  Getting amount of effect sends on a sampler channel
3546    
3547       The front-end can ask for the amount of effect sends on a specific
3548       sampler channel by sending the following command:
3549    
3550          GET FX_SENDS <sampler-channel>
3551    
3552       Where <sampler-channel> is the respective sampler channel number as
3553       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3554       (Section 6.4.4) command.
3555    
3556       Possible Answers:
3557    
3558          The sampler will answer by returning the number of effect sends on
3559          the given sampler channel.
3560    
3561       Example:
3562    
3563          C: "GET FX_SENDS 0"
3564    
3565          S: "2"
3566    
3567    6.4.28.  Listing all effect sends on a sampler channel
3568    
3569       The front-end can ask for a list of effect sends on a specific
3570       sampler channel by sending the following command:
3571    
3572          LIST FX_SENDS <sampler-channel>
3573    
3574       Where <sampler-channel> is the respective sampler channel number as
3575       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3576       (Section 6.4.4) command.
3577    
3578       Possible Answers:
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires March 4, 2008                [Page 64]
3584    
3585    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3586    
3587    
3588          The sampler will answer by returning a comma separated list with
3589          all effect sends' numerical IDs on the given sampler channel.
3590    
3591       Examples:
3592    
3593          C: "LIST FX_SENDS 0"
3594    
3595          S: "0,1"
3596    
3597          C: "LIST FX_SENDS 1"
3598    
3599          S: ""
3600    
3601    6.4.29.  Getting effect send information
3602    
3603       The front-end can ask for the current settings of an effect send
3604       entity by sending the following command:
3605    
3606          GET FX_SEND INFO <sampler-channel> <fx-send-id>
3607    
3608       Where <sampler-channel> is the sampler channel number as returned by
3609       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3610       command and <fx-send-id> reflects the numerical ID of the effect send
3611       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3612       FX_SENDS" (Section 6.4.28) command.
3613    
3614       Possible Answers:
3615    
3616          The sampler will answer by sending a <CRLF> separated list.  Each
3617          answer line begins with the settings category name followed by a
3618          colon and then a space character <SP> and finally the info
3619          character string to that setting category.  At the moment the
3620          following categories are defined:
3621    
3622    
3623    
3624             NAME -
3625    
3626                name of the effect send entity
3627    
3628             MIDI_CONTROLLER -
3629    
3630                a value between 0 and 127 reflecting the MIDI controller
3631                which is able to modify the effect send's send level
3632    
3633             LEVEL -
3634    
3635    
3636    
3637    
3638    
3639    Schoenebeck               Expires March 4, 2008                [Page 65]
3640    
3641    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3642    
3643    
3644                optionally dotted number reflecting the effect send's
3645                current send level (where a value < 1.0 means attenuation
3646                and a value > 1.0 means amplification)
3647    
3648             AUDIO_OUTPUT_ROUTING -
3649    
3650                comma separated list which reflects to which audio channel
3651                of the selected audio output device each effect send output
3652                channel is routed to, e.g. "0,3" would mean the effect
3653                send's output channel 0 is routed to channel 0 of the audio
3654                output device and the effect send's output channel 1 is
3655                routed to the channel 3 of the audio output device (see "SET
3656                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3657    
3658       The mentioned fields above don't have to be in particular order.
3659    
3660       Example:
3661    
3662          C: "GET FX_SEND INFO 0 0"
3663    
3664          S: "NAME: Reverb Send"
3665    
3666             "MIDI_CONTROLLER: 91"
3667    
3668             "LEVEL: 0.3"
3669    
3670             "AUDIO_OUTPUT_ROUTING: 2,3"
3671    
3672             "."
3673    
3674    6.4.30.  Changing effect send's name
3675    
3676       The front-end can alter the current name of an effect send entity by
3677       sending the following command:
3678    
3679          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3680    
3681       Where <sampler-chan> is the sampler channel number as returned by the
3682       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3683       command, <fx-send-id> reflects the numerical ID of the effect send
3684       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3685       FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3686       effect send entity, which does not have to be unique.
3687    
3688       Possible Answers:
3689    
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires March 4, 2008                [Page 66]
3696    
3697    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3698    
3699    
3700          "OK" -
3701    
3702             on success
3703    
3704          "ERR:<error-code>:<error-message>" -
3705    
3706             in case it failed, providing an appropriate error code and
3707             error message
3708    
3709       Example:
3710    
3711          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3712    
3713          S: "OK"
3714    
3715    6.4.31.  Altering effect send's audio routing
3716    
3717       The front-end can alter the destination of an effect send's audio
3718       channel on a specific sampler channel by sending the following
3719       command:
3720    
3721          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3722          <audio-src> <audio-dst>
3723    
3724       Where <sampler-chan> is the sampler channel number as returned by the
3725       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3726       command, <fx-send-id> reflects the numerical ID of the effect send
3727       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3728       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3729       of the effect send's audio channel which should be rerouted and
3730       <audio-dst> is the numerical ID of the audio channel of the selected
3731       audio output device where <audio-src> should be routed to.
3732    
3733       Note that effect sends can only route audio to the same audio output
3734       device as assigned to the effect send's sampler channel.  Also note
3735       that an effect send entity does always have exactly as much audio
3736       channels as its sampler channel.  So if the sampler channel is
3737       stereo, the effect send does have two audio channels as well.  Also
3738       keep in mind that the amount of audio channels on a sampler channel
3739       might be dependant not only to the deployed sampler engine on the
3740       sampler channel, but also dependant to the instrument currently
3741       loaded.  However you can (effectively) turn an i.e. stereo effect
3742       send into a mono one by simply altering its audio routing
3743       appropriately.
3744    
3745       Possible Answers:
3746    
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires March 4, 2008                [Page 67]
3752    
3753    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3754    
3755    
3756          "OK" -
3757    
3758             on success
3759    
3760        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3761    
3762           if the channel was soloed/unsoloed, but there are noteworthy           if audio output channel was set, but there are noteworthy
3763           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3764           warning message           warning message
3765    
# Line 3269  Internet-Draft        LinuxSampler Contr Line 3768  Internet-Draft        LinuxSampler Contr
3768           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3769           error message           error message
3770    
3771     Examples:     Example:
3772    
3773          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3774    
3775          S: "OK"
3776    
3777    6.4.32.  Altering effect send's MIDI controller
3778    
3779       The front-end can alter the MIDI controller of an effect send entity
3780       by sending the following command:
3781    
3782          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3783          ctrl>
3784    
3785       Where <sampler-chan> is the sampler channel number as returned by the
3786       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3787       command, <fx-send-id> reflects the numerical ID of the effect send
3788       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3789       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3790       controller which shall be able to modify the effect send's send
3791       level.
3792    
3793       Possible Answers:
3794    
3795          "OK" -
3796    
3797             on success
3798    
3799          "WRN:<warning-code>:<warning-message>" -
3800    
3801             if MIDI controller was set, but there are noteworthy issue(s)
3802             related, providing an appropriate warning code and warning
3803             message
3804    
3805    
3806    
3807    Schoenebeck               Expires March 4, 2008                [Page 68]
3808    
3809    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3810    
3811    
3812          "ERR:<error-code>:<error-message>" -
3813    
3814             in case it failed, providing an appropriate error code and
3815             error message
3816    
3817       Example:
3818    
3819          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3820    
3821          S: "OK"
3822    
3823    6.4.33.  Altering effect send's send level
3824    
3825       The front-end can alter the current send level of an effect send
3826       entity by sending the following command:
3827    
3828          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3829    
3830       Where <sampler-chan> is the sampler channel number as returned by the
3831       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3832       command, <fx-send-id> reflects the numerical ID of the effect send
3833       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3834       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3835       dotted positive number (a value smaller than 1.0 means attenuation,
3836       whereas a value greater than 1.0 means amplification) reflecting the
3837       new send level.
3838    
3839       Possible Answers:
3840    
3841          "OK" -
3842    
3843             on success
3844    
3845          "WRN:<warning-code>:<warning-message>" -
3846    
3847  6.4.24  Resetting a sampler channel           if new send level was set, but there are noteworthy issue(s)
3848             related, providing an appropriate warning code and warning
3849             message
3850    
3851          "ERR:<error-code>:<error-message>" -
3852    
3853             in case it failed, providing an appropriate error code and
3854             error message
3855    
3856       Example:
3857    
3858    
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires March 4, 2008                [Page 69]
3864    
3865    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3866    
3867    
3868          C: "SET FX_SEND LEVEL 0 0 0.15"
3869    
3870          S: "OK"
3871    
3872    6.4.34.  Resetting a sampler channel
3873    
3874     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3875     following command:     following command:
# Line 3298  Internet-Draft        LinuxSampler Contr Line 3893  Internet-Draft        LinuxSampler Contr
3893           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3894           message           message
3895    
   
   
 Schoenebeck             Expires November 2, 2005               [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
3896        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3897    
3898           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3314  Internet-Draft        LinuxSampler Contr Line 3902  Internet-Draft        LinuxSampler Contr
3902    
3903    
3904    
3905    6.5.  Controlling connection
 6.5  Controlling connection  
3906    
3907     The following commands are used to control the connection to     The following commands are used to control the connection to
3908     LinuxSampler.     LinuxSampler.
3909    
3910  6.5.1  Register front-end for receiving event messages  6.5.1.  Register front-end for receiving event messages
3911    
3912     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3913     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3914    
3915    
3916    
3917    
3918    
3919    Schoenebeck               Expires March 4, 2008                [Page 70]
3920    
3921    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3922    
3923    
3924        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3925    
3926     where <event-id> will be replaced by the respective event that client     where <event-id> will be replaced by the respective event that client
# Line 3351  Internet-Draft        LinuxSampler Contr Line 3947  Internet-Draft        LinuxSampler Contr
3947    
3948    
3949    
3950    6.5.2.  Unregister front-end for not receiving event messages
   
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
 6.5.2  Unregister front-end for not receiving event messages  
3951    
3952     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
3953     event messages anymore by sending the following command:     event messages anymore by sending the following command:
# Line 3383  Internet-Draft        LinuxSampler Contr Line 3969  Internet-Draft        LinuxSampler Contr
3969           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3970           message           message
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires March 4, 2008                [Page 71]
3976    
3977    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
3978    
3979    
3980        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3981    
3982           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3392  Internet-Draft        LinuxSampler Contr Line 3986  Internet-Draft        LinuxSampler Contr
3986    
3987    
3988    
3989    6.5.3.  Enable or disable echo of commands
 6.5.3  Enable or disable echo of commands  
3990    
3991     To enable or disable back sending of commands to the client the     To enable or disable back sending of commands to the client the
3992     following command can be used:     following command can be used:
# Line 3409  Internet-Draft        LinuxSampler Contr Line 4002  Internet-Draft        LinuxSampler Contr
4002    
4003     Possible Answers:     Possible Answers:
4004    
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
4005        "OK" -        "OK" -
4006    
4007           usually           usually
# Line 3429  Internet-Draft        LinuxSampler Contr Line 4014  Internet-Draft        LinuxSampler Contr
4014    
4015    
4016    
4017    6.5.4.  Close client connection
 6.5.4  Close client connection  
4018    
4019     The client can close its network connection to LinuxSampler by     The client can close its network connection to LinuxSampler by
4020     sending the following command:     sending the following command:
# Line 3440  Internet-Draft        LinuxSampler Contr Line 4024  Internet-Draft        LinuxSampler Contr
4024     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
4025     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
4026    
4027  6.6  Global commands  
4028    
4029    
4030    
4031    Schoenebeck               Expires March 4, 2008                [Page 72]
4032    
4033    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4034    
4035    
4036    6.6.  Global commands
4037    
4038     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
4039    
4040  6.6.1  Reset sampler  6.6.1.  Current number of active voices
4041    
4042       The front-end can ask for the current number of active voices on the
4043       sampler by sending the following command:
4044    
4045          GET TOTAL_VOICE_COUNT
4046    
4047       Possible Answers:
4048    
4049          LinuxSampler will answer by returning the number of all active
4050          voices on the sampler.
4051    
4052    6.6.2.  Maximum amount of active voices
4053    
4054       The front-end can ask for the maximum number of active voices by
4055       sending the following command:
4056    
4057          GET TOTAL_VOICE_COUNT_MAX
4058    
4059       Possible Answers:
4060    
4061          LinuxSampler will answer by returning the maximum number of active
4062          voices.
4063    
4064    6.6.3.  Reset sampler
4065    
4066     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
4067     command:     command:
# Line 3462  Internet-Draft        LinuxSampler Contr Line 4079  Internet-Draft        LinuxSampler Contr
4079    
4080    
4081    
 6.6.2  General sampler informations  
4082    
    The client can ask for general informations about the LinuxSampler  
4083    
4084    
4085    
 Schoenebeck             Expires November 2, 2005               [Page 62]  
4086    
4087  Internet-Draft        LinuxSampler Control Protocol             May 2005  Schoenebeck               Expires March 4, 2008                [Page 73]
4088    
4089    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4090    
4091    
4092    6.6.4.  General sampler informations
4093    
4094       The client can ask for general informations about the LinuxSampler
4095     instance by sending the following command:     instance by sending the following command:
4096    
4097        GET SERVER INFO        GET SERVER INFO
# Line 3500  Internet-Draft        LinuxSampler Contr Line 4119  Internet-Draft        LinuxSampler Contr
4119              version of the LSCP specification the sampler complies with              version of the LSCP specification the sampler complies with
4120              (see Section 2 for details)              (see Section 2 for details)
4121    
4122             INSTRUMENTS_DB_SUPPORT -
4123    
4124                either yes or no, specifies whether the sampler is build
4125                with instruments database support.
4126    
4127     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4128     Other fields might be added in future.     Other fields might be added in future.
4129    
4130    6.6.5.  Getting global volume attenuation
4131    
4132       The client can ask for the current global sampler-wide volume
4133       attenuation by sending the following command:
4134    
4135          GET VOLUME
4136    
4137       Possible Answers:
4138    
4139    
4140    
4141    
4142    
4143    Schoenebeck               Expires March 4, 2008                [Page 74]
4144    
4145    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4146    
4147    
4148          The sampler will always answer by returning the optional dotted
4149          floating point coefficient, reflecting the current global volume
4150          attenuation.
4151    
4152       Note: it is up to the respective sampler engine whether to obey that
4153       global volume parameter or not, but in general all engines SHOULD use
4154       this parameter.
4155    
4156    6.6.6.  Setting global volume attenuation
4157    
4158       The client can alter the current global sampler-wide volume
4159       attenuation by sending the following command:
4160    
4161          SET VOLUME <volume>
4162    
4163       Where <volume> should be replaced by the optional dotted floating
4164       point value, reflecting the new global volume parameter.  This value
4165       might usually be in the range between 0.0 and 1.0, that is for
4166       attenuating the overall volume.
4167    
4168       Possible Answers:
4169    
4170          "OK" -
4171    
4172             on success
4173    
4174          "WRN:<warning-code>:<warning-message>" -
4175    
4176             if the global volume was set, but there are noteworthy issue(s)
4177             related, providing an appropriate warning code and warning
4178             message
4179    
4180          "ERR:<error-code>:<error-message>" -
4181    
4182             in case it failed, providing an appropriate error code and
4183             error message
4184    
4185    6.7.  MIDI Instrument Mapping
4186    
4187       The MIDI protocol provides a way to switch between instruments by
4188       sending so called MIDI bank select and MIDI program change messages
4189       which are essentially just numbers.  The following commands allow to
4190       actually map arbitrary MIDI bank select / program change numbers with
4191       real instruments.
4192    
4193       The sampler allows to manage an arbitrary amount of MIDI instrument
4194       maps which define which instrument to load on which MIDI program
4195       change message.
4196    
4197    
4198    
4199    Schoenebeck               Expires March 4, 2008                [Page 75]
4200    
4201    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4202    
4203    
4204       By default, that is when the sampler is launched, there is no map,
4205       thus the sampler will simply ignore all program change messages.  The
4206       front-end has to explicitly create at least one map, add entries to
4207       the map and tell the respective sampler channel(s) which MIDI
4208       instrument map to use, so the sampler knows how to react on a given
4209       program change message on the respective sampler channel, that is by
4210       switching to the respectively defined engine type and loading the
4211       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4212       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4213       channel.
4214    
4215       Also note per MIDI specification a bank select message does not cause
4216       to switch to another instrument.  Instead when receiving a bank
4217       select message the bank value will be stored and a subsequent program
4218       change message (which may occur at any time) will finally cause the
4219       sampler to switch to the respective instrument as reflected by the
4220       current MIDI instrument map.
4221    
4222    6.7.1.  Create a new MIDI instrument map
4223    
4224       The front-end can add a new MIDI instrument map by sending the
4225       following command:
4226    
4227          ADD MIDI_INSTRUMENT_MAP [<name>]
4228    
4229       Where <name> is an optional argument allowing to assign a custom name
4230       to the new map.  MIDI instrument Map names do not have to be unique.
4231    
4232       Possible Answers:
4233    
4234          "OK[<map>]" -
4235    
4236             in case a new MIDI instrument map could be added, where <map>
4237             reflects the unique ID of the newly created MIDI instrument map
4238    
4239          "ERR:<error-code>:<error-message>" -
4240    
4241             when a new map could not be created, which might never occur in
4242             practice
4243    
4244       Examples:
4245    
4246          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4247    
4248          S: "OK[0]"
4249    
4250    
4251    
4252    
4253    
4254    
4255    Schoenebeck               Expires March 4, 2008                [Page 76]
4256    
4257    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4258    
4259    
4260          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4261    
4262          S: "OK[1]"
4263    
4264          C: "ADD MIDI_INSTRUMENT_MAP"
4265    
4266          S: "OK[5]"
4267    
4268    6.7.2.  Delete one particular or all MIDI instrument maps
4269    
4270       The front-end can delete a particular MIDI instrument map by sending
4271       the following command:
4272    
4273          REMOVE MIDI_INSTRUMENT_MAP <map>
4274    
4275       Where <map> reflects the unique ID of the map to delete as returned
4276       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4277    
4278       The front-end can delete all MIDI instrument maps by sending the
4279       following command:
4280    
4281          REMOVE MIDI_INSTRUMENT_MAP ALL
4282    
4283       Possible Answers:
4284    
4285          "OK" -
4286    
4287             in case the map(s) could be deleted
4288    
4289          "ERR:<error-code>:<error-message>" -
4290    
4291             when the given map does not exist
4292    
4293       Examples:
4294    
4295          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4296    
4297          S: "OK"
4298    
4299          C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
4300    
4301          S: "OK"
4302    
4303    6.7.3.  Get amount of existing MIDI instrument maps
4304    
4305       The front-end can retrieve the current amount of MIDI instrument maps
4306       by sending the following command:
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires March 4, 2008                [Page 77]
4312    
4313    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4314    
4315    
4316          GET MIDI_INSTRUMENT_MAPS
4317    
4318       Possible Answers:
4319    
4320          The sampler will answer by returning the current number of MIDI
4321          instrument maps.
4322    
4323       Example:
4324    
4325          C: "GET MIDI_INSTRUMENT_MAPS"
4326    
4327          S: "2"
4328    
4329    6.7.4.  Getting all created MIDI instrument maps
4330    
4331       The number of MIDI instrument maps can change on runtime.  To get the
4332       current list of MIDI instrument maps, the front-end can send the
4333       following command:
4334    
4335          LIST MIDI_INSTRUMENT_MAPS
4336    
4337       Possible Answers:
4338    
4339          The sampler will answer by returning a comma separated list with
4340          all MIDI instrument maps' numerical IDs.
4341    
4342       Example:
4343    
4344          C: "LIST MIDI_INSTRUMENT_MAPS"
4345    
4346          S: "0,1,5,12"
4347    
4348    6.7.5.  Getting MIDI instrument map information
4349    
4350       The front-end can ask for the current settings of a MIDI instrument
4351       map by sending the following command:
4352    
4353          GET MIDI_INSTRUMENT_MAP INFO <map>
4354    
4355       Where <map> is the numerical ID of the map the front-end is
4356       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4357       (Section 6.7.4) command.
4358    
4359       Possible Answers:
4360    
4361          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4362          answer line begins with the settings category name followed by a
4363          colon and then a space character <SP> and finally the info
4364    
4365    
4366    
4367    Schoenebeck               Expires March 4, 2008                [Page 78]
4368    
4369    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4370    
4371    
4372          character string to that setting category.  At the moment the
4373          following categories are defined:
4374    
4375    
4376    
4377             NAME -
4378    
4379                custom name of the given map, which does not have to be
4380                unique
4381    
4382             DEFAULT -
4383    
4384                either true or false, defines whether this map is the
4385                default map
4386    
4387       The mentioned fields above don't have to be in particular order.
4388    
4389       Example:
4390    
4391          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4392    
4393          S: "NAME: Standard Map"
4394    
4395             "DEFAULT: true"
4396    
4397             "."
4398    
4399    6.7.6.  Renaming a MIDI instrument map
4400    
4401       The front-end can alter the custom name of a MIDI instrument map by
4402       sending the following command:
4403    
4404          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4405    
4406       Where <map> is the numerical ID of the map and <name> the new custom
4407       name of the map, which does not have to be unique.
4408    
4409       Possible Answers:
4410    
4411          "OK" -
4412    
4413             on success
4414    
4415          "ERR:<error-code>:<error-message>" -
4416    
4417             in case the given map does not exist
4418    
4419       Example:
4420    
4421    
4422    
4423    Schoenebeck               Expires March 4, 2008                [Page 79]
4424    
4425    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4426    
4427    
4428          C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4429    
4430          S: "OK"
4431    
4432    6.7.7.  Create or replace a MIDI instrument map entry
4433    
4434       The front-end can create a new or replace an existing entry in a
4435       sampler's MIDI instrument map by sending the following command:
4436    
4437          MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4438          <engine_name> <filename> <instrument_index> <volume_value>
4439          [<instr_load_mode>] [<name>]
4440    
4441       Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4442       integer value between 0..16383 reflecting the MIDI bank select index,
4443       <midi_prog> an integer value between 0..127 reflecting the MIDI
4444       program change index, <engine_name> a sampler engine name as returned
4445       by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4446       encapsulated into apostrophes), <filename> the name of the
4447       instrument's file to be deployed (encapsulated into apostrophes,
4448       supporting escape sequences as described in chapter "Character Set
4449       and Escape Sequences (Section 7.1)"), <instrument_index> the index
4450       (integer value) of the instrument within the given file,
4451       <volume_value> reflects the master volume of the instrument as
4452       optionally dotted number (where a value < 1.0 means attenuation and a
4453       value > 1.0 means amplification).  This parameter easily allows to
4454       adjust the volume of all intruments within a custom instrument map
4455       without having to adjust their instrument files.  The OPTIONAL
4456       <instr_load_mode> argument defines the life time of the instrument,
4457       that is when the instrument should be loaded, when freed and has
4458       exactly the following possibilities:
4459    
4460          "ON_DEMAND" -
4461    
4462             The instrument will be loaded when needed, that is when
4463             demanded by at least one sampler channel.  It will immediately
4464             be freed from memory when not needed by any sampler channel
4465             anymore.
4466    
4467          "ON_DEMAND_HOLD" -
4468    
4469             The instrument will be loaded when needed, that is when
4470             demanded by at least one sampler channel.  It will be kept in
4471             memory even when not needed by any sampler channel anymore.
4472             Instruments with this mode are only freed when the sampler is
4473             reset or all mapping entries with this mode (and respective
4474             instrument) are explicitly changed to "ON_DEMAND" and no
4475             sampler channel is using the instrument anymore.
4476    
4477    
4478    
4479    Schoenebeck               Expires March 4, 2008                [Page 80]
4480    
4481    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4482    
4483    
4484          "PERSISTENT" -
4485    
4486             The instrument will immediately be loaded into memory when this
4487             mapping command is sent and the instrument is kept all the
4488             time.  Instruments with this mode are only freed when the
4489             sampler is reset or all mapping entries with this mode (and
4490             respective instrument) are explicitly changed to "ON_DEMAND"
4491             and no sampler channel is using the instrument anymore.
4492    
4493          not supplied -
4494    
4495             In case there is no <instr_load_mode> argument given, it will
4496             be up to the InstrumentManager to decide which mode to use.
4497             Usually it will use "ON_DEMAND" if an entry for the given
4498             instrument does not exist in the InstrumentManager's list yet,
4499             otherwise if an entry already exists, it will simply stick with
4500             the mode currently reflected by the already existing entry,
4501             that is it will not change the mode.
4502    
4503       The <instr_load_mode> argument thus allows to define an appropriate
4504       strategy (low memory consumption vs. fast instrument switching) for
4505       each instrument individually.  Note, the following restrictions apply
4506       to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4507       supported by the respective sampler engine (which is technically the
4508       case when the engine provides an InstrumentManager for its format).
4509       If this is not the case the argument will automatically fall back to
4510       the default value "ON_DEMAND".  Also the load mode of one instrument
4511       may automatically change the laod mode of other instrument(s), i.e.
4512       because the instruments are part of the same file and the engine does
4513       not allow a way to manage load modes for them individually.  Due to
4514       this, in case the frontend shows the load modes of entries, the
4515       frontend should retrieve the actual mode by i.e. sending "GET
4516       MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4517       OPTIONAL <name> argument allows to set a custom name (encapsulated
4518       into apostrophes) for the mapping entry, useful for frontends for
4519       displaying an appropriate name for mapped instruments (using "GET
4520       MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4521    
4522       By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4523       completely established in the sampler.  The OPTIONAL "NON_MODAL"
4524       argument however causes the respective "MAP MIDI_INSTRUMENT" command
4525       to return immediately, that is to let the sampler establish the
4526       mapping in the background.  So this argument might be especially
4527       useful for mappings with a "PERSISTENT" type, because these have to
4528       load the respective instruments immediately and might thus block for
4529       a very long time.  It is recommended however to use the OPTIONAL
4530       "NON_MODAL" argument only if really necessary, because it has the
4531       following drawbacks: as "NON_MODAL" instructions return immediately,
4532    
4533    
4534    
4535    Schoenebeck               Expires March 4, 2008                [Page 81]
4536    
4537    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4538    
4539    
4540       they may not necessarily return an error i.e. when the given
4541       instrument file turns out to be corrupt, beside that subsequent
4542       commands in a LSCP instruction sequence might fail, because mandatory
4543       mappings are not yet completed.
4544    
4545       Possible Answers:
4546    
4547          "OK" -
4548    
4549             usually
4550    
4551          "ERR:<error-code>:<error-message>" -
4552    
4553             when the given map or engine does not exist or a value is out
4554             of range
4555    
4556       Examples:
4557    
4558          C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4559          0.8 PERSISTENT"
4560    
4561          S: "OK"
4562    
4563          C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
4564          1.0"
4565    
4566          S: "OK"
4567    
4568          C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0
4569          'Normal Piano'"
4570    
4571          S: "OK"
4572    
4573          C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4574          'Silent Piano'"
4575    
4576          S: "OK"
4577    
4578          C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4579          foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4580    
4581          S: "OK"
4582    
4583    6.7.8.  Getting ammount of MIDI instrument map entries
4584    
4585       The front-end can query the amount of currently existing entries in a
4586       MIDI instrument map by sending the following command:
4587    
4588    
4589    
4590    
4591    Schoenebeck               Expires March 4, 2008                [Page 82]
4592    
4593    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4594    
4595    
4596          GET MIDI_INSTRUMENTS <map>
4597    
4598       The front-end can query the amount of currently existing entries in
4599       all MIDI instrument maps by sending the following command:
4600    
4601          GET MIDI_INSTRUMENTS ALL
4602    
4603       Possible Answers:
4604    
4605          The sampler will answer by sending the current number of entries
4606          in the MIDI instrument map(s).
4607    
4608       Example:
4609    
4610          C: "GET MIDI_INSTRUMENTS 0"
4611    
4612          S: "234"
4613    
4614          C: "GET MIDI_INSTRUMENTS ALL"
4615    
4616          S: "954"
4617    
4618    6.7.9.  Getting indeces of all entries of a MIDI instrument map
4619    
4620       The front-end can query a list of all currently existing entries in a
4621       certain MIDI instrument map by sending the following command:
4622    
4623          LIST MIDI_INSTRUMENTS <map>
4624    
4625       Where <map> is the numeric ID of the MIDI instrument map.
4626    
4627       The front-end can query a list of all currently existing entries of
4628       all MIDI instrument maps by sending the following command:
4629    
4630          LIST MIDI_INSTRUMENTS ALL
4631    
4632       Possible Answers:
4633    
4634          The sampler will answer by sending a comma separated list of map
4635          ID - MIDI bank - MIDI program triples, where each triple is
4636          encapsulated into curly braces.  The list is returned in one
4637          single line.  Each triple just reflects the key of the respective
4638          map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4639          (Section 6.7.11) command(s) are necessary to retrieve detailed
4640          informations about each entry.
4641    
4642       Example:
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires March 4, 2008                [Page 83]
4648    
4649    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4650    
4651    
4652          C: "LIST MIDI_INSTRUMENTS 0"
4653    
4654          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4655    
4656    6.7.10.  Remove an entry from the MIDI instrument map
4657    
4658       The front-end can delete an entry from a MIDI instrument map by
4659       sending the following command:
4660    
4661          UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4662    
4663       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4664       is an integer value between 0..16383 reflecting the MIDI bank value
4665       and <midi_prog> an integer value between 0..127 reflecting the MIDI
4666       program value of the map's entrie's key index triple.
4667    
4668       Possible Answers:
4669    
4670          "OK" -
4671    
4672             usually
4673    
4674          "ERR:<error-code>:<error-message>" -
4675    
4676             when index out of bounds
4677    
4678       Example:
4679    
4680          C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4681    
4682          S: "OK"
4683    
4684    6.7.11.  Get current settings of MIDI instrument map entry
4685    
4686       The front-end can retrieve the current settings of a certain
4687       instrument map entry by sending the following command:
4688    
4689          GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
4690    
4691       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4692       is an integer value between 0..16383 reflecting the MIDI bank value,
4693       <midi_bank> and <midi_prog> an integer value between 0..127
4694       reflecting the MIDI program value of the map's entrie's key index
4695       triple.
4696    
4697       Possible Answers:
4698    
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires March 4, 2008                [Page 84]
4704    
4705    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4706    
4707    
4708          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4709          answer line begins with the information category name followed by
4710          a colon and then a space character <SP> and finally the info
4711          character string to that info category.  At the moment the
4712          following categories are defined:
4713    
4714          "NAME" -
4715    
4716             Name for this MIDI instrument map entry (if defined).  This
4717             name shall be used by frontends for displaying a name for this
4718             mapped instrument.  It can be set and changed with the "MAP
4719             MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4720             be unique.
4721    
4722          "ENGINE_NAME" -
4723    
4724             Name of the engine to be deployed for this instrument.
4725    
4726          "INSTRUMENT_FILE" -
4727    
4728             File name of the instrument.
4729    
4730          "INSTRUMENT_NR" -
4731    
4732             Index of the instrument within the file.
4733    
4734          "INSTRUMENT_NAME" -
4735    
4736             Name of the loaded instrument as reflected by its file.  In
4737             contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4738             cannot be changed.
4739    
4740          "LOAD_MODE" -
4741    
4742             Life time of instrument (see "MAP MIDI_INSTRUMENT"
4743             (Section 6.7.7) for details about this setting).
4744    
4745          "VOLUME" -
4746    
4747             master volume of the instrument as optionally dotted number
4748             (where a value < 1.0 means attenuation and a value > 1.0 means
4749             amplification)
4750    
4751          The mentioned fields above don't have to be in particular order.
4752    
4753       Example:
4754    
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires March 4, 2008                [Page 85]
4760    
4761    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4762    
4763    
4764          C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4765    
4766          S: "NAME: Drums for Foo Song"
4767    
4768             "ENGINE_NAME: GigEngine"
4769    
4770             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4771    
4772             "INSTRUMENT_NR: 0"
4773    
4774             "INSTRUMENT_NAME: Joe's Drumkit"
4775    
4776             "LOAD_MODE: PERSISTENT"
4777    
4778             "VOLUME: 1.0"
4779    
4780             "."
4781    
4782    6.7.12.  Clear MIDI instrument map
4783    
4784       The front-end can clear a whole MIDI instrument map, that is delete
4785       all its entries by sending the following command:
4786    
4787          CLEAR MIDI_INSTRUMENTS <map>
4788    
4789       Where <map> is the numeric ID of the map to clear.
4790    
4791       The front-end can clear all MIDI instrument maps, that is delete all
4792       entries of all maps by sending the following command:
4793    
4794          CLEAR MIDI_INSTRUMENTS ALL
4795    
4796       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4797       only their entries, thus the map's settings like custom name will be
4798       preservevd.
4799    
4800       Possible Answers:
4801    
4802          "OK" -
4803    
4804             always
4805    
4806       Examples:
4807    
4808          C: "CLEAR MIDI_INSTRUMENTS 0"
4809    
4810          S: "OK"
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires March 4, 2008                [Page 86]
4816    
4817    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4818    
4819    
4820          C: "CLEAR MIDI_INSTRUMENTS ALL"
4821    
4822          S: "OK"
4823    
4824    6.8.  Managing Instruments Database
4825    
4826       The following commands describe how to use and manage the instruments
4827       database.
4828    
4829       Notice:
4830    
4831          All command arguments representing a path or instrument/directory
4832          name support escape sequences as described in chapter "Character
4833          Set and Escape Sequences (Section 7.1)".
4834    
4835          All occurrences of a forward slash in instrument and directory
4836          names are escaped with its hex (\x2f) or octal (\057) escape
4837          sequence.
4838    
4839    6.8.1.  Creating a new instrument directory
4840    
4841       The front-end can add a new instrument directory to the instruments
4842       database by sending the following command:
4843    
4844          ADD DB_INSTRUMENT_DIRECTORY <dir>
4845    
4846       Where <dir> is the absolute path name of the directory to be created
4847       (encapsulated into apostrophes).
4848    
4849       Possible Answers:
4850    
4851          "OK" -
4852    
4853             on success
4854    
4855          "ERR:<error-code>:<error-message>" -
4856    
4857             when the directory could not be created, which can happen if
4858             the directory already exists or the name contains not allowed
4859             symbols
4860    
4861       Examples:
4862    
4863          C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
4864    
4865          S: "OK"
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires March 4, 2008                [Page 87]
4872    
4873    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4874    
4875    
4876    6.8.2.  Deleting an instrument directory
4877    
4878       The front-end can delete a particular instrument directory from the
4879       instruments database by sending the following command:
4880    
4881          REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4882    
4883       Where <dir> is the absolute path name of the directory to delete.
4884       The optional FORCE argument can be used to force the deletion of a
4885       non-empty directory and all its content.
4886    
4887       Possible Answers:
4888    
4889          "OK" -
4890    
4891             if the directory is deleted successfully
4892    
4893          "ERR:<error-code>:<error-message>" -
4894    
4895             if the given directory does not exist, or if trying to delete a
4896             non-empty directory, without using the FORCE argument.
4897    
4898       Examples:
4899    
4900          C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
4901    
4902          S: "OK"
4903    
4904    6.8.3.  Getting amount of instrument directories
4905    
4906       The front-end can retrieve the current amount of directories in a
4907       specific directory by sending the following command:
4908    
4909          GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4910    
4911       Where <dir> should be replaced by the absolute path name of the
4912       directory.  If RECURSIVE is specified, the number of all directories,
4913       including those located in subdirectories of the specified directory,
4914       will be returned.
4915    
4916       Possible Answers:
4917    
4918          The current number of instrument directories in the specified
4919          directory.
4920    
4921          "ERR:<error-code>:<error-message>" -
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires March 4, 2008                [Page 88]
4928    
4929    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4930    
4931    
4932             if the given directory does not exist.
4933    
4934       Example:
4935    
4936          C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4937    
4938          S: "2"
4939    
4940    6.8.4.  Listing all directories in specific directory
4941    
4942       The front-end can retrieve the current list of directories in
4943       specific directory by sending the following command:
4944    
4945          LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4946    
4947       Where <dir> should be replaced by the absolute path name of the
4948       directory.  If RECURSIVE is specified, the absolute path names of all
4949       directories, including those located in subdirectories of the
4950       specified directory, will be returned.
4951    
4952       Possible Answers:
4953    
4954          A comma separated list of all instrument directories (encapsulated
4955          into apostrophes) in the specified directory.
4956    
4957          "ERR:<error-code>:<error-message>" -
4958    
4959             if the given directory does not exist.
4960    
4961       Example:
4962    
4963          C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
4964    
4965          S: "'Piano Collection','Percussion Collection'"
4966    
4967          C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
4968    
4969          S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
4970          Collection/Acoustic/New','/Percussion Collection'"
4971    
4972    6.8.5.  Getting instrument directory information
4973    
4974       The front-end can ask for the current settings of an instrument
4975       directory by sending the following command:
4976    
4977          GET DB_INSTRUMENT_DIRECTORY INFO <dir>
4978    
4979       Where <dir> should be replaced by the absolute path name of the
4980    
4981    
4982    
4983    Schoenebeck               Expires March 4, 2008                [Page 89]
4984    
4985    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
4986    
4987    
4988       directory the front-end is interested in.
4989    
4990       Possible Answers:
4991    
4992          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4993          answer line begins with the settings category name followed by a
4994          colon and then a space character <SP> and finally the info
4995          character string to that setting category.  At the moment the
4996          following categories are defined:
4997    
4998    
4999    
5000             DESCRIPTION -
5001    
5002                A brief description of the directory content.  Note that the
5003                character string may contain escape sequences (Section 7.1).
5004    
5005             CREATED -
5006    
5007                The creation date and time of the directory, represented in
5008                "YYYY-MM-DD HH:MM:SS" format
5009    
5010             MODIFIED -
5011    
5012                The date and time of the last modification of the directory,
5013                represented in "YYYY-MM-DD HH:MM:SS" format
5014    
5015       The mentioned fields above don't have to be in particular order.
5016    
5017       Example:
5018    
5019          C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
5020    
5021          S: "DESCRIPTION: Piano collection of instruments in GigaSampler
5022          format."
5023    
5024             "CREATED: 2007-02-05 10:23:12"
5025    
5026             "MODIFIED: 2007-04-07 12:50:21"
5027    
5028             "."
5029    
5030    6.8.6.  Renaming an instrument directory
5031    
5032       The front-end can alter the name of a specific instrument directory
5033       by sending the following command:
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires March 4, 2008                [Page 90]
5040    
5041    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5042    
5043    
5044          SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5045    
5046       Where <dir> is the absolute path name of the directory and <name> is
5047       the new name for that directory.
5048    
5049       Possible Answers:
5050    
5051          "OK" -
5052    
5053             on success
5054    
5055          "ERR:<error-code>:<error-message>" -
5056    
5057             in case the given directory does not exists, or if a directory
5058             with name equal to the new name already exists.
5059    
5060       Example:
5061    
5062          C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5063          'Acoustic'"
5064    
5065          S: "OK"
5066    
5067    6.8.7.  Moving an instrument directory
5068    
5069       The front-end can move a specific instrument directory by sending the
5070       following command:
5071    
5072          MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5073    
5074       Where <dir> is the absolute path name of the directory to move and
5075       <dst> is the location where the directory will be moved to.
5076    
5077       Possible Answers:
5078    
5079          "OK" -
5080    
5081             on success
5082    
5083          "ERR:<error-code>:<error-message>" -
5084    
5085             in case a given directory does not exists, or if a directory
5086             with name equal to the name of the specified directory already
5087             exists in the destination directory.  Error is also thrown when
5088             trying to move a directory to a subdirectory of itself.
5089    
5090       Example:
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires March 4, 2008                [Page 91]
5096    
5097    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5098    
5099    
5100          C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5101          Acoustic'"
5102    
5103          S: "OK"
5104    
5105    6.8.8.  Copying instrument directories
5106    
5107       The front-end can copy a specific instrument directory by sending the
5108       following command:
5109    
5110          COPY DB_INSTRUMENT_DIRECTORY <dir> <dst>
5111    
5112       Where <dir> is the absolute path name of the directory to copy and
5113       <dst> is the location where the directory will be copied to.
5114    
5115       Possible Answers:
5116    
5117          "OK" -
5118    
5119             on success
5120    
5121          "ERR:<error-code>:<error-message>" -
5122    
5123             in case a given directory does not exists, or if a directory
5124             with name equal to the name of the specified directory already
5125             exists in the destination directory.  Error is also thrown when
5126             trying to copy a directory to a subdirectory of itself.
5127    
5128       Example:
5129    
5130          C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5131          '/Acoustic/Pianos'"
5132    
5133          S: "OK"
5134    
5135    6.8.9.  Changing the description of directory
5136    
5137       The front-end can alter the description of a specific instrument
5138       directory by sending the following command:
5139    
5140          SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5141    
5142       Where <dir> is the absolute path name of the directory and <desc> is
5143       the new description for the directory (encapsulated into apostrophes,
5144       supporting escape sequences as described in chapter "Character Set
5145       and Escape Sequences (Section 7.1)").
5146    
5147       Possible Answers:
5148    
5149    
5150    
5151    Schoenebeck               Expires March 4, 2008                [Page 92]
5152    
5153    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5154    
5155    
5156          "OK" -
5157    
5158             on success
5159    
5160          "ERR:<error-code>:<error-message>" -
5161    
5162             in case the given directory does not exists.
5163    
5164       Example:
5165    
5166          C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5167          collection of piano instruments in various format.'"
5168    
5169          S: "OK"
5170    
5171    6.8.10.  Finding directories
5172    
5173       The front-end can search for directories in specific directory by
5174       sending the following command:
5175    
5176          FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-
5177          list>
5178    
5179       Where <dir> should be replaced by the absolute path name of the
5180       directory to search in.  If NON_RECURSIVE is specified, the
5181       directories located in subdirectories of the specified directory will
5182       not be searched. <criteria-list> is a list of search criterias in
5183       form of "key1=val1 key2=val2 ...".  The following criterias are
5184       allowed:
5185    
5186       NAME='<search-string>'
5187    
5188          Restricts the search to directories, which names satisfy the
5189          supplied search string (encapsulated into apostrophes, supporting
5190          escape sequences as described in chapter "Character Set and Escape
5191          Sequences (Section 7.1)").
5192    
5193       CREATED='[<date-after>]..[<date-before>]'
5194    
5195          Restricts the search to directories, which creation date satisfies
5196          the specified period, where <date-after> and <date-before> are in
5197          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5198          search is restricted to directories created before <date-before>.
5199          If <date-before> is omitted, the search is restricted to
5200          directories created after <date-after>.
5201    
5202       MODIFIED='[<date-after>]..[<date-before>]'
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires March 4, 2008                [Page 93]
5208    
5209    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5210    
5211    
5212          Restricts the search to directories, which date of last
5213          modification satisfies the specified period, where <date-after>
5214          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5215          after> is omitted the search is restricted to directories, which
5216          are last modified before <date-before>.  If <date-before> is
5217          omitted, the search is restricted to directories, which are last
5218          modified after <date-after>.
5219    
5220       DESCRIPTION='<search-string>'
5221    
5222          Restricts the search to directories with description that
5223          satisfies the supplied search string (encapsulated into
5224          apostrophes, supporting escape sequences as described in chapter
5225          "Character Set and Escape Sequences (Section 7.1)").
5226    
5227       Where <search-string> is either a regular expression, or a word list
5228       separated with spaces for OR search and with '+' for AND search.
5229    
5230       Possible Answers:
5231    
5232          A comma separated list with the absolute path names (encapsulated
5233          into apostrophes) of all directories in the specified directory
5234          that satisfy the supplied search criterias.
5235    
5236          "ERR:<error-code>:<error-message>" -
5237    
5238             if the given directory does not exist.
5239    
5240       Example:
5241    
5242          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5243    
5244          S: "'/Piano Collection'"
5245    
5246          C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5247          30:13'"
5248    
5249          S: "'/Piano Collection','/Percussions'"
5250    
5251    6.8.11.  Adding instruments to the instruments database
5252    
5253       The front-end can add one or more instruments to the instruments
5254       database by sending the following command:
5255    
5256          ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>
5257          [<instr_index>]
5258    
5259       Where <db_dir> is the absolute path name of a directory (encapsulated
5260    
5261    
5262    
5263    Schoenebeck               Expires March 4, 2008                [Page 94]
5264    
5265    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5266    
5267    
5268       into apostrophes) in the instruments database in which only the new
5269       instruments (that are not already in the database) will be added,
5270       <file_path> is the absolute path name of a file or directory in the
5271       file system (encapsulated into apostrophes).  In case an instrument
5272       file is supplied, only the instruments in the specified file will be
5273       added to the instruments database.  If the optional <instr_index>
5274       (the index of the instrument within the given file) is supplied too,
5275       then only the specified instrument will be added.  In case a
5276       directory is supplied, the instruments in that directory will be
5277       added.  The OPTIONAL <mode> argument is only applied when a directory
5278       is provided as <file_path> and specifies how the scanning will be
5279       done and has exactly the following possibilities:
5280    
5281          "RECURSIVE" -
5282    
5283             All instruments will be processed, including those in the
5284             subdirectories, and the respective subdirectory tree structure
5285             will be recreated in the instruments database
5286    
5287          "NON_RECURSIVE" -
5288    
5289             Only the instruments in the specified directory will be added,
5290             the instruments in the subdirectories will not be processed.
5291    
5292          "FLAT" -
5293    
5294             All instruments will be processed, including those in the
5295             subdirectories, but the respective subdirectory structure will
5296             not be recreated in the instruments database.  All instruments
5297             will be added directly in the specified database directory.
5298    
5299       The difference between regular and NON_MODAL versions of the command
5300       is that the regular command returns when the scanning is finished
5301       while NON_MODAL version returns immediately and a background process
5302       is launched.  The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5303       command can be used to monitor the scanning progress.
5304    
5305       Possible Answers:
5306    
5307          "OK" -
5308    
5309             on success when NON_MODAL is not supplied
5310    
5311          "OK[<job-id>]" -
5312    
5313             on success when NON_MODAL is supplied, where <job-id> is a
5314             numerical ID used to obtain status information about the job
5315             progress.  See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5316    
5317    
5318    
5319    Schoenebeck               Expires March 4, 2008                [Page 95]
5320    
5321    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5322    
5323    
5324          "ERR:<error-code>:<error-message>" -
5325    
5326             if an invalid path is specified.
5327    
5328       Examples:
5329    
5330          C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5331          Bosendorfer 290.gig' 0"
5332    
5333          S: "OK"
5334    
5335    6.8.12.  Removing an instrument
5336    
5337       The front-end can remove a particular instrument from the instruments
5338       database by sending the following command:
5339    
5340          REMOVE DB_INSTRUMENT <instr_path>
5341    
5342       Where <instr_path> is the absolute path name (in the instruments
5343       database) of the instrument to remove.
5344    
5345       Possible Answers:
5346    
5347          "OK" -
5348    
5349             if the instrument is removed successfully
5350    
5351          "ERR:<error-code>:<error-message>" -
5352    
5353             if the given path does not exist or is a directory.
5354    
5355       Examples:
5356    
5357          C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
5358    
5359          S: "OK"
5360    
5361    6.8.13.  Getting amount of instruments
5362    
5363       The front-end can retrieve the current amount of instruments in a
5364       specific directory by sending the following command:
5365    
5366          GET DB_INSTRUMENTS [RECURSIVE] <dir>
5367    
5368       Where <dir> should be replaced by the absolute path name of the
5369       directory.  If RECURSIVE is specified, the number of all instruments,
5370       including those located in subdirectories of the specified directory,
5371       will be returned.
5372    
5373    
5374    
5375    Schoenebeck               Expires March 4, 2008                [Page 96]
5376    
5377    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5378    
5379    
5380       Possible Answers:
5381    
5382          The current number of instruments in the specified directory.
5383    
5384          "ERR:<error-code>:<error-message>" -
5385    
5386             if the given directory does not exist.
5387    
5388       Example:
5389    
5390          C: "GET DB_INSTRUMENTS '/Piano Collection'"
5391    
5392          S: "2"
5393    
5394    6.8.14.  Listing all instruments in specific directory
5395    
5396       The front-end can retrieve the current list of instruments in
5397       specific directory by sending the following command:
5398    
5399          LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5400    
5401       Where <dir> should be replaced by the absolute path name of the
5402       directory.  If RECURSIVE is specified, the absolute path names of all
5403       instruments, including those located in subdirectories of the
5404       specified directory, will be returned.
5405    
5406       Possible Answers:
5407    
5408          A comma separated list of all instruments (encapsulated into
5409          apostrophes) in the specified directory.
5410    
5411          "ERR:<error-code>:<error-message>" -
5412    
5413             if the given directory does not exist.
5414    
5415       Example:
5416    
5417          C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5418    
5419          S: "'Bosendorfer 290','Steinway D'"
5420    
5421          C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
5422    
5423          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5424          Steinway D','/Piano Collection/Lite/Free Piano'"
5425    
5426    
5427    
5428    
5429    
5430    
5431    Schoenebeck               Expires March 4, 2008                [Page 97]
5432    
5433    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5434    
5435    
5436    6.8.15.  Getting instrument information
5437    
5438       The front-end can ask for the current settings of an instrument by
5439       sending the following command:
5440    
5441          GET DB_INSTRUMENT INFO <instr_path>
5442    
5443       Where <instr_path> should be replaced by the absolute path name of
5444       the instrument the front-end is interested in.
5445    
5446       Possible Answers:
5447    
5448          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5449          answer line begins with the settings category name followed by a
5450          colon and then a space character <SP> and finally the info
5451          character string to that setting category.  At the moment the
5452          following categories are defined:
5453    
5454    
5455    
5456             INSTRUMENT_FILE -
5457    
5458                File name of the instrument.  Note that the character string
5459                may contain escape sequences (Section 7.1).
5460    
5461             INSTRUMENT_NR -
5462    
5463                Index of the instrument within the file.
5464    
5465             FORMAT_FAMILY -
5466    
5467                The format family of the instrument.
5468    
5469             FORMAT_VERSION -
5470    
5471                The format version of the instrument.
5472    
5473             SIZE -
5474    
5475                The size of the instrument in bytes.
5476    
5477             CREATED -
5478    
5479                The date and time when the instrument is added in the
5480                instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5481                format
5482    
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires March 4, 2008                [Page 98]
5488    
5489    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5490    
5491    
5492             MODIFIED -
5493    
5494                The date and time of the last modification of the
5495                instrument's database settings, represented in "YYYY-MM-DD
5496                HH:MM:SS" format
5497    
5498             DESCRIPTION -
5499    
5500                A brief description of the instrument.  Note that the
5501                character string may contain escape sequences (Section 7.1).
5502    
5503             IS_DRUM -
5504    
5505                either true or false, determines whether the instrument is a
5506                drumkit or a chromatic instrument
5507    
5508             PRODUCT -
5509    
5510                The product title of the instrument.  Note that the
5511                character string may contain escape sequences (Section 7.1).
5512    
5513             ARTISTS -
5514    
5515                Lists the artist names.  Note that the character string may
5516                contain escape sequences (Section 7.1).
5517    
5518             KEYWORDS -
5519    
5520                Provides a list of keywords that refer to the instrument.
5521                Keywords are separated with semicolon and blank.  Note that
5522                the character string may contain escape sequences
5523                (Section 7.1).
5524    
5525       The mentioned fields above don't have to be in particular order.
5526    
5527       Example:
5528    
5529          C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
5530    
5531          S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
5532    
5533             "INSTRUMENT_NR: 0"
5534    
5535             "FORMAT_FAMILY: GIG"
5536    
5537             "FORMAT_VERSION: 2"
5538    
5539    
5540    
5541    
5542    
5543    Schoenebeck               Expires March 4, 2008                [Page 99]
5544    
5545    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5546    
5547    
5548             "SIZE: 2050871870"
5549    
5550             "CREATED: 2007-02-05 10:23:12"
5551    
5552             "MODIFIED: 2007-04-07 12:50:21"
5553    
5554             "DESCRIPTION: "
5555    
5556             "IS_DRUM: false"
5557    
5558             "PRODUCT: GRANDIOSO Bosendorfer 290"
5559    
5560             "ARTISTS: Post Musical Instruments"
5561    
5562             "KEYWORDS: Bosendorfer"
5563    
5564             "."
5565    
5566    6.8.16.  Renaming an instrument
5567    
5568       The front-end can alter the name of a specific instrument by sending
5569       the following command:
5570    
5571          SET DB_INSTRUMENT NAME <instr> <name>
5572    
5573       Where <instr> is the absolute path name of the instrument and <name>
5574       is the new name for that instrument.
5575    
5576       Possible Answers:
5577    
5578          "OK" -
5579    
5580             on success
5581    
5582          "ERR:<error-code>:<error-message>" -
5583    
5584             in case the given instrument does not exists, or if an
5585             instrument with name equal to the new name already exists.
5586    
5587       Example:
5588    
5589          C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
5590          'Bosendorfer 290'"
5591    
5592          S: "OK"
5593    
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck               Expires March 4, 2008               [Page 100]
5600    
5601    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5602    
5603    
5604    6.8.17.  Moving an instrument
5605    
5606       The front-end can move a specific instrument to another directory by
5607       sending the following command:
5608    
5609          MOVE DB_INSTRUMENT <instr> <dst>
5610    
5611       Where <instr> is the absolute path name of the instrument to move and
5612       <dst> is the directory where the instrument will be moved to.
5613    
5614       Possible Answers:
5615    
5616          "OK" -
5617    
5618             on success
5619    
5620          "ERR:<error-code>:<error-message>" -
5621    
5622             in case the given instrument does not exists, or if an
5623             instrument with name equal to the name of the specified
5624             instrument already exists in the destination directory.
5625    
5626       Example:
5627    
5628          C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
5629          Collection/Acoustic'"
5630    
5631          S: "OK"
5632    
5633    6.8.18.  Copying instruments
5634    
5635       The front-end can copy a specific instrument to another directory by
5636       sending the following command:
5637    
5638          COPY DB_INSTRUMENT <instr> <dst>
5639    
5640       Where <instr> is the absolute path name of the instrument to copy and
5641       <dst> is the directory where the instrument will be copied to.
5642    
5643       Possible Answers:
5644    
5645          "OK" -
5646    
5647             on success
5648    
5649          "ERR:<error-code>:<error-message>" -
5650    
5651    
5652    
5653    
5654    
5655    Schoenebeck               Expires March 4, 2008               [Page 101]
5656    
5657    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5658    
5659    
5660             in case the given instrument does not exists, or if an
5661             instrument with name equal to the name of the specified
5662             instrument already exists in the destination directory.
5663    
5664       Example:
5665    
5666          C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
5667          '/Acoustic/Pianos/'"
5668    
5669          S: "OK"
5670    
5671    6.8.19.  Changing the description of instrument
5672    
5673       The front-end can alter the description of a specific instrument by
5674       sending the following command:
5675    
5676          SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5677    
5678       Where <instr> is the absolute path name of the instrument and <desc>
5679       is the new description for the instrument (encapsulated into
5680       apostrophes, supporting escape sequences as described in chapter
5681       "Character Set and Escape Sequences (Section 7.1)").
5682    
5683       Possible Answers:
5684    
5685          "OK" -
5686    
5687             on success
5688    
5689          "ERR:<error-code>:<error-message>" -
5690    
5691             in case the given instrument does not exists.
5692    
5693       Example:
5694    
5695          C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
5696          Bosendorfer 290' 'No comment :)'"
5697    
5698          S: "OK"
5699    
5700    6.8.20.  Finding instruments
5701    
5702       The front-end can search for instruments in specific directory by
5703       sending the following command:
5704    
5705          FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5706    
5707       Where <dir> should be replaced by the absolute path name of the
5708    
5709    
5710    
5711    Schoenebeck               Expires March 4, 2008               [Page 102]
5712    
5713    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5714    
5715    
5716       directory to search in.  If NON_RECURSIVE is specified, the
5717       directories located in subdirectories of the specified directory will
5718       not be searched. <criteria-list> is a list of search criterias in
5719       form of "key1=val1 key2=val2 ...".  The following criterias are
5720       allowed:
5721    
5722       NAME='<search-string>'
5723    
5724          Restricts the search to instruments, which names satisfy the
5725          supplied search string (encapsulated into apostrophes, supporting
5726          escape sequences as described in chapter "Character Set and Escape
5727          Sequences (Section 7.1)").
5728    
5729       SIZE=[<min>]..[<max>]
5730    
5731          Restricts the search to instruments, which size is in the
5732          specified range.  If <min> is omitted, the search results are
5733          restricted to instruments with size less then or equal to <max>.
5734          If <max> is omitted, the search is restricted to instruments with
5735          size greater then or equal to <min>.
5736    
5737       CREATED='[<date-after>]..[<date-before>]'
5738    
5739          Restricts the search to instruments, which creation date satisfies
5740          the specified period, where <date-after> and <date-before> are in
5741          "YYYY-MM-DD HH:MM:SS" format.  If <date-after> is omitted the
5742          search is restricted to instruments created before <date-before>.
5743          If <date-before> is omitted, the search is restricted to
5744          instruments created after <date-after>.
5745    
5746       MODIFIED='[<date-after>]..[<date-before>]'
5747    
5748          Restricts the search to instruments, which date of last
5749          modification satisfies the specified period, where <date-after>
5750          and <date-before> are in "YYYY-MM-DD HH:MM:SS" format.  If <date-
5751          after> is omitted the search is restricted to instruments, which
5752          are last modified before <date-before>.  If <date-before> is
5753          omitted, the search is restricted to instruments, which are last
5754          modified after <date-after>.
5755    
5756       DESCRIPTION='<search-string>'
5757    
5758          Restricts the search to instruments with description that
5759          satisfies the supplied search string (encapsulated into
5760          apostrophes, supporting escape sequences as described in chapter
5761          "Character Set and Escape Sequences (Section 7.1)").
5762    
5763       PRODUCT='<search-string>'
5764    
5765    
5766    
5767    Schoenebeck               Expires March 4, 2008               [Page 103]
5768    
5769    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5770    
5771    
5772          Restricts the search to instruments with product info that
5773          satisfies the supplied search string (encapsulated into
5774          apostrophes, supporting escape sequences as described in chapter
5775          "Character Set and Escape Sequences (Section 7.1)").
5776    
5777       ARTISTS='<search-string>'
5778    
5779          Restricts the search to instruments with artists info that
5780          satisfies the supplied search string (encapsulated into
5781          apostrophes, supporting escape sequences as described in chapter
5782          "Character Set and Escape Sequences (Section 7.1)").
5783    
5784       KEYWORDS='<search-string>'
5785    
5786          Restricts the search to instruments with keyword list that
5787          satisfies the supplied search string (encapsulated into
5788          apostrophes, supporting escape sequences as described in chapter
5789          "Character Set and Escape Sequences (Section 7.1)").
5790    
5791       IS_DRUM=true | false
5792    
5793          Either true or false.  Restricts the search to drum kits or
5794          chromatic instruments.
5795    
5796       FORMAT_FAMILIES='<format-list>'
5797    
5798          Restricts the search to instruments of the supplied format
5799          families, where <format-list> is a comma separated list of format
5800          families.
5801    
5802       Where <search-string> is either a regular expression, or a word list
5803       separated with spaces for OR search and with '+' for AND search.
5804    
5805       Possible Answers:
5806    
5807          A comma separated list with the absolute path names (encapsulated
5808          into apostrophes) of all instruments in the specified directory
5809          that satisfy the supplied search criterias.
5810    
5811          "ERR:<error-code>:<error-message>" -
5812    
5813             if the given directory does not exist.
5814    
5815       Example:
5816    
5817          C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5818          290'"
5819    
5820    
5821    
5822    
5823    Schoenebeck               Expires March 4, 2008               [Page 104]
5824    
5825    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5826    
5827    
5828          S: "'/Piano Collection/Bosendorfer 290'"
5829    
5830          C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
5831          09:30:13..'"
5832    
5833          S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5834          Steinway D'"
5835    
5836    6.8.21.  Getting job status information
5837    
5838       The front-end can ask for the current status of a particular database
5839       instruments job by sending the following command:
5840    
5841          GET DB_INSTRUMENTS_JOB INFO <job-id>
5842    
5843       Where <job-id> should be replaced by the numerical ID of the job the
5844       front-end is interested in.
5845    
5846       Possible Answers:
5847    
5848          LinuxSampler will answer by sending a <CRLF> separated list.  Each
5849          answer line begins with the settings category name followed by a
5850          colon and then a space character <SP> and finally the info
5851          character string to that setting category.  At the moment the
5852          following categories are defined:
5853    
5854    
5855    
5856             FILES_TOTAL -
5857    
5858  Schoenebeck             Expires November 2, 2005               [Page 63]              The total number of files scheduled for scanning
5859    
5860  Internet-Draft        LinuxSampler Control Protocol             May 2005           FILES_SCANNED -
5861    
5862                The current number of scanned files
5863    
5864             SCANNING -
5865    
5866                The absolute path name of the file which is currently being
5867                scanned
5868    
5869             STATUS -
5870    
5871                An integer value between 0 and 100 indicating the scanning
5872                progress percentage of the file which is currently being
5873                scanned
5874    
5875       The mentioned fields above don't have to be in particular order.
5876    
5877    
5878    
5879    Schoenebeck               Expires March 4, 2008               [Page 105]
5880    
5881    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5882    
5883    
5884       Example:
5885    
5886          C: "GET DB_INSTRUMENTS_JOB INFO 2"
5887    
5888          S: "FILES_TOTAL: 12"
5889    
5890             "FILES_SCANNED: 7"
5891    
5892             "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
5893    
5894             "STATUS: 42"
5895    
5896             "."
5897    
5898    6.8.22.  Formatting the instruments database
5899    
5900       The front-end can remove all instruments and directories and re-
5901       create the instruments database structure (e.g., in case of a
5902       database corruption) by sending the following command:
5903    
5904          FORMAT INSTRUMENTS_DB
5905    
5906       Possible Answers:
5907    
5908          "OK" -
5909    
5910             on success
5911    
5912          "ERR:<error-code>:<error-message>" -
5913    
5914             If the formatting of the instruments database failed.
5915    
5916    6.9.  Editing Instruments
5917    
5918       The sampler allows to edit instruments while playing with the sampler
5919       by spawning an external (3rd party) instrument editor application for
5920       a given instrument.  The 3rd party instrument editor applications
5921       have to place a respective plugin DLL file into the sampler's plugins
5922       directory.  The sampler will automatically try to load all plugin
5923       DLLs in that directory on startup and only on startup!
5924    
5925       At the moment there is only one command for this feature set, but
5926       this will most probably change in future.
5927    
5928    6.9.1.  Opening an appropriate instrument editor application
5929    
5930       The front-end can request to open an appropriate instrument editor
5931       application by sending the following command:
5932    
5933    
5934    
5935    Schoenebeck               Expires March 4, 2008               [Page 106]
5936    
5937    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5938    
5939    
5940          EDIT INSTRUMENT <sampler-channel>
5941    
5942       Where <sampler-channel> should be replaced by the number of the
5943       sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
5944       "LIST CHANNELS" (Section 6.4.4) command.
5945    
5946       The sampler will try to ask all registered instrument editors (or to
5947       be more specific: their sampler plugins) whether they are capable to
5948       handle the instrument on the given sampler channel.  The sampler will
5949       simply use the first instrument editor application which replied with
5950       a positive answer and spawn that instrument editor application within
5951       the sampler's process and provide that application access to the
5952       instrument's data structures, so both applications can share and
5953       access the same instruments data at the same time, thus allowing to
5954       immediately hear changes with the sampler made by the instrument
5955       editor.
5956    
5957       Note: consequently instrument editors are always spawned locally on
5958       the same machine where the sampler is running on!
5959    
5960       Possible Answers:
5961    
5962          "OK" -
5963    
5964             when an appropriate instrument editor was launched
5965    
5966          "WRN:<warning-code>:<warning-message>" -
5967    
5968             when an appropriate instrument editor was launched, but there
5969             are noteworthy issues
5970    
5971          "ERR:<error-code>:<error-message>" -
5972    
5973             when an appropriate instrument editor could not be launched
5974    
5975       Examples:
5976    
5977          C: "EDIT INSTRUMENT 0"
5978    
5979          S: "OK"
5980    
5981    
5982    
5983    
5984    
5985    
5986    
5987    
5988    
5989    
5990    
5991    Schoenebeck               Expires March 4, 2008               [Page 107]
5992    
5993    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
5994    
5995    
5996  7.  Command Syntax  7.  Command Syntax
# Line 3565  Internet-Draft        LinuxSampler Contr Line 6029  Internet-Draft        LinuxSampler Contr
6029    
6030     command =     command =
6031    
6032        ADD SP CHANNEL        ADD SP add_instruction
6033    
6034          / MAP SP map_instruction
6035    
6036          / UNMAP SP unmap_instruction
6037    
6038        / GET SP get_instruction        / GET SP get_instruction
6039    
# Line 3573  Internet-Draft        LinuxSampler Contr Line 6041  Internet-Draft        LinuxSampler Contr
6041    
6042        / DESTROY SP destroy_instruction        / DESTROY SP destroy_instruction
6043    
       / LIST SP list_instruction  
   
       / LOAD SP load_instruction  
6044    
6045    
6046    
6047    Schoenebeck               Expires March 4, 2008               [Page 108]
6048    
6049    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6050    
 Schoenebeck             Expires November 2, 2005               [Page 64]  
6051    
6052  Internet-Draft        LinuxSampler Control Protocol             May 2005        / LIST SP list_instruction
6053    
6054          / LOAD SP load_instruction
6055    
6056        / REMOVE SP CHANNEL SP sampler_channel        / REMOVE SP remove_instruction
6057    
6058        / SET SP set_instruction        / SET SP set_instruction
6059    
# Line 3593  Internet-Draft        LinuxSampler Contr Line 6061  Internet-Draft        LinuxSampler Contr
6061    
6062        / UNSUBSCRIBE SP unsubscribe_event        / UNSUBSCRIBE SP unsubscribe_event
6063    
6064        / SELECT SP text        / RESET SP reset_instruction
6065    
6066          / CLEAR SP clear_instruction
6067    
6068          / FIND SP find_instruction
6069    
6070        / RESET SP CHANNEL SP sampler_channel        / MOVE SP move_instruction
6071    
6072          / COPY SP copy_instruction
6073    
6074          / EDIT SP edit_instruction
6075    
6076          / FORMAT SP format_instruction
6077    
6078        / RESET        / RESET
6079    
6080        / QUIT        / QUIT
6081    
6082       add_instruction =
6083    
6084          CHANNEL
6085    
6086          / DB_INSTRUMENT_DIRECTORY SP db_path
6087    
6088          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6089    
6090          / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6091    
6092          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6093    
6094          / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6095          instrument_index
6096    
6097          / DB_INSTRUMENTS SP db_path SP filename
6098    
6099    
6100    
6101    
6102    
6103    Schoenebeck               Expires March 4, 2008               [Page 109]
6104    
6105    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6106    
6107    
6108          / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6109    
6110          / MIDI_INSTRUMENT_MAP
6111    
6112          / MIDI_INSTRUMENT_MAP SP map_name
6113    
6114     subscribe_event =     subscribe_event =
6115    
6116        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
6117    
6118          / AUDIO_OUTPUT_DEVICE_INFO
6119    
6120          / MIDI_INPUT_DEVICE_COUNT
6121    
6122          / MIDI_INPUT_DEVICE_INFO
6123    
6124          / CHANNEL_COUNT
6125    
6126        / VOICE_COUNT        / VOICE_COUNT
6127    
# Line 3613  Internet-Draft        LinuxSampler Contr Line 6131  Internet-Draft        LinuxSampler Contr
6131    
6132        / CHANNEL_INFO        / CHANNEL_INFO
6133    
6134          / FX_SEND_COUNT
6135    
6136          / FX_SEND_INFO
6137    
6138          / MIDI_INSTRUMENT_MAP_COUNT
6139    
6140          / MIDI_INSTRUMENT_MAP_INFO
6141    
6142          / MIDI_INSTRUMENT_COUNT
6143    
6144          / MIDI_INSTRUMENT_INFO
6145    
6146          / DB_INSTRUMENT_DIRECTORY_COUNT
6147    
6148          / DB_INSTRUMENT_DIRECTORY_INFO
6149    
6150          / DB_INSTRUMENT_COUNT
6151    
6152          / DB_INSTRUMENT_INFO
6153    
6154          / DB_INSTRUMENTS_JOB_INFO
6155    
6156    
6157    
6158    
6159    Schoenebeck               Expires March 4, 2008               [Page 110]
6160    
6161    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6162    
6163    
6164        / MISCELLANEOUS        / MISCELLANEOUS
6165    
6166          / TOTAL_VOICE_COUNT
6167    
6168          / GLOBAL_INFO
6169    
6170     unsubscribe_event =     unsubscribe_event =
6171    
6172        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
6173    
6174          / AUDIO_OUTPUT_DEVICE_INFO
6175    
6176          / MIDI_INPUT_DEVICE_COUNT
6177    
6178          / MIDI_INPUT_DEVICE_INFO
6179    
6180          / CHANNEL_COUNT
6181    
6182        / VOICE_COUNT        / VOICE_COUNT
6183    
# Line 3627  Internet-Draft        LinuxSampler Contr Line 6187  Internet-Draft        LinuxSampler Contr
6187    
6188        / CHANNEL_INFO        / CHANNEL_INFO
6189    
6190          / FX_SEND_COUNT
6191    
6192          / FX_SEND_INFO
6193    
6194          / MIDI_INSTRUMENT_MAP_COUNT
6195    
6196          / MIDI_INSTRUMENT_MAP_INFO
6197    
6198          / MIDI_INSTRUMENT_COUNT
6199    
6200          / MIDI_INSTRUMENT_INFO
6201    
6202          / DB_INSTRUMENT_DIRECTORY_COUNT
6203    
6204          / DB_INSTRUMENT_DIRECTORY_INFO
6205    
6206          / DB_INSTRUMENT_COUNT
6207    
6208          / DB_INSTRUMENT_INFO
6209    
6210          / DB_INSTRUMENTS_JOB_INFO
6211    
6212    
6213    
6214    
6215    Schoenebeck               Expires March 4, 2008               [Page 111]
6216    
6217    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6218    
6219    
6220        / MISCELLANEOUS        / MISCELLANEOUS
6221    
6222          / TOTAL_VOICE_COUNT
6223    
6224          / GLOBAL_INFO
6225    
6226       map_instruction =
6227    
6228          MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
6229          engine_name SP filename SP instrument_index SP volume_value
6230    
6231          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6232          SP engine_name SP filename SP instrument_index SP volume_value SP
6233          instr_load_mode
6234    
6235          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6236          SP engine_name SP filename SP instrument_index SP volume_value SP
6237          entry_name
6238    
6239          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6240          SP engine_name SP filename SP instrument_index SP volume_value SP
6241          instr_load_mode SP entry_name
6242    
6243       unmap_instruction =
6244    
6245          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
6246    
6247       remove_instruction =
6248    
6249          CHANNEL SP sampler_channel
6250    
6251          / MIDI_INSTRUMENT_MAP SP midi_map
6252    
6253          / MIDI_INSTRUMENT_MAP SP ALL
6254    
6255          / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6256    
6257          / DB_INSTRUMENT_DIRECTORY SP db_path
6258    
6259          / DB_INSTRUMENT SP db_path
6260    
6261     get_instruction =     get_instruction =
6262    
6263        AVAILABLE_ENGINES        AVAILABLE_ENGINES
6264    
6265          / AVAILABLE_MIDI_INPUT_DRIVERS
6266    
6267    
6268    
 Schoenebeck             Expires November 2, 2005               [Page 65]  
6269    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
6270    
6271    Schoenebeck               Expires March 4, 2008               [Page 112]
6272    
6273    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6274    
       / AVAILABLE_MIDI_INPUT_DRIVERS  
6275    
6276        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
6277    
# Line 3688  Internet-Draft        LinuxSampler Contr Line 6318  Internet-Draft        LinuxSampler Contr
6318    
6319        / ENGINE SP INFO SP engine_name        / ENGINE SP INFO SP engine_name
6320    
6321          / SERVER SP INFO
6322    
6323    
6324    
6325    
 Schoenebeck             Expires November 2, 2005               [Page 66]  
6326    
6327  Internet-Draft        LinuxSampler Control Protocol             May 2005  Schoenebeck               Expires March 4, 2008               [Page 113]
6328    
6329    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6330    
6331    
6332        / SERVER SP INFO        / TOTAL_VOICE_COUNT
6333    
6334          / TOTAL_VOICE_COUNT_MAX
6335    
6336          / MIDI_INSTRUMENTS SP midi_map
6337    
6338          / MIDI_INSTRUMENTS SP ALL
6339    
6340          / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
6341    
6342          / MIDI_INSTRUMENT_MAPS
6343    
6344          / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6345    
6346          / FX_SENDS SP sampler_channel
6347    
6348          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6349    
6350          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6351    
6352          / DB_INSTRUMENT_DIRECTORIES SP db_path
6353    
6354          / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6355    
6356          / DB_INSTRUMENTS SP RECURSIVE SP db_path
6357    
6358          / DB_INSTRUMENTS SP db_path
6359    
6360          / DB_INSTRUMENT SP INFO SP db_path
6361    
6362          / DB_INSTRUMENTS_JOB SP INFO SP number
6363    
6364          / VOLUME
6365    
6366     set_instruction =     set_instruction =
6367    
# Line 3710  Internet-Draft        LinuxSampler Contr Line 6374  Internet-Draft        LinuxSampler Contr
6374        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='        / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6375        param_val_list        param_val_list
6376    
6377          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6378    
6379    
6380    
6381    
6382    
6383    Schoenebeck               Expires March 4, 2008               [Page 114]
6384    
6385    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6386    
6387    
6388        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='        / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6389        param_val_list        param_val_list
6390    
6391        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
6392    
6393          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6394    
6395          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6396    
6397          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
6398          SP audio_channel_index SP audio_channel_index
6399    
6400          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
6401          midi_ctrl
6402    
6403          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6404          volume_value
6405    
6406          / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6407    
6408          / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6409          stringval_escaped
6410    
6411          / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6412    
6413          / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6414    
6415        / ECHO SP boolean        / ECHO SP boolean
6416    
6417          / VOLUME SP volume_value
6418    
6419     create_instruction =     create_instruction =
6420    
6421        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 3727  Internet-Draft        LinuxSampler Contr Line 6426  Internet-Draft        LinuxSampler Contr
6426    
6427        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
6428    
6429          / FX_SEND SP sampler_channel SP midi_ctrl
6430    
6431          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6432    
6433       reset_instruction =
6434    
6435    
6436    
6437    
6438    
6439    Schoenebeck               Expires March 4, 2008               [Page 115]
6440    
6441    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6442    
6443    
6444          CHANNEL SP sampler_channel
6445    
6446       clear_instruction =
6447    
6448          MIDI_INSTRUMENTS SP midi_map
6449    
6450          / MIDI_INSTRUMENTS SP ALL
6451    
6452       find_instruction =
6453    
6454          DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6455    
6456          / DB_INSTRUMENTS SP db_path SP query_val_list
6457    
6458          / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
6459          query_val_list
6460    
6461          / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6462    
6463       move_instruction =
6464    
6465          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6466    
6467          / DB_INSTRUMENT SP db_path SP db_path
6468    
6469       copy_instruction =
6470    
6471          DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6472    
6473          / DB_INSTRUMENT SP db_path SP db_path
6474    
6475     destroy_instruction =     destroy_instruction =
6476    
6477        AUDIO_OUTPUT_DEVICE SP number        AUDIO_OUTPUT_DEVICE SP number
6478    
6479        / MIDI_INPUT_DEVICE SP number        / MIDI_INPUT_DEVICE SP number
6480    
6481          / FX_SEND SP sampler_channel SP fx_send_id
6482    
6483     load_instruction =     load_instruction =
6484    
6485        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
# Line 3741  Internet-Draft        LinuxSampler Contr Line 6488  Internet-Draft        LinuxSampler Contr
6488    
6489     set_chan_instruction =     set_chan_instruction =
6490    
       AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index  
6491    
       / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index  
       SP audio_channel_index  
6492    
6493    
6494    
6495  Schoenebeck             Expires November 2, 2005               [Page 67]  Schoenebeck               Expires March 4, 2008               [Page 116]
6496    
6497    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6498    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
6499    
6500          AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6501    
6502          / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
6503          SP audio_channel_index
6504    
6505        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6506    
# Line 3773  Internet-Draft        LinuxSampler Contr Line 6522  Internet-Draft        LinuxSampler Contr
6522    
6523        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
6524    
6525          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6526    
6527          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6528    
6529          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6530    
6531       edit_instruction =
6532    
6533          INSTRUMENT SP sampler_channel
6534    
6535       format_instruction =
6536    
6537          INSTRUMENTS_DB
6538    
6539       modal_arg =
6540    
6541          /* epsilon (empty argument) */
6542    
6543          / NON_MODAL SP
6544    
6545     key_val_list =     key_val_list =
6546    
6547    
6548    
6549    
6550    
6551    Schoenebeck               Expires March 4, 2008               [Page 117]
6552    
6553    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6554    
6555    
6556        string '=' param_val_list        string '=' param_val_list
6557    
6558        / key_val_list SP string '=' param_val_list        / key_val_list SP string '=' param_val_list
# Line 3799  Internet-Draft        LinuxSampler Contr Line 6577  Internet-Draft        LinuxSampler Contr
6577    
6578        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
6579    
6580     load_instr_args =        / MIDI_INSTRUMENTS SP midi_map
6581    
6582          / MIDI_INSTRUMENTS SP ALL
6583    
6584          / MIDI_INSTRUMENT_MAPS
6585    
6586          / FX_SENDS SP sampler_channel
6587    
6588          / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6589    
6590  Schoenebeck             Expires November 2, 2005               [Page 68]        / DB_INSTRUMENT_DIRECTORIES SP db_path
6591    
6592  Internet-Draft        LinuxSampler Control Protocol             May 2005        / DB_INSTRUMENTS SP RECURSIVE SP db_path
6593    
6594          / DB_INSTRUMENTS SP db_path
6595    
6596       load_instr_args =
6597    
6598        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
6599    
# Line 3815  Internet-Draft        LinuxSampler Contr Line 6601  Internet-Draft        LinuxSampler Contr
6601    
6602     load_engine_args =     load_engine_args =
6603    
6604    
6605    
6606    
6607    Schoenebeck               Expires March 4, 2008               [Page 118]
6608    
6609    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6610    
6611    
6612        engine_name SP sampler_channel        engine_name SP sampler_channel
6613    
6614       instr_load_mode =
6615    
6616          ON_DEMAND
6617    
6618          / ON_DEMAND_HOLD
6619    
6620          / PERSISTENT
6621    
6622     device_index =     device_index =
6623    
6624        number        number
# Line 3843  Internet-Draft        LinuxSampler Contr Line 6645  Internet-Draft        LinuxSampler Contr
6645    
6646        string        string
6647    
6648       midi_map =
6649    
6650          number
6651    
6652       midi_bank =
6653    
6654          number
6655    
6656       midi_prog =
6657    
6658          number
6659    
6660    
6661    
6662    
6663    Schoenebeck               Expires March 4, 2008               [Page 119]
6664    
6665    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6666    
6667    
6668       midi_ctrl =
6669    
6670          number
6671    
6672     volume_value =     volume_value =
6673    
6674        dotnum        dotnum
# Line 3857  Internet-Draft        LinuxSampler Contr Line 6683  Internet-Draft        LinuxSampler Contr
6683    
6684        number        number
6685    
6686       fx_send_id =
6687    
6688          number
6689    
6690       engine_name =
6691    
6692          string
6693    
6694       filename =
6695    
6696  Schoenebeck             Expires November 2, 2005               [Page 69]        path
6697    
6698  Internet-Draft        LinuxSampler Control Protocol             May 2005     db_path =
6699    
6700          path
6701    
6702     engine_name =     map_name =
6703    
6704        string        stringval
6705    
6706     filename =     entry_name =
6707    
6708          stringval
6709    
6710       fx_send_name =
6711    
6712        stringval        stringval
6713    
6714     param_val_list =     param_val_list =
6715    
6716    
6717    
6718    
6719    Schoenebeck               Expires March 4, 2008               [Page 120]
6720    
6721    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6722    
6723    
6724        param_val        param_val
6725    
6726        / param_val_list','param_val        / param_val_list','param_val
# Line 3883  Internet-Draft        LinuxSampler Contr Line 6729  Internet-Draft        LinuxSampler Contr
6729    
6730        string        string
6731    
6732        / '\'' string '\''        / stringval
   
       / '\"' string '\"'  
6733    
6734        / number        / number
6735    
6736        / dotnum        / dotnum
6737    
6738       query_val_list =
6739    
6740          string '=' query_val
6741    
6742          / query_val_list SP string '=' query_val
6743    
6744       query_val =
6745    
6746          textval_escaped
6747    
6748          / stringval_escaped
6749    
6750       scan_mode =
6751    
6752          RECURSIVE
6753    
6754          / NON_RECURSIVE
6755    
6756          / FLAT
6757    
6758    7.1.  Character Set and Escape Sequences
6759    
6760       Older versions of this protocol up to and including v1.1 only
6761       supported the standard ASCII character set (ASCII code 0 - 127)
6762       [RFC20], all younger versions of this protocol however support the
6763       Extended ASCII character set (ASCII code 0 - 255).  The same group of
6764       younger protocols also support escape sequences, but only for
6765       certain, explicitly declared parts of the protocol.  The supported
6766       escape sequences are defined as follows:
6767    
6768    
6769    
# Line 3910  Internet-Draft        LinuxSampler Contr Line 6772  Internet-Draft        LinuxSampler Contr
6772    
6773    
6774    
6775    Schoenebeck               Expires March 4, 2008               [Page 121]
6776    
6777    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6778    
6779    
6780       +------------------------+------------------------------------------+
6781       | ASCII Character        | Translated into (Name)                   |
6782       | Sequence               |                                          |
6783       +------------------------+------------------------------------------+
6784       | \n                     | new line                                 |
6785       |                        |                                          |
6786       | \r                     | carriage return                          |
6787       |                        |                                          |
6788       | \f                     | form feed                                |
6789       |                        |                                          |
6790       | \t                     | horizontal tab                           |
6791       |                        |                                          |
6792       | \v                     | vertical tab                             |
6793       |                        |                                          |
6794       | \'                     | apostrophe                               |
6795       |                        |                                          |
6796       | \"                     | quotation mark                           |
6797       |                        |                                          |
6798       | \\                     | backslash                                |
6799       |                        |                                          |
6800       | \OOO                   | three digit octal ASCII code of the      |
6801       |                        | character                                |
6802       |                        |                                          |
6803       | \xHH                   | two digit hex ASCII code of the          |
6804       |                        | character                                |
6805       +------------------------+------------------------------------------+
6806    
6807       Notice: due to the transition of certain parts of the protocol which
6808       now support escape sequences, a slight backward incompatibility to
6809       protocols version v1.1 and younger has been introduced.  The only
6810       difference is that in parts of the protocol where escape characters
6811       are now supported, a backslash characters MUST be escaped as well
6812       (that is as double backslash), whereas in the old versions a single
6813       backslash was sufficient.
6814    
6815    
6816    
 Schoenebeck             Expires November 2, 2005               [Page 70]  
6817    
6818  Internet-Draft        LinuxSampler Control Protocol             May 2005  
6819    
6820    
6821    
6822    
6823    
6824    
6825    
6826    
6827    
6828    
6829    
6830    
6831    Schoenebeck               Expires March 4, 2008               [Page 122]
6832    
6833    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6834    
6835    
6836  8.  Events  8.  Events
# Line 3926  Internet-Draft        LinuxSampler Contr Line 6838  Internet-Draft        LinuxSampler Contr
6838     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
6839     LinuxSampler.     LinuxSampler.
6840    
6841  8.1  Number of sampler channels changed  8.1.  Number of audio output devices changed
6842    
6843       Client may want to be notified when the total number of audio output
6844       devices on the back-end changes by issuing the following command:
6845    
6846          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
6847    
6848       Server will start sending the following notification messages:
6849    
6850          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
6851    
6852       where <devices> will be replaced by the new number of audio output
6853       devices.
6854    
6855    8.2.  Audio output device's settings changed
6856    
6857       Client may want to be notified when changes were made to audio output
6858       devices on the back-end by issuing the following command:
6859    
6860          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
6861    
6862       Server will start sending the following notification messages:
6863    
6864          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
6865    
6866       where <device-id> will be replaced by the numerical ID of the audio
6867       output device, which settings has been changed.  The front-end will
6868       have to send the respective command to actually get the audio output
6869       device info.  Because these messages will be triggered by LSCP
6870       commands issued by other clients rather than real time events
6871       happening on the server, it is believed that an empty notification
6872       message is sufficient here.
6873    
6874    8.3.  Number of MIDI input devices changed
6875    
6876       Client may want to be notified when the total number of MIDI input
6877       devices on the back-end changes by issuing the following command:
6878    
6879          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
6880    
6881       Server will start sending the following notification messages:
6882    
6883    
6884    
6885    
6886    
6887    Schoenebeck               Expires March 4, 2008               [Page 123]
6888    
6889    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6890    
6891    
6892          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
6893    
6894       where <devices> will be replaced by the new number of MIDI input
6895       devices.
6896    
6897    8.4.  MIDI input device's settings changed
6898    
6899       Client may want to be notified when changes were made to MIDI input
6900       devices on the back-end by issuing the following command:
6901    
6902          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
6903    
6904       Server will start sending the following notification messages:
6905    
6906          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
6907    
6908       where <device-id> will be replaced by the numerical ID of the MIDI
6909       input device, which settings has been changed.  The front-end will
6910       have to send the respective command to actually get the MIDI input
6911       device info.  Because these messages will be triggered by LSCP
6912       commands issued by other clients rather than real time events
6913       happening on the server, it is believed that an empty notification
6914       message is sufficient here.
6915    
6916    8.5.  Number of sampler channels changed
6917    
6918     Client may want to be notified when the total number of channels on     Client may want to be notified when the total number of channels on
6919     the back-end changes by issuing the following command:     the back-end changes by issuing the following command:
# Line 3940  Internet-Draft        LinuxSampler Contr Line 6927  Internet-Draft        LinuxSampler Contr
6927     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
6928     channels.     channels.
6929    
6930  8.2  Number of active voices changed  8.6.  Number of active voices changed
6931    
6932     Client may want to be notified when the number of voices on the back-     Client may want to be notified when the number of voices on the back-
6933     end changes by issuing the following command:     end changes by issuing the following command:
# Line 3949  Internet-Draft        LinuxSampler Contr Line 6936  Internet-Draft        LinuxSampler Contr
6936    
6937     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6938    
6939        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>  
6940    
6941    
6942    
6943    Schoenebeck               Expires March 4, 2008               [Page 124]
6944    
6945    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
6946    
6947    
6948          "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
6949    
6950     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6951     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
6952     voices on that channel.     voices on that channel.
6953    
6954  8.3  Number of active disk streams changed  8.7.  Number of active disk streams changed
6955    
6956     Client may want to be notified when the number of streams on the     Client may want to be notified when the number of streams on the
6957     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 3969  Internet-Draft        LinuxSampler Contr Line 6965  Internet-Draft        LinuxSampler Contr
6965    
6966     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
6967     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck             Expires November 2, 2005               [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
   
   
6968     active disk streams on that channel.     active disk streams on that channel.
6969    
6970  8.4  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
6971    
6972     Client may want to be notified when the buffer fill state of a disk     Client may want to be notified when the buffer fill state of a disk
6973     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 3996  Internet-Draft        LinuxSampler Contr Line 6984  Internet-Draft        LinuxSampler Contr
6984     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
6985     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
6986    
6987  8.5  Channel information changed  8.9.  Channel information changed
6988    
6989     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
6990     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
# Line 4005  Internet-Draft        LinuxSampler Contr Line 6993  Internet-Draft        LinuxSampler Contr
6993    
6994     Server will start sending the following notification messages:     Server will start sending the following notification messages:
6995    
6996    
6997    
6998    
6999    Schoenebeck               Expires March 4, 2008               [Page 125]
7000    
7001    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7002    
7003    
7004        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
7005    
7006     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
# Line 4014  Internet-Draft        LinuxSampler Contr Line 7010  Internet-Draft        LinuxSampler Contr
7010     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
7011     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
7012    
7013  8.6  Miscellaneous and debugging events  8.10.  Number of effect sends changed
7014    
7015     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified when the number of effect sends on a
7016     occurring at the server by issuing the following command:     particular sampler channel is changed by issuing the following
7017       command:
7018    
7019        SUBSCRIBE MISCELLANEOUS        SUBSCRIBE FX_SEND_COUNT
7020    
7021     Server will start sending the following notification messages:     Server will start sending the following notification messages:
7022    
7023          "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
7024    
7025       where <channel-id> will be replaced by the numerical ID of the
7026       sampler channel, on which the effect sends number is changed and <fx-
7027       sends> will be replaced by the new number of effect sends on that
7028       channel.
7029    
7030    8.11.  Effect send information changed
7031    
7032       Client may want to be notified when changes were made to effect sends
7033       on a a particular sampler channel by issuing the following command:
7034    
7035          SUBSCRIBE FX_SEND_INFO
7036    
7037  Schoenebeck             Expires November 2, 2005               [Page 72]     Server will start sending the following notification messages:
7038    
7039  Internet-Draft        LinuxSampler Control Protocol             May 2005        "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
7040    
7041       where <channel-id> will be replaced by the numerical ID of the
7042       sampler channel, on which an effect send entity is changed and <fx-
7043       send-id> will be replaced by the numerical ID of the changed effect
7044       send.
7045    
7046        "NOTIFY:MISCELLANEOUS:<string>"  8.12.  Total number of active voices changed
7047    
7048     where <string> will be replaced by whatever data server wants to send     Client may want to be notified when the total number of voices on the
7049     to the client.  Client MAY display this data to the user AS IS to     back-end changes by issuing the following command:
7050     facilitate debugging.  
7051    
7052    
7053    
7054    
7055    Schoenebeck               Expires March 4, 2008               [Page 126]
7056    
7057    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7058    
7059    
7060          SUBSCRIBE TOTAL_VOICE_COUNT
7061    
7062       Server will start sending the following notification messages:
7063    
7064          "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
7065    
7066       where <voices> will be replaced by the new number of all currently
7067       active voices.
7068    
7069    8.13.  Number of MIDI instrument maps changed
7070    
7071       Client may want to be notified when the number of MIDI instrument
7072       maps on the back-end changes by issuing the following command:
7073    
7074          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
7075    
7076       Server will start sending the following notification messages:
7077    
7078          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
7079    
7080       where <maps> will be replaced by the new number of MIDI instrument
7081       maps.
7082    
7083    8.14.  MIDI instrument map information changed
7084    
7085       Client may want to be notified when changes were made to MIDI
7086       instrument maps on the back-end by issuing the following command:
7087    
7088          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
7089    
7090       Server will start sending the following notification messages:
7091    
7092          "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
7093    
7094       where <map-id> will be replaced by the numerical ID of the MIDI
7095       instrument map, for which information changes occurred.  The front-
7096       end will have to send the respective command to actually get the MIDI
7097       instrument map info.  Because these messages will be triggered by
7098       LSCP commands issued by other clients rather than real time events
7099       happening on the server, it is believed that an empty notification
7100       message is sufficient here.
7101    
7102    8.15.  Number of MIDI instruments changed
7103    
7104       Client may want to be notified when the number of MIDI instrument
7105       maps on the back-end changes by issuing the following command:
7106    
7107    
7108    
7109    
7110    
7111    Schoenebeck               Expires March 4, 2008               [Page 127]
7112    
7113    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7114    
7115    
7116          SUBSCRIBE MIDI_INSTRUMENT_COUNT
7117    
7118       Server will start sending the following notification messages:
7119    
7120          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
7121    
7122       where <map-id> is the numerical ID of the MIDI instrument map, in
7123       which the nuber of instruments has changed and <instruments> will be
7124       replaced by the new number of MIDI instruments in the specified map.
7125    
7126    8.16.  MIDI instrument information changed
7127    
7128       Client may want to be notified when changes were made to MIDI
7129       instruments on the back-end by issuing the following command:
7130    
7131          SUBSCRIBE MIDI_INSTRUMENT_INFO
7132    
7133       Server will start sending the following notification messages:
7134    
7135          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
7136    
7137       where <map-id> will be replaced by the numerical ID of the MIDI
7138       instrument map, in which a MIDI instrument is changed. <bank> and
7139       <program> specifies the location of the changed MIDI instrument in
7140       the map.  The front-end will have to send the respective command to
7141       actually get the MIDI instrument info.  Because these messages will
7142       be triggered by LSCP commands issued by other clients rather than
7143       real time events happening on the server, it is believed that an
7144       empty notification message is sufficient here.
7145    
7146    8.17.  Global settings changed
7147    
7148       Client may want to be notified when changes to the global settings of
7149       the sampler were made by issuing the following command:
7150    
7151          SUBSCRIBE GLOBAL_INFO
7152    
7153       Server will start sending the following types of notification
7154       messages:
7155    
7156          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
7157          volume of the sampler is changed, where <volume> will be replaced
7158          by the optional dotted floating point value, reflecting the new
7159          global volume parameter.
7160    
7161    
7162    
# Line 4047  Internet-Draft        LinuxSampler Contr Line 7164  Internet-Draft        LinuxSampler Contr
7164    
7165    
7166    
7167    Schoenebeck               Expires March 4, 2008               [Page 128]
7168    
7169    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7170    
7171    
7172    8.18.  Number of database instrument directories changed
7173    
7174       Client may want to be notified when the number of instrument
7175       directories in a particular directory in the instruments database is
7176       changed by issuing the following command:
7177    
7178          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
7179    
7180       Server will start sending the following notification messages:
7181    
7182          "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
7183    
7184       where <dir-path> will be replaced by the absolute path name of the
7185       directory in the instruments database, in which the number of
7186       directories is changed.
7187    
7188       Note that when a non-empty directory is removed, this event is not
7189       sent for the subdirectories in that directory.
7190    
7191    8.19.  Database instrument directory information changed
7192    
7193       Client may want to be notified when changes were made to directories
7194       in the instruments database by issuing the following command:
7195    
7196          SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
7197    
7198       Server will start sending the following notification messages:
7199    
7200          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
7201    
7202       where <dir-path> will be replaced by the absolute path name of the
7203       directory, for which information changes occurred.  The front-end
7204       will have to send the respective command to actually get the updated
7205       directory info.  Because these messages will be triggered by LSCP
7206       commands issued by other clients rather than real time events
7207       happening on the server, it is believed that an empty notification
7208       message is sufficient here.
7209    
7210          "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
7211          name>"
7212    
7213       where <old-dir-path> is the old absolute path name of the directory
7214       (encapsulated into apostrophes), which name is changes and <new-name>
7215       is the new name of the directory, encapsulated into apostrophes.
7216    
7217    
7218    
7219    
7220    
7221    
7222    
7223    Schoenebeck               Expires March 4, 2008               [Page 129]
7224    
7225    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7226    
7227    
7228    8.20.  Number of database instruments changed
7229    
7230       Client may want to be notified when the number of instruments in a
7231       particular directory in the instruments database is changed by
7232       issuing the following command:
7233    
7234          SUBSCRIBE DB_INSTRUMENT_COUNT
7235    
7236       Server will start sending the following notification messages:
7237    
7238          "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
7239    
7240       where <dir-path> will be replaced by the absolute path name of the
7241       directory in the instruments database, in which the number of
7242       instruments is changed.
7243    
7244       Note that when a non-empty directory is removed, this event is not
7245       sent for the instruments in that directory.
7246    
7247    8.21.  Database instrument information changed
7248    
7249       Client may want to be notified when changes were made to instruments
7250       in the instruments database by issuing the following command:
7251    
7252          SUBSCRIBE DB_INSTRUMENT_INFO
7253    
7254       Server will start sending the following notification messages:
7255    
7256          "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
7257    
7258       where <instr-path> will be replaced by the absolute path name of the
7259       instrument, which settings are changed.  The front-end will have to
7260       send the respective command to actually get the updated directory
7261       info.  Because these messages will be triggered by LSCP commands
7262       issued by other clients rather than real time events happening on the
7263       server, it is believed that an empty notification message is
7264       sufficient here.
7265    
7266          "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
7267    
7268       where <old-instr-path> is the old absolute path name of the
7269       instrument (encapsulated into apostrophes), which name is changes and
7270       <new-name> is the new name of the instrument, encapsulated into
7271       apostrophes.
7272    
7273    
7274    
# Line 4062  Internet-Draft        LinuxSampler Contr Line 7276  Internet-Draft        LinuxSampler Contr
7276    
7277    
7278    
7279    Schoenebeck               Expires March 4, 2008               [Page 130]
7280    
7281    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7282    
7283    
7284    8.22.  Database job status information changed
7285    
7286       Client may want to be notified when the status of particular database
7287       instruments job is changed by issuing the following command:
7288    
7289          SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
7290    
7291       Server will start sending the following notification messages:
7292    
7293          "NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"
7294    
7295       where <job-id> will be replaced by the numerical ID of the job, which
7296       status is changed.  The front-end will have to send the respective
7297       command to actually get the status info.  Because these messages will
7298       be triggered by LSCP commands issued by other clients rather than
7299       real time events happening on the server, it is believed that an
7300       empty notification message is sufficient here.
7301    
7302    8.23.  Miscellaneous and debugging events
7303    
7304       Client may want to be notified of miscellaneous and debugging events
7305       occurring at the server by issuing the following command:
7306    
7307          SUBSCRIBE MISCELLANEOUS
7308    
7309       Server will start sending the following notification messages:
7310    
7311          "NOTIFY:MISCELLANEOUS:<string>"
7312    
7313       where <string> will be replaced by whatever data server wants to send
7314       to the client.  Client MAY display this data to the user AS IS to
7315       facilitate debugging.
7316    
7317    
7318    
# Line 4084  Internet-Draft        LinuxSampler Contr Line 7331  Internet-Draft        LinuxSampler Contr
7331    
7332    
7333    
 Schoenebeck             Expires November 2, 2005               [Page 73]  
7334    
7335  Internet-Draft        LinuxSampler Control Protocol             May 2005  Schoenebeck               Expires March 4, 2008               [Page 131]
7336    
7337    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7338    
7339    
7340  9.  Security Considerations  9.  Security Considerations
# Line 4140  Internet-Draft        LinuxSampler Contr Line 7388  Internet-Draft        LinuxSampler Contr
7388    
7389    
7390    
7391  Schoenebeck             Expires November 2, 2005               [Page 74]  Schoenebeck               Expires March 4, 2008               [Page 132]
7392    
7393  Internet-Draft        LinuxSampler Control Protocol             May 2005  Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7394    
7395    
7396  10.  Acknowledgments  10.  Acknowledgments
# Line 4160  Internet-Draft        LinuxSampler Contr Line 7408  Internet-Draft        LinuxSampler Contr
7408        Grigor Iliev        Grigor Iliev
7409    
7410    
7411    
7412    
7413    
7414    
7415    
7416    
7417    
7418    
7419    
7420    
7421    
7422    
7423    
7424    
7425    
7426    
7427    
7428    
7429    
7430    
7431    
7432    
7433    
7434    
7435    
7436    
7437    
7438    
7439    
7440    
7441    
7442    
7443    
7444    
7445    
7446    
7447    Schoenebeck               Expires March 4, 2008               [Page 133]
7448    
7449    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7450    
7451    
7452  11.  References  11.  References
7453    
7454       [RFC20]    UCLA, "ASCII format for Network Interchange", RFC 20,
7455                  1969.
7456    
7457     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
7458                Requirement Levels", RFC 2119, 1997.                Requirement Levels", RFC 2119, 1997.
7459    
# Line 4172  Internet-Draft        LinuxSampler Contr Line 7464  Internet-Draft        LinuxSampler Contr
7464                CONTROL PROTOCOL", RFC 793, 1981.                CONTROL PROTOCOL", RFC 793, 1981.
7465    
7466    
 Author's Address  
7467    
    C. Schoenebeck  
    Interessengemeinschaft Software Engineering e. V.  
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
7468    
    Email: schoenebeck at software minus engineering dot org  
7469    
7470    
7471    
# Line 4196  Author's Address Line 7481  Author's Address
7481    
7482    
7483    
 Schoenebeck             Expires November 2, 2005               [Page 75]  
7484    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
7485    
7486    
 Intellectual Property Statement  
7487    
    The IETF takes no position regarding the validity or scope of any  
    intellectual property or other rights that might be claimed to  
    pertain to the implementation or use of the technology described in  
    this document or the extent to which any license under such rights  
    might or might not be available; neither does it represent that it  
    has made any effort to identify any such rights.  Information on the  
    IETF's procedures with respect to rights in standards-track and  
    standards-related documentation can be found in BCP 11.  Copies of  
    claims of rights made available for publication and any assurances of  
    licenses to be made available, or the result of an attempt made to  
    obtain a general license or permission for the use of such  
    proprietary rights by implementors or users of this specification can  
    be obtained from the IETF Secretariat.  
7488    
    The IETF invites any interested party to bring to its attention any  
    copyrights, patents or patent applications, or other proprietary  
    rights which may cover technology that may be required to practice  
    this standard.  Please address the information to the IETF Executive  
    Director.  
7489    
7490    
 Full Copyright Statement  
7491    
    Copyright (C) The Internet Society (2005).  All Rights Reserved.  
7492    
    This document and translations of it may be copied and furnished to  
    others, and derivative works that comment on or otherwise explain it  
    or assist in its implementation may be prepared, copied, published  
    and distributed, in whole or in part, without restriction of any  
    kind, provided that the above copyright notice and this paragraph are  
    included on all such copies and derivative works.  However, this  
    document itself may not be modified in any way, such as by removing  
    the copyright notice or references to the Internet Society or other  
    Internet organizations, except as needed for the purpose of  
    developing Internet standards in which case the procedures for  
    copyrights defined in the Internet Standards process must be  
    followed, or as required to translate it into languages other than  
    English.  
7493    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
7494    
    This document and the information contained herein is provided on an  
    "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING  
    TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING  
    BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION  
7495    
7496    
7497    
 Schoenebeck             Expires November 2, 2005               [Page 76]  
7498    
 Internet-Draft        LinuxSampler Control Protocol             May 2005  
7499    
7500    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
7501    
7502    
7503  Acknowledgment  Schoenebeck               Expires March 4, 2008               [Page 134]
7504    
7505    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7506    
7507    
7508    Author's Address
7509    
7510       C. Schoenebeck
7511       Interessengemeinschaft Software Engineering e. V.
7512       Max-Planck-Str. 39
7513       74081 Heilbronn
7514       Germany
7515    
7516       Email: schoenebeck at software minus engineering dot org
7517    
7518    
7519    
7520    
7521    
    Funding for the RFC Editor function is currently provided by the  
    Internet Society.  
7522    
7523    
7524    
# Line 4302  Acknowledgment Line 7556  Acknowledgment
7556    
7557    
7558    
7559    Schoenebeck               Expires March 4, 2008               [Page 135]
7560    
7561    Internet-Draft    LinuxSampler Control Protocol (draft)   September 2007
7562    
7563    
7564    Full Copyright Statement
7565    
7566       Copyright (C) The IETF Trust (2007).
7567    
7568       This document is subject to the rights, licenses and restrictions
7569       contained in BCP 78, and except as set forth therein, the authors
7570       retain all their rights.
7571    
7572       This document and the information contained herein are provided on an
7573       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
7574       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
7575       THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
7576       OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
7577       THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
7578       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
7579    
7580    
7581    Intellectual Property
7582    
7583       The IETF takes no position regarding the validity or scope of any
7584       Intellectual Property Rights or other rights that might be claimed to
7585       pertain to the implementation or use of the technology described in
7586       this document or the extent to which any license under such rights
7587       might or might not be available; nor does it represent that it has
7588       made any independent effort to identify any such rights.  Information
7589       on the procedures with respect to rights in RFC documents can be
7590       found in BCP 78 and BCP 79.
7591    
7592       Copies of IPR disclosures made to the IETF Secretariat and any
7593       assurances of licenses to be made available, or the result of an
7594       attempt made to obtain a general license or permission for the use of
7595       such proprietary rights by implementers or users of this
7596       specification can be obtained from the IETF on-line IPR repository at
7597       http://www.ietf.org/ipr.
7598    
7599       The IETF invites any interested party to bring to its attention any
7600       copyrights, patents or patent applications, or other proprietary
7601       rights that may cover technology that may be required to implement
7602       this standard.  Please address the information to the IETF at
7603       ietf-ipr@ietf.org.
7604    
7605    
7606    Acknowledgment
7607    
7608       Funding for the RFC Editor function is provided by the IETF
7609       Administrative Support Activity (IASA).
7610    
7611    
7612    
7613    
7614    
7615  Schoenebeck             Expires November 2, 2005               [Page 77]  Schoenebeck               Expires March 4, 2008               [Page 136]
7616    
7617    
Legend:
Removed from v.708  
changed lines
  Added in v.1363
  ViewVC Help
Powered by ViewVC