/[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 709 by schoenebeck, Thu Jul 21 09:36:52 2005 UTC revision 993 by iliev, Wed Dec 20 19:56:43 2006 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: January 22, 2006                              Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                             July 21, 2005  Expires: June 23, 2007                                 December 20, 2006
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.1                                  LSCP 1.2
12    
13  Status of this Memo  Status of this Memo
14    
15     This document is an Internet-Draft and is in full conformance with     By submitting this Internet-Draft, each author represents that any
16     all provisions of Section 10 of RFC 2026.     applicable patent or other IPR claims of which he or she is aware
17       have been or will be disclosed, and any of which he or she becomes
18       aware will be disclosed, in accordance with Section 6 of BCP 79.
19    
20     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
21     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF), its areas, and its working groups.  Note that
# Line 31  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on January 22, 2006.     This Internet-Draft will expire on June 23, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2005).  All Rights Reserved.     Copyright (C) The Internet Society (2006).
41    
42    
43    
44    
45    
46    
47    
48    
49    
50    
51    
52    
53    
54    
55    Schoenebeck               Expires June 23, 2007                 [Page 1]
56    
57    Internet-Draft        LinuxSampler Control Protocol        December 2006
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  . . . . . . . . . . . . . . . . . . . .  5
72       2.  Versioning of this specification . . . . . . . . . . . . . . .  6
73       3.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  7
74       4.  Focus of this protocol . . . . . . . . . . . . . . . . . . . .  8
75       5.  Communication Overview . . . . . . . . . . . . . . . . . . . .  9
76         5.1.  Request/response communication method  . . . . . . . . . .  9
77           5.1.1.  Result format  . . . . . . . . . . . . . . . . . . . . 10
78         5.2.  Subscribe/notify communication method  . . . . . . . . . . 12
79       6.  Description for control commands . . . . . . . . . . . . . . . 14
80         6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 14
81         6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 14
82           6.2.1.  Getting amount of available audio output drivers . . . 15
83           6.2.2.  Getting all available audio output drivers . . . . . . 15
84           6.2.3.  Getting information about a specific audio output
85                   driver . . . . . . . . . . . . . . . . . . . . . . . . 15
86           6.2.4.  Getting information about specific audio output
87                   driver parameter . . . . . . . . . . . . . . . . . . . 16
88           6.2.5.  Creating an audio output device  . . . . . . . . . . . 20
89           6.2.6.  Destroying an audio output device  . . . . . . . . . . 21
90           6.2.7.  Getting all created audio output device count  . . . . 22
91           6.2.8.  Getting all created audio output device list . . . . . 22
92           6.2.9.  Getting current settings of an audio output device . . 22
93           6.2.10. Changing settings of audio output devices  . . . . . . 24
94           6.2.11. Getting information about an audio channel . . . . . . 25
95           6.2.12. Getting information about specific audio channel
96                   parameter  . . . . . . . . . . . . . . . . . . . . . . 26
97           6.2.13. Changing settings of audio output channels . . . . . . 28
98         6.3.  Configuring MIDI input drivers . . . . . . . . . . . . . . 29
99           6.3.1.  Getting amount of available MIDI input drivers . . . . 30
100           6.3.2.  Getting all available MIDI input drivers . . . . . . . 30
101           6.3.3.  Getting information about a specific MIDI input
102                   driver . . . . . . . . . . . . . . . . . . . . . . . . 31
103           6.3.4.  Getting information about specific MIDI input
104                   driver parameter . . . . . . . . . . . . . . . . . . . 32
105           6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 34
106           6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 35
107           6.3.7.  Getting all created MIDI input device count  . . . . . 36
108    
109    
110    
111    Schoenebeck               Expires June 23, 2007                 [Page 2]
112    
113    Internet-Draft        LinuxSampler Control Protocol        December 2006
114    
115    
116           6.3.8.  Getting all created MIDI input device list . . . . . . 36
117           6.3.9.  Getting current settings of a MIDI input device  . . . 37
118           6.3.10. Changing settings of MIDI input devices  . . . . . . . 38
119           6.3.11. Getting information about a MIDI port  . . . . . . . . 38
120           6.3.12. Getting information about specific MIDI port
121                   parameter  . . . . . . . . . . . . . . . . . . . . . . 39
122           6.3.13. Changing settings of MIDI input ports  . . . . . . . . 41
123         6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 42
124           6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 42
125           6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 43
126           6.4.3.  Getting all created sampler channel count  . . . . . . 44
127           6.4.4.  Getting all created sampler channel list . . . . . . . 44
128           6.4.5.  Adding a new sampler channel . . . . . . . . . . . . . 44
129           6.4.6.  Removing a sampler channel . . . . . . . . . . . . . . 45
130           6.4.7.  Getting amount of available engines  . . . . . . . . . 46
131           6.4.8.  Getting all available engines  . . . . . . . . . . . . 46
132           6.4.9.  Getting information about an engine  . . . . . . . . . 47
133           6.4.10. Getting sampler channel information  . . . . . . . . . 48
134           6.4.11. Current number of active voices  . . . . . . . . . . . 51
135           6.4.12. Current number of active disk streams  . . . . . . . . 51
136           6.4.13. Current fill state of disk stream buffers  . . . . . . 52
137           6.4.14. Setting audio output device  . . . . . . . . . . . . . 53
138           6.4.15. Setting audio output type  . . . . . . . . . . . . . . 53
139           6.4.16. Setting audio output channel . . . . . . . . . . . . . 54
140           6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 55
141           6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 56
142           6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 56
143           6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57
144           6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 58
145           6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58
146           6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 59
147           6.4.24. Assigning a MIDI instrument map to a sampler
148                   channel  . . . . . . . . . . . . . . . . . . . . . . . 60
149           6.4.25. Resetting a sampler channel  . . . . . . . . . . . . . 61
150         6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 61
151           6.5.1.  Register front-end for receiving event messages  . . . 61
152           6.5.2.  Unregister front-end for not receiving event
153                   messages . . . . . . . . . . . . . . . . . . . . . . . 62
154           6.5.3.  Enable or disable echo of commands . . . . . . . . . . 63
155           6.5.4.  Close client connection  . . . . . . . . . . . . . . . 63
156         6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 64
157           6.6.1.  Current number of active voices  . . . . . . . . . . . 64
158           6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 64
159           6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 64
160           6.6.4.  General sampler informations . . . . . . . . . . . . . 65
161         6.7.  MIDI Instrument Mapping  . . . . . . . . . . . . . . . . . 65
162           6.7.1.  Create a new MIDI instrument map . . . . . . . . . . . 66
163           6.7.2.  Delete one particular or all MIDI instrument maps  . . 67
164    
165    
166    
167    Schoenebeck               Expires June 23, 2007                 [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol        December 2006
170    
171    
172           6.7.3.  Get amount of existing MIDI instrument maps  . . . . . 67
173           6.7.4.  Getting all created MIDI instrument maps . . . . . . . 68
174           6.7.5.  Getting MIDI instrument map information  . . . . . . . 68
175           6.7.6.  Renaming a MIDI instrument map . . . . . . . . . . . . 69
176           6.7.7.  Create or replace a MIDI instrument map entry  . . . . 69
177           6.7.8.  Getting ammount of MIDI instrument map entries . . . . 72
178           6.7.9.  Getting indeces of all entries of a MIDI
179                   instrument map . . . . . . . . . . . . . . . . . . . . 73
180           6.7.10. Remove an entry from the MIDI instrument map . . . . . 73
181           6.7.11. Get current settings of MIDI instrument map entry  . . 74
182           6.7.12. Clear MIDI instrument map  . . . . . . . . . . . . . . 76
183       7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 77
184       8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
185         8.1.  Number of audio output devices changed . . . . . . . . . . 87
186         8.2.  Audio output device's settings changed . . . . . . . . . . 87
187         8.3.  Number of MIDI input devices changed . . . . . . . . . . . 87
188         8.4.  MIDI input device's settings changed . . . . . . . . . . . 88
189         8.5.  Number of sampler channels changed . . . . . . . . . . . . 88
190         8.6.  Number of active voices changed  . . . . . . . . . . . . . 88
191         8.7.  Number of active disk streams changed  . . . . . . . . . . 89
192         8.8.  Disk stream buffer fill state changed  . . . . . . . . . . 89
193         8.9.  Channel information changed  . . . . . . . . . . . . . . . 89
194         8.10. Total number of active voices changed  . . . . . . . . . . 90
195         8.11. Number of MIDI instrument maps changed . . . . . . . . . . 90
196         8.12. MIDI instrument map information changed  . . . . . . . . . 90
197         8.13. Number of MIDI instruments changed . . . . . . . . . . . . 91
198         8.14. MIDI instrument information changed  . . . . . . . . . . . 91
199         8.15. Miscellaneous and debugging events . . . . . . . . . . . . 92
200       9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 93
201       10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 94
202       11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 95
203       Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 96
204       Intellectual Property and Copyright Statements . . . . . . . . . . 97
205    
206    
207    
208    
209    
210    
211    
 Schoenebeck             Expires January 22, 2006                [Page 1]  
212    
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
213    
214    
 Table of Contents  
215    
    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 January 22, 2006                [Page 2]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 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  
216    
217    
218    
219    
220    
221    
 Schoenebeck             Expires January 22, 2006                [Page 3]  
222    
223  Internet-Draft        LinuxSampler Control Protocol            July 2005  Schoenebeck               Expires June 23, 2007                 [Page 4]
224    
225    Internet-Draft        LinuxSampler Control Protocol        December 2006
226    
227    
228  1.  Requirements notation  1.  Requirements notation
# Line 220  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck             Expires January 22, 2006                [Page 4]  Schoenebeck               Expires June 23, 2007                 [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
282    
283    
284  2.  Versioning of this specification  2.  Versioning of this specification
# Line 251  Internet-Draft        LinuxSampler Contr Line 307  Internet-Draft        LinuxSampler Contr
307         sampler's LSCP minor version.         sampler's LSCP minor version.
308    
309     Compatibility can only be claimed if both rules are true.  The     Compatibility can only be claimed if both rules are true.  The
310     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
311     the version of the LSCP specification the sampler complies with.     the version of the LSCP specification the sampler complies with.
312    
313    
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck             Expires January 22, 2006                [Page 5]  Schoenebeck               Expires June 23, 2007                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
338    
339    
340  3.  Introduction  3.  Introduction
# Line 332  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck             Expires January 22, 2006                [Page 6]  Schoenebeck               Expires June 23, 2007                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
394    
395    
396  4.  Focus of this protocol  4.  Focus of this protocol
# Line 388  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck             Expires January 22, 2006                [Page 7]  Schoenebeck               Expires June 23, 2007                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
450    
451    
452  5.  Communication Overview  5.  Communication Overview
# Line 405  Internet-Draft        LinuxSampler Contr Line 461  Internet-Draft        LinuxSampler Contr
461     more effort to be implemented in the front-end application.  The two     more effort to be implemented in the front-end application.  The two
462     communication methods will be described next.     communication methods will be described next.
463    
464  5.1  Request/response communication method  5.1.  Request/response communication method
465    
466     This simple communication method is based on TCP [RFC793].  The     This simple communication method is based on TCP [RFC793].  The
467     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 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck             Expires January 22, 2006                [Page 8]  Schoenebeck               Expires June 23, 2007                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
506    
507    
508  5.1.1  Result format  5.1.1.  Result format
509    
510     Result set could be one of the following types:     Result set could be one of the following types:
511    
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck             Expires January 22, 2006                [Page 9]  Schoenebeck               Expires June 23, 2007                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
562    
563    
564     set has the following format:     set has the following format:
# Line 556  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck             Expires January 22, 2006               [Page 10]  Schoenebeck               Expires June 23, 2007                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
618    
619    
620     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 629  Internet-Draft        LinuxSampler Contr
629    
630        S: "WRN[0]:32:Sample rate not supported, using 44100 instead."        S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
631    
632    5.2.  Subscribe/notify communication method
 5.2  Subscribe/notify communication method  
633    
634     This more sophisticated communication method is actually only an     This more sophisticated communication method is actually only an
635     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 664  Internet-Draft        LinuxSampler Contr
664    
665     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
666         in the stream before or after the response, but NOT in the         in the stream before or after the response, but NOT in the
667           middle.  Same is true about the response.  It should never be
668    
669    
670    
671  Schoenebeck             Expires January 22, 2006               [Page 11]  Schoenebeck               Expires June 23, 2007                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
674    
675    
        middle.  Same is true about the response.  It should never be  
676         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
677         response.         response.
678    
# Line 668  Internet-Draft        LinuxSampler Contr Line 723  Internet-Draft        LinuxSampler Contr
723    
724    
725    
 Schoenebeck             Expires January 22, 2006               [Page 12]  
726    
727  Internet-Draft        LinuxSampler Control Protocol            July 2005  Schoenebeck               Expires June 23, 2007                [Page 13]
728    
729    Internet-Draft        LinuxSampler Control Protocol        December 2006
730    
731    
732  6.  Description for control commands  6.  Description for control commands
# Line 682  Internet-Draft        LinuxSampler Contr Line 738  Internet-Draft        LinuxSampler Contr
738     LinuxSampler signals the end of the response by a "." (single dot)     LinuxSampler signals the end of the response by a "." (single dot)
739     line.     line.
740    
741  6.1  Ignored lines and comments  6.1.  Ignored lines and comments
742    
743     White lines, that is lines which only contain space and tabulator     White lines, that is lines which only contain space and tabulator
744     characters, and lines that start with a "#" character are ignored,     characters, and lines that start with a "#" character are ignored,
745     thus it's possible for example to group commands and to place     thus it's possible for example to group commands and to place
746     comments in a LSCP script file.     comments in a LSCP script file.
747    
748  6.2  Configuring audio drivers  6.2.  Configuring audio drivers
749    
750     Instances of drivers in LinuxSampler are called devices.  You can use     Instances of drivers in LinuxSampler are called devices.  You can use
751     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 774  Internet-Draft        LinuxSampler Contr
774     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
775     possible values, etc.     possible values, etc.
776    
 6.2.1  Getting amount of available audio output drivers  
777    
    Use the following command to get the number of audio output drivers  
778    
779    
780    
 Schoenebeck             Expires January 22, 2006               [Page 13]  
781    
782  Internet-Draft        LinuxSampler Control Protocol            July 2005  
783    Schoenebeck               Expires June 23, 2007                [Page 14]
784    
785    Internet-Draft        LinuxSampler Control Protocol        December 2006
786    
787    
788    6.2.1.  Getting amount of available audio output drivers
789    
790       Use the following command to get the number of audio output drivers
791     currently available for the LinuxSampler instance:     currently available for the LinuxSampler instance:
792    
793        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 744  Internet-Draft        LinuxSampler Contr Line 803  Internet-Draft        LinuxSampler Contr
803    
804        S: "2"        S: "2"
805    
806    6.2.2.  Getting all available audio output drivers
 6.2.2  Getting all available audio output drivers  
807    
808     Use the following command to list all audio output drivers currently     Use the following command to list all audio output drivers currently
809     available for the LinuxSampler instance:     available for the LinuxSampler instance:
# Line 763  Internet-Draft        LinuxSampler Contr Line 821  Internet-Draft        LinuxSampler Contr
821    
822        S: "ALSA,JACK"        S: "ALSA,JACK"
823    
824    6.2.3.  Getting information about a specific audio output driver
 6.2.3  Getting information about a specific audio output driver  
825    
826     Use the following command to get detailed information about a     Use the following command to get detailed information about a
827     specific audio output driver:     specific audio output driver:
# Line 779  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839    Schoenebeck               Expires June 23, 2007                [Page 15]
840  Schoenebeck             Expires January 22, 2006               [Page 14]  
841    Internet-Draft        LinuxSampler Control Protocol        December 2006
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
842    
843    
844        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 879  Internet-Draft        LinuxSampler Contr
879    
880           "."           "."
881    
882    6.2.4.  Getting information about specific audio output driver parameter
 6.2.4  Getting information about specific audio output driver parameter  
883    
884     Use the following command to get detailed information about a     Use the following command to get detailed information about a
885     specific audio output driver parameter:     specific audio output driver parameter:
# Line 833  Internet-Draft        LinuxSampler Contr Line 888  Internet-Draft        LinuxSampler Contr
888    
889     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
890     the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,     the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,
891       <prm> a specific parameter name for which information should be
892    
893    
894    
895  Schoenebeck             Expires January 22, 2006               [Page 15]  Schoenebeck               Expires June 23, 2007                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
898    
899    
    <prm> a specific parameter name for which information should be  
900     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
901     (Section 6.2.3) command) and <deplist> is an optional list of     (Section 6.2.3) command) and <deplist> is an optional list of
902     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 947  Internet-Draft        LinuxSampler Contr
947    
948    
949    
 Schoenebeck             Expires January 22, 2006               [Page 16]  
950    
951  Internet-Draft        LinuxSampler Control Protocol            July 2005  Schoenebeck               Expires June 23, 2007                [Page 17]
952    
953    Internet-Draft        LinuxSampler Control Protocol        December 2006
954    
955    
956        MULTIPLICITY -        MULTIPLICITY -
# Line 948  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck             Expires January 22, 2006               [Page 17]  Schoenebeck               Expires June 23, 2007                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
1010    
1011    
1012           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck             Expires January 22, 2006               [Page 18]  Schoenebeck               Expires June 23, 2007                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
1066    
1067    
1068           "TYPE: INT"           "TYPE: INT"
# Line 1027  Internet-Draft        LinuxSampler Contr Line 1083  Internet-Draft        LinuxSampler Contr
1083    
1084           "."           "."
1085    
1086    6.2.5.  Creating an audio output device
1087    
1088  6.2.5  Creating an audio output device     Use the following command to create a new audio output device for the
1089       desired audio output system:
    Use the following command to create a new audio output device for  
    the desired audio output system:  
1090    
1091        CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]        CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]
1092    
# Line 1057  Internet-Draft        LinuxSampler Contr Line 1112  Internet-Draft        LinuxSampler Contr
1112           in case the device was created successfully, where <device-id>           in case the device was created successfully, where <device-id>
1113           is the numerical ID of the new device, but there are noteworthy           is the numerical ID of the new device, but there are noteworthy
1114           issue(s) related (e.g. sound card doesn't support given           issue(s) related (e.g. sound card doesn't support given
1115             hardware parameters and the driver is using fall-back values),
1116    
1117    
1118    
1119  Schoenebeck             Expires January 22, 2006               [Page 19]  Schoenebeck               Expires June 23, 2007                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
1122    
1123    
          hardware parameters and the driver is using fall-back values),  
1124           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
1125    
1126        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 1083  Internet-Draft        LinuxSampler Contr Line 1138  Internet-Draft        LinuxSampler Contr
1138    
1139        S: "OK[1]"        S: "OK[1]"
1140    
1141    6.2.6.  Destroying an audio output device
 6.2.6  Destroying an audio output device  
1142    
1143     Use the following command to destroy a created output device:     Use the following command to destroy a created output device:
1144    
# Line 1114  Internet-Draft        LinuxSampler Contr Line 1168  Internet-Draft        LinuxSampler Contr
1168           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1169           error message           error message
1170    
1171       Example:
1172    
1173    
 Schoenebeck             Expires January 22, 2006               [Page 20]  
1174    
1175  Internet-Draft        LinuxSampler Control Protocol            July 2005  Schoenebeck               Expires June 23, 2007                [Page 21]
1176    
1177    Internet-Draft        LinuxSampler Control Protocol        December 2006
1178    
1179    
    Example:  
   
1180        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
1181    
1182        S: "OK"        S: "OK"
1183    
1184    6.2.7.  Getting all created audio output device count
 6.2.7  Getting all created audio output device count  
1185    
1186     Use the following command to count all created audio output devices:     Use the following command to count all created audio output devices:
1187    
# Line 1145  Internet-Draft        LinuxSampler Contr Line 1198  Internet-Draft        LinuxSampler Contr
1198    
1199        S: "4"        S: "4"
1200    
1201    6.2.8.  Getting all created audio output device list
 6.2.8  Getting all created audio output device list  
1202    
1203     Use the following command to list all created audio output devices:     Use the following command to list all created audio output devices:
1204    
# Line 1163  Internet-Draft        LinuxSampler Contr Line 1215  Internet-Draft        LinuxSampler Contr
1215    
1216        S: "0,1,4,5"        S: "0,1,4,5"
1217    
1218    6.2.9.  Getting current settings of an audio output device
 6.2.9  Getting current settings of an audio output device  
1219    
1220     Use the following command to get current settings of a specific,     Use the following command to get current settings of a specific,
1221     created audio output device:     created audio output device:
1222    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 21]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1223        GET AUDIO_OUTPUT_DEVICE INFO <device-id>        GET AUDIO_OUTPUT_DEVICE INFO <device-id>
1224    
1225     Where <device-id> should be replaced by numerical ID of the audio     Where <device-id> should be replaced by numerical ID of the audio
1226     output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"     output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"
1227     (Section 6.2.8) command.     (Section 6.2.8) command.
1228    
1229    
1230    
1231    Schoenebeck               Expires June 23, 2007                [Page 22]
1232    
1233    Internet-Draft        LinuxSampler Control Protocol        December 2006
1234    
1235    
1236     Possible Answers:     Possible Answers:
1237    
1238     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 1275  Internet-Draft        LinuxSampler Contr
1275    
1276        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
1277    
1278             "CHANNELS: 2"
1279    
1280             "SAMPLERATE: 44100"
1281    
1282             "ACTIVE: true"
1283    
 Schoenebeck             Expires January 22, 2006               [Page 22]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
1284    
1285    
          "CHANNELS: 2"  
1286    
1287           "SAMPLERATE: 44100"  Schoenebeck               Expires June 23, 2007                [Page 23]
1288    
1289    Internet-Draft        LinuxSampler Control Protocol        December 2006
1290    
          "ACTIVE: true"  
1291    
1292           "FRAGMENTS: 2"           "FRAGMENTS: 2"
1293    
# Line 1247  Internet-Draft        LinuxSampler Contr Line 1297  Internet-Draft        LinuxSampler Contr
1297    
1298           "."           "."
1299    
1300    6.2.10.  Changing settings of audio output devices
 6.2.10  Changing settings of audio output devices  
1301    
1302     Use the following command to alter a specific setting of a created     Use the following command to alter a specific setting of a created
1303     audio output device:     audio output device:
# Line 1280  Internet-Draft        LinuxSampler Contr Line 1329  Internet-Draft        LinuxSampler Contr
1329    
1330     Example:     Example:
1331    
1332          C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
1333    
1334          S: "OK"
1335    
1336    
1337    
 Schoenebeck             Expires January 22, 2006               [Page 23]  
1338    
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
1339    
1340    
       C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"  
1341    
1342        S: "OK"  
1343    Schoenebeck               Expires June 23, 2007                [Page 24]
1344    
1345    Internet-Draft        LinuxSampler Control Protocol        December 2006
1346    
1347    
1348  6.2.11  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
1349    
1350     Use the following command to get information about an audio channel:     Use the following command to get information about an audio channel:
1351    
# Line 1337  Internet-Draft        LinuxSampler Contr Line 1388  Internet-Draft        LinuxSampler Contr
1388              actually will be routed / added to (only returned in case              actually will be routed / added to (only returned in case
1389              the audio channel is mix channel)              the audio channel is mix channel)
1390    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 24]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1391     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
1392     fields above are only those fields which are generally returned for     fields above are only those fields which are generally returned for
1393     the described cases by all audio channels regardless of the audio     the described cases by all audio channels regardless of the audio
1394     driver.  Every audio channel might have its own, additional driver     driver.  Every audio channel might have its own, additional driver
1395     and channel specific parameters.     and channel specific parameters.
1396    
1397    
1398    
1399    Schoenebeck               Expires June 23, 2007                [Page 25]
1400    
1401    Internet-Draft        LinuxSampler Control Protocol        December 2006
1402    
1403    
1404     Examples:     Examples:
1405    
1406        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
# Line 1389  Internet-Draft        LinuxSampler Contr Line 1439  Internet-Draft        LinuxSampler Contr
1439    
1440           "."           "."
1441    
1442    6.2.12.  Getting information about specific audio channel parameter
 6.2.12  Getting information about specific audio channel parameter  
1443    
1444     Use the following command to get detailed information about specific     Use the following command to get detailed information about specific
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 25]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1445     audio channel parameter:     audio channel parameter:
1446    
1447        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 1449  Internet-Draft        LinuxSampler Contr
1449     Where <dev-id> is the numerical ID of the audio output device as     Where <dev-id> is the numerical ID of the audio output device as
1450     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1451     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
1452    
1453    
1454    
1455    Schoenebeck               Expires June 23, 2007                [Page 26]
1456    
1457    Internet-Draft        LinuxSampler Control Protocol        December 2006
1458    
1459    
1460     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
1461     which information should be obtained (as returned by the "GET     which information should be obtained (as returned by the "GET
1462     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
# Line 1448  Internet-Draft        LinuxSampler Contr Line 1497  Internet-Draft        LinuxSampler Contr
1497              values and false only a single value allowed (always              values and false only a single value allowed (always
1498              returned)              returned)
1499    
   
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 26]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1500           RANGE_MIN -           RANGE_MIN -
1501    
1502              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 1505  Internet-Draft        LinuxSampler Contr
1505              may also appear without (optionally returned, dependent to              may also appear without (optionally returned, dependent to
1506              driver and channel parameter)              driver and channel parameter)
1507    
1508    
1509    
1510    
1511    Schoenebeck               Expires June 23, 2007                [Page 27]
1512    
1513    Internet-Draft        LinuxSampler Control Protocol        December 2006
1514    
1515    
1516           RANGE_MAX -           RANGE_MAX -
1517    
1518              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 1546  Internet-Draft        LinuxSampler Contr
1546    
1547           "."           "."
1548    
1549    6.2.13.  Changing settings of audio output channels
 6.2.13  Changing settings of audio output channels  
1550    
1551     Use the following command to alter a specific setting of an audio     Use the following command to alter a specific setting of an audio
1552     output channel:     output channel:
1553    
   
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 27]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1554        SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>        SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>
1555    
1556     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 1561  Internet-Draft        LinuxSampler Contr
1561    
1562     Possible Answers:     Possible Answers:
1563    
1564    
1565    
1566    
1567    Schoenebeck               Expires June 23, 2007                [Page 28]
1568    
1569    Internet-Draft        LinuxSampler Control Protocol        December 2006
1570    
1571    
1572        "OK" -        "OK" -
1573    
1574           in case setting was successfully changed           in case setting was successfully changed
# Line 1548  Internet-Draft        LinuxSampler Contr Line 1594  Internet-Draft        LinuxSampler Contr
1594    
1595        S: "OK"        S: "OK"
1596    
1597    6.3.  Configuring MIDI input drivers
 6.3  Configuring MIDI input drivers  
1598    
1599     Instances of drivers in LinuxSampler are called devices.  You can use     Instances of drivers in LinuxSampler are called devices.  You can use
1600     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 1606  Internet-Draft        LinuxSampler Contr
1606    
1607     Instead of defining commands and parameters for each driver     Instead of defining commands and parameters for each driver
1608     individually, all possible parameters, their meanings and possible     individually, all possible parameters, their meanings and possible
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 28]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1609     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
1610     abstract, but has the advantage, that front-ends can be written     abstract, but has the advantage, that front-ends can be written
1611     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 1617  Internet-Draft        LinuxSampler Contr
1617     as the commands for configuring audio output drivers, already     as the commands for configuring audio output drivers, already
1618     described in the last chapter.     described in the last chapter.
1619    
1620    
1621    
1622    
1623    Schoenebeck               Expires June 23, 2007                [Page 29]
1624    
1625    Internet-Draft        LinuxSampler Control Protocol        December 2006
1626    
1627    
1628     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
1629     drivers are not meant as specification of the drivers' parameters.     drivers are not meant as specification of the drivers' parameters.
1630     Driver implementations in LinuxSampler might have complete different     Driver implementations in LinuxSampler might have complete different
# Line 1588  Internet-Draft        LinuxSampler Contr Line 1633  Internet-Draft        LinuxSampler Contr
1633     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
1634     possible values, etc.     possible values, etc.
1635    
1636  6.3.1  Getting amount of available MIDI input drivers  6.3.1.  Getting amount of available MIDI input drivers
1637    
1638     Use the following command to get the number of MIDI input drivers     Use the following command to get the number of MIDI input drivers
1639     currently available for the LinuxSampler instance:     currently available for the LinuxSampler instance:
# Line 1606  Internet-Draft        LinuxSampler Contr Line 1651  Internet-Draft        LinuxSampler Contr
1651    
1652        S: "2"        S: "2"
1653    
1654    6.3.2.  Getting all available MIDI input drivers
 6.3.2  Getting all available MIDI input drivers  
1655    
1656     Use the following command to list all MIDI input drivers currently     Use the following command to list all MIDI input drivers currently
1657     available for the LinuxSampler instance:     available for the LinuxSampler instance:
# Line 1616  Internet-Draft        LinuxSampler Contr Line 1660  Internet-Draft        LinuxSampler Contr
1660    
1661     Possible Answers:     Possible Answers:
1662    
1663          LinuxSampler will answer by sending comma separated character
1664          strings, each symbolizing a MIDI input driver.
1665    
1666       Example:
1667    
1668          C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
1669    
1670          S: "ALSA,JACK"
1671    
1672    
 Schoenebeck             Expires January 22, 2006               [Page 29]  
1673    
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
1674    
1675    
       LinuxSampler will answer by sending comma separated character  
       strings, each symbolizing a MIDI input driver.  
1676    
    Example:  
1677    
       C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"  
1678    
1679        S: "ALSA,JACK"  Schoenebeck               Expires June 23, 2007                [Page 30]
1680    
1681    Internet-Draft        LinuxSampler Control Protocol        December 2006
1682    
1683    
1684  6.3.3  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
1685    
1686     Use the following command to get detailed information about a     Use the following command to get detailed information about a
1687     specific MIDI input driver:     specific MIDI input driver:
# Line 1673  Internet-Draft        LinuxSampler Contr Line 1719  Internet-Draft        LinuxSampler Contr
1719    
1720     Example:     Example:
1721    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 30]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1722        C: "GET MIDI_INPUT_DRIVER INFO ALSA"        C: "GET MIDI_INPUT_DRIVER INFO ALSA"
1723    
1724        S: "DESCRIPTION: Advanced Linux Sound Architecture"        S: "DESCRIPTION: Advanced Linux Sound Architecture"
# Line 1692  Internet-Draft        LinuxSampler Contr Line 1730  Internet-Draft        LinuxSampler Contr
1730           "."           "."
1731    
1732    
1733  6.3.4  Getting information about specific MIDI input driver parameter  
1734    
1735    Schoenebeck               Expires June 23, 2007                [Page 31]
1736    
1737    Internet-Draft        LinuxSampler Control Protocol        December 2006
1738    
1739    
1740    6.3.4.  Getting information about specific MIDI input driver parameter
1741    
1742     Use the following command to get detailed information about a     Use the following command to get detailed information about a
1743     specific parameter of a specific MIDI input driver:     specific parameter of a specific MIDI input driver:
# Line 1729  Internet-Draft        LinuxSampler Contr Line 1774  Internet-Draft        LinuxSampler Contr
1774           character string(s) (always returned, no matter which driver           character string(s) (always returned, no matter which driver
1775           parameter)           parameter)
1776    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 31]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1777        DESCRIPTION -        DESCRIPTION -
1778    
1779           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 1786  Internet-Draft        LinuxSampler Contr
1786           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1787           matter which driver parameter)           matter which driver parameter)
1788    
1789    
1790    
1791    Schoenebeck               Expires June 23, 2007                [Page 32]
1792    
1793    Internet-Draft        LinuxSampler Control Protocol        December 2006
1794    
1795    
1796        FIX -        FIX -
1797    
1798           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 1828  Internet-Draft        LinuxSampler Contr
1828           character strings are encapsulated into apostrophes (')           character strings are encapsulated into apostrophes (')
1829           (optionally returned, dependent to driver parameter)           (optionally returned, dependent to driver parameter)
1830    
   
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 32]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1831        RANGE_MIN -        RANGE_MIN -
1832    
1833           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 1841  Internet-Draft        LinuxSampler Contr
1841           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
1842           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1843           this parameter is often used in conjunction with RANGE_MIN, but           this parameter is often used in conjunction with RANGE_MIN, but
1844    
1845    
1846    
1847    Schoenebeck               Expires June 23, 2007                [Page 33]
1848    
1849    Internet-Draft        LinuxSampler Control Protocol        December 2006
1850    
1851    
1852           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
1853           driver parameter)           driver parameter)
1854    
# Line 1835  Internet-Draft        LinuxSampler Contr Line 1878  Internet-Draft        LinuxSampler Contr
1878    
1879           "."           "."
1880    
1881    6.3.5.  Creating a MIDI input device
1882    
1883  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  
1884     desired MIDI input system:     desired MIDI input system:
1885    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 33]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1886        CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]        CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]
1887    
1888     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 1896  Internet-Draft        LinuxSampler Contr
1896    
1897     Possible Answers:     Possible Answers:
1898    
1899    
1900    
1901    
1902    
1903    Schoenebeck               Expires June 23, 2007                [Page 34]
1904    
1905    Internet-Draft        LinuxSampler Control Protocol        December 2006
1906    
1907    
1908        "OK[<device-id>]" -        "OK[<device-id>]" -
1909    
1910           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 1928  Internet-Draft        LinuxSampler Contr
1928    
1929        S: "OK[0]"        S: "OK[0]"
1930    
1931    6.3.6.  Destroying a MIDI input device
 6.3.6  Destroying a MIDI input device  
1932    
1933     Use the following command to destroy a created MIDI input device:     Use the following command to destroy a created MIDI input device:
1934    
# Line 1898  Internet-Draft        LinuxSampler Contr Line 1940  Internet-Draft        LinuxSampler Contr
1940    
1941     Possible Answers:     Possible Answers:
1942    
   
   
 Schoenebeck             Expires January 22, 2006               [Page 34]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1943        "OK" -        "OK" -
1944    
1945           in case the device was successfully destroyed           in case the device was successfully destroyed
# Line 1917  Internet-Draft        LinuxSampler Contr Line 1952  Internet-Draft        LinuxSampler Contr
1952    
1953        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1954    
1955    
1956    
1957    
1958    
1959    Schoenebeck               Expires June 23, 2007                [Page 35]
1960    
1961    Internet-Draft        LinuxSampler Control Protocol        December 2006
1962    
1963    
1964           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1965           error message           error message
1966    
# Line 1926  Internet-Draft        LinuxSampler Contr Line 1970  Internet-Draft        LinuxSampler Contr
1970    
1971        S: "OK"        S: "OK"
1972    
1973    6.3.7.  Getting all created MIDI input device count
 6.3.7  Getting all created MIDI input device count  
1974    
1975     Use the following command to count all created MIDI input devices:     Use the following command to count all created MIDI input devices:
1976    
# Line 1944  Internet-Draft        LinuxSampler Contr Line 1987  Internet-Draft        LinuxSampler Contr
1987    
1988        S: "3"        S: "3"
1989    
1990    6.3.8.  Getting all created MIDI input device list
 6.3.8  Getting all created MIDI input device list  
1991    
1992     Use the following command to list all created MIDI input devices:     Use the following command to list all created MIDI input devices:
1993    
# Line 1953  Internet-Draft        LinuxSampler Contr Line 1995  Internet-Draft        LinuxSampler Contr
1995    
1996     Possible Answers:     Possible Answers:
1997    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 35]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
1998        LinuxSampler will answer by sending a comma separated list with        LinuxSampler will answer by sending a comma separated list with
1999        the numerical Ids of all created MIDI input devices.        the numerical Ids of all created MIDI input devices.
2000    
# Line 1975  Internet-Draft        LinuxSampler Contr Line 2009  Internet-Draft        LinuxSampler Contr
2009        S: "1,3"        S: "1,3"
2010    
2011    
2012  6.3.9  Getting current settings of a MIDI input device  
2013    
2014    
2015    Schoenebeck               Expires June 23, 2007                [Page 36]
2016    
2017    Internet-Draft        LinuxSampler Control Protocol        December 2006
2018    
2019    
2020    6.3.9.  Getting current settings of a MIDI input device
2021    
2022     Use the following command to get current settings of a specific,     Use the following command to get current settings of a specific,
2023     created MIDI input device:     created MIDI input device:
# Line 2010  Internet-Draft        LinuxSampler Contr Line 2052  Internet-Draft        LinuxSampler Contr
2052              inactive and doesn't listen to any incoming MIDI events and              inactive and doesn't listen to any incoming MIDI events and
2053              thus doesn't forward them to connected sampler channels              thus doesn't forward them to connected sampler channels
2054    
   
   
 Schoenebeck             Expires January 22, 2006               [Page 36]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2055     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
2056     fields above are only those fields which are returned by all MIDI     fields above are only those fields which are returned by all MIDI
2057     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 2065  Internet-Draft        LinuxSampler Contr
2065    
2066        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
2067    
2068    
2069    
2070    
2071    Schoenebeck               Expires June 23, 2007                [Page 37]
2072    
2073    Internet-Draft        LinuxSampler Control Protocol        December 2006
2074    
2075    
2076           "ACTIVE: true"           "ACTIVE: true"
2077    
2078           "."           "."
2079    
2080    6.3.10.  Changing settings of MIDI input devices
 6.3.10  Changing settings of MIDI input devices  
2081    
2082     Use the following command to alter a specific setting of a created     Use the following command to alter a specific setting of a created
2083     MIDI input device:     MIDI input device:
# Line 2065  Internet-Draft        LinuxSampler Contr Line 2107  Internet-Draft        LinuxSampler Contr
2107           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2108           error message           error message
2109    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 37]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2110     Example:     Example:
2111    
2112        C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"        C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
2113    
2114        S: "OK"        S: "OK"
2115    
2116    6.3.11.  Getting information about a MIDI port
 6.3.11  Getting information about a MIDI port  
2117    
2118     Use the following command to get information about a MIDI port:     Use the following command to get information about a MIDI port:
2119    
# Line 2088  Internet-Draft        LinuxSampler Contr Line 2121  Internet-Draft        LinuxSampler Contr
2121    
2122     Where <device-id> is the numerical ID of the MIDI input device as     Where <device-id> is the numerical ID of the MIDI input device as
2123     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2124    
2125    
2126    
2127    Schoenebeck               Expires June 23, 2007                [Page 38]
2128    
2129    Internet-Draft        LinuxSampler Control Protocol        December 2006
2130    
2131    
2132     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
2133     input port number.     input port number.
2134    
# Line 2117  Internet-Draft        LinuxSampler Contr Line 2158  Internet-Draft        LinuxSampler Contr
2158    
2159           "."           "."
2160    
2161    6.3.12.  Getting information about specific MIDI port parameter
 6.3.12  Getting information about specific MIDI port parameter  
2162    
2163     Use the following command to get detailed information about specific     Use the following command to get detailed information about specific
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 38]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2164     MIDI port parameter:     MIDI port parameter:
2165    
2166        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 2177  Internet-Draft        LinuxSampler Contr
2177        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2178        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2179        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
2180    
2181    
2182    
2183    Schoenebeck               Expires June 23, 2007                [Page 39]
2184    
2185    Internet-Draft        LinuxSampler Control Protocol        December 2006
2186    
2187    
2188        character string to that info category.  There is information        character string to that info category.  There is information
2189        which is always returned, independently of the given channel        which is always returned, independently of the given channel
2190        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 2217  Internet-Draft        LinuxSampler Contr
2217    
2218           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
2219           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 January 22, 2006               [Page 39]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2220           this parameter is usually used in conjunction with 'RANGE_MAX'           this parameter is usually used in conjunction with 'RANGE_MAX'
2221           but may also appear without (optionally returned, dependent to           but may also appear without (optionally returned, dependent to
2222           driver and port parameter)           driver and port parameter)
# Line 2201  Internet-Draft        LinuxSampler Contr Line 2233  Internet-Draft        LinuxSampler Contr
2233    
2234           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
2235           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
2236    
2237    
2238    
2239    Schoenebeck               Expires June 23, 2007                [Page 40]
2240    
2241    Internet-Draft        LinuxSampler Control Protocol        December 2006
2242    
2243    
2244           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
2245    
2246     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 2261  Internet-Draft        LinuxSampler Contr
2261    
2262           "."           "."
2263    
2264    6.3.13.  Changing settings of MIDI input ports
 6.3.13  Changing settings of MIDI input ports  
2265    
2266     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
2267     port:     port:
# Line 2233  Internet-Draft        LinuxSampler Contr Line 2272  Internet-Draft        LinuxSampler Contr
2272     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)
2273     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
2274     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
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 40]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2275     <value> by the new value for this parameter.     <value> by the new value for this parameter.
2276    
2277     Possible Answers:     Possible Answers:
# Line 2257  Internet-Draft        LinuxSampler Contr Line 2288  Internet-Draft        LinuxSampler Contr
2288    
2289        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2290    
2291    
2292    
2293    
2294    
2295    Schoenebeck               Expires June 23, 2007                [Page 41]
2296    
2297    Internet-Draft        LinuxSampler Control Protocol        December 2006
2298    
2299    
2300           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2301           error message           error message
2302    
# Line 2264  Internet-Draft        LinuxSampler Contr Line 2304  Internet-Draft        LinuxSampler Contr
2304    
2305    
2306    
2307    6.4.  Configuring sampler channels
 6.4  Configuring sampler channels  
2308    
2309     The following commands describe how to add and remove sampler     The following commands describe how to add and remove sampler
2310     channels, associate a sampler channel with a sampler engine, load     channels, associate a sampler channel with a sampler engine, load
2311     instruments and connect sampler channels to MIDI and audio devices.     instruments and connect sampler channels to MIDI and audio devices.
2312    
2313  6.4.1  Loading an instrument  6.4.1.  Loading an instrument
2314    
2315     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
2316     one of the following commands:     one of the following commands:
# Line 2289  Internet-Draft        LinuxSampler Contr Line 2328  Internet-Draft        LinuxSampler Contr
2328     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2329     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
2330     version returns immediately and a background process is launched to     version returns immediately and a background process is launched to
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 41]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2331     load the instrument on the channel.  The GET CHANNEL INFO     load the instrument on the channel.  The GET CHANNEL INFO
2332     (Section 6.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2333     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
# Line 2314  Internet-Draft        LinuxSampler Contr Line 2345  Internet-Draft        LinuxSampler Contr
2345    
2346           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2347           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
2348    
2349    
2350    
2351    Schoenebeck               Expires June 23, 2007                [Page 42]
2352    
2353    Internet-Draft        LinuxSampler Control Protocol        December 2006
2354    
2355    
2356           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
2357           file), providing an appropriate warning code and warning           file), providing an appropriate warning code and warning
2358           message           message
# Line 2327  Internet-Draft        LinuxSampler Contr Line 2366  Internet-Draft        LinuxSampler Contr
2366    
2367    
2368    
2369    6.4.2.  Loading a sampler engine
 6.4.2  Loading a sampler engine  
2370    
2371     A sampler engine type can be associated to a specific sampler channel     A sampler engine type can be associated to a specific sampler channel
2372     by the following command:     by the following command:
# Line 2345  Internet-Draft        LinuxSampler Contr Line 2383  Internet-Draft        LinuxSampler Contr
2383     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
2384     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
2385     given sampler channel or if an already existing instance of that     given sampler channel or if an already existing instance of that
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 42]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2386     engine type, shared with other sampler channels, should be used.     engine type, shared with other sampler channels, should be used.
2387    
2388     Possible Answers:     Possible Answers:
# Line 2372  Internet-Draft        LinuxSampler Contr Line 2402  Internet-Draft        LinuxSampler Contr
2402           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2403           error message           error message
2404    
    Example:  
2405    
2406    
2407    Schoenebeck               Expires June 23, 2007                [Page 43]
2408    
2409    Internet-Draft        LinuxSampler Control Protocol        December 2006
2410    
2411    
2412       Example:
2413    
2414    
2415    
2416  6.4.3  Getting all created sampler channel count  6.4.3.  Getting all created sampler channel count
2417    
2418     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
2419     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 2432  Internet-Draft        LinuxSampler Contr
2432    
2433        S: "12"        S: "12"
2434    
2435    6.4.4.  Getting all created sampler channel list
 6.4.4  Getting all created sampler channel list  
2436    
2437     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
2438     current list of sampler channels, the front-end can send the     current list of sampler channels, the front-end can send the
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 43]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2439     following command:     following command:
2440    
2441        LIST CHANNELS        LIST CHANNELS
# Line 2424  Internet-Draft        LinuxSampler Contr Line 2451  Internet-Draft        LinuxSampler Contr
2451    
2452        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"
2453    
2454    6.4.5.  Adding a new sampler channel
 6.4.5  Adding a new sampler channel  
2455    
2456     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2457     list by sending the following command:     list by sending the following command:
2458    
2459    
2460    
2461    
2462    
2463    Schoenebeck               Expires June 23, 2007                [Page 44]
2464    
2465    Internet-Draft        LinuxSampler Control Protocol        December 2006
2466    
2467    
2468        ADD CHANNEL        ADD CHANNEL
2469    
2470     This will increment the sampler channel count by one and the new     This will increment the sampler channel count by one and the new
# Line 2457  Internet-Draft        LinuxSampler Contr Line 2492  Internet-Draft        LinuxSampler Contr
2492           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2493           code and warning message           code and warning message
2494    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 44]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2495        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2496    
2497           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2474  Internet-Draft        LinuxSampler Contr Line 2501  Internet-Draft        LinuxSampler Contr
2501    
2502    
2503    
2504    6.4.6.  Removing a sampler channel
 6.4.6  Removing a sampler channel  
2505    
2506     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
2507    
# Line 2488  Internet-Draft        LinuxSampler Contr Line 2514  Internet-Draft        LinuxSampler Contr
2514    
2515     Possible Answers:     Possible Answers:
2516    
2517    
2518    
2519    Schoenebeck               Expires June 23, 2007                [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol        December 2006
2522    
2523    
2524        "OK" -        "OK" -
2525    
2526           in case the given sampler channel could be removed           in case the given sampler channel could be removed
# Line 2507  Internet-Draft        LinuxSampler Contr Line 2540  Internet-Draft        LinuxSampler Contr
2540    
2541    
2542    
2543    6.4.7.  Getting amount of available engines
 6.4.7  Getting amount of available engines  
2544    
2545     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
2546     the following command:     the following command:
2547    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 45]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2548        GET AVAILABLE_ENGINES        GET AVAILABLE_ENGINES
2549    
2550     Possible Answers:     Possible Answers:
# Line 2534  Internet-Draft        LinuxSampler Contr Line 2558  Internet-Draft        LinuxSampler Contr
2558    
2559        S: "4"        S: "4"
2560    
2561    6.4.8.  Getting all available engines
 6.4.8  Getting all available engines  
2562    
2563     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
2564     the following command:     the following command:
# Line 2544  Internet-Draft        LinuxSampler Contr Line 2567  Internet-Draft        LinuxSampler Contr
2567    
2568     Possible Answers:     Possible Answers:
2569    
2570    
2571    
2572    
2573    
2574    
2575    Schoenebeck               Expires June 23, 2007                [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol        December 2006
2578    
2579    
2580        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
2581        engines' names encapsulated into apostrophes (').  Engine names        engines' names encapsulated into apostrophes (').  Engine names
2582        can consist of lower and upper cases, digits and underlines ("_"        can consist of lower and upper cases, digits and underlines ("_"
# Line 2555  Internet-Draft        LinuxSampler Contr Line 2588  Internet-Draft        LinuxSampler Contr
2588    
2589        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
2590    
2591    6.4.9.  Getting information about an engine
 6.4.9  Getting information about an engine  
2592    
2593     The front-end can ask for information about a specific engine by     The front-end can ask for information about a specific engine by
2594     sending the following command:     sending the following command:
# Line 2568  Internet-Draft        LinuxSampler Contr Line 2600  Internet-Draft        LinuxSampler Contr
2600    
2601     Possible Answers:     Possible Answers:
2602    
   
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 46]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2603        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2604        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2605        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 2601  Internet-Draft        LinuxSampler Contr Line 2624  Internet-Draft        LinuxSampler Contr
2624    
2625        S: "DESCRIPTION: this is Joe's custom sampler engine"        S: "DESCRIPTION: this is Joe's custom sampler engine"
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck               Expires June 23, 2007                [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol        December 2006
2634    
2635    
2636           "VERSION: testing-1.0"           "VERSION: testing-1.0"
2637    
2638           "."           "."
2639    
2640    6.4.10.  Getting sampler channel information
 6.4.10  Getting sampler channel information  
2641    
2642     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
2643     by sending the following command:     by sending the following command:
# Line 2627  Internet-Draft        LinuxSampler Contr Line 2658  Internet-Draft        LinuxSampler Contr
2658    
2659    
2660    
   
 Schoenebeck             Expires January 22, 2006               [Page 47]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
   
   
2661           ENGINE_NAME -           ENGINE_NAME -
2662    
2663              name of the engine that is associated with the sampler              name of the engine that is associated with the sampler
# Line 2658  Internet-Draft        LinuxSampler Contr Line 2681  Internet-Draft        LinuxSampler Contr
2681              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
2682              of the selected audio output device each sampler output              of the selected audio output device each sampler output
2683              channel is routed to, e.g. "0,3" would mean the engine's              channel is routed to, e.g. "0,3" would mean the engine's
2684    
2685    
2686    
2687    Schoenebeck               Expires June 23, 2007                [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol        December 2006
2690    
2691    
2692              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
2693              device and the engine's output channel 1 is routed to the              device and the engine's output channel 1 is routed to the
2694              channel 3 of the audio output device              channel 3 of the audio output device
# Line 2682  Internet-Draft        LinuxSampler Contr Line 2713  Internet-Draft        LinuxSampler Contr
2713              loading exception.  Value of 100 indicates that the              loading exception.  Value of 100 indicates that the
2714              instrument is fully loaded.              instrument is fully loaded.
2715    
   
   
 Schoenebeck             Expires January 22, 2006               [Page 48]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2716           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2717    
2718              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
# Line 2711  Internet-Draft        LinuxSampler Contr Line 2735  Internet-Draft        LinuxSampler Contr
2735              (where a value < 1.0 means attenuation and a value > 1.0              (where a value < 1.0 means attenuation and a value > 1.0
2736              means amplification)              means amplification)
2737    
2738    
2739    
2740    
2741    
2742    
2743    Schoenebeck               Expires June 23, 2007                [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol        December 2006
2746    
2747    
2748           MUTE -           MUTE -
2749    
2750              Determines whether the channel is muted, "true" if the              Determines whether the channel is muted, "true" if the
# Line 2724  Internet-Draft        LinuxSampler Contr Line 2758  Internet-Draft        LinuxSampler Contr
2758              Determines whether this is a solo channel, "true" if the              Determines whether this is a solo channel, "true" if the
2759              channel is a solo channel; "false" otherwise              channel is a solo channel; "false" otherwise
2760    
2761             MIDI_INSTRUMENT_MAP -
2762    
2763                Determines to which MIDI instrument map this sampler channel
2764                is assigned to.  Read chapter "SET CHANNEL
2765                MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2766                values.
2767    
2768     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2769    
2770     Example:     Example:
# Line 2736  Internet-Draft        LinuxSampler Contr Line 2777  Internet-Draft        LinuxSampler Contr
2777    
2778           "AUDIO_OUTPUT_DEVICE: 0"           "AUDIO_OUTPUT_DEVICE: 0"
2779    
   
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 49]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2780           "AUDIO_OUTPUT_CHANNELS: 2"           "AUDIO_OUTPUT_CHANNELS: 2"
2781    
2782           "AUDIO_OUTPUT_ROUTING: 0,1"           "AUDIO_OUTPUT_ROUTING: 0,1"
# Line 2761  Internet-Draft        LinuxSampler Contr Line 2793  Internet-Draft        LinuxSampler Contr
2793    
2794           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires June 23, 2007                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol        December 2006
2802    
2803    
2804           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2805    
2806           "."           "VOLUME: 1.0"
2807    
2808             "MUTE: false"
2809    
2810             "SOLO: false"
2811    
2812  6.4.11  Current number of active voices           "MIDI_INSTRUMENT_MAP: NONE"
2813    
2814             "."
2815    
2816    6.4.11.  Current number of active voices
2817    
2818     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
2819     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 2786  Internet-Draft        LinuxSampler Contr Line 2833  Internet-Draft        LinuxSampler Contr
2833    
2834    
2835    
2836    6.4.12.  Current number of active disk streams
 6.4.12  Current number of active disk streams  
2837    
2838     The front-end can ask for the current number of active disk streams     The front-end can ask for the current number of active disk streams
2839     on a sampler channel by sending the following command:     on a sampler channel by sending the following command:
2840    
   
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2841        GET CHANNEL STREAM_COUNT <sampler-channel>        GET CHANNEL STREAM_COUNT <sampler-channel>
2842    
2843     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
# Line 2812  Internet-Draft        LinuxSampler Contr Line 2849  Internet-Draft        LinuxSampler Contr
2849        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
2850        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
2851        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
2852    
2853    
2854    
2855    Schoenebeck               Expires June 23, 2007                [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol        December 2006
2858    
2859    
2860        return "NA" for not available.        return "NA" for not available.
2861    
2862     Example:     Example:
2863    
2864    
2865    
2866    6.4.13.  Current fill state of disk stream buffers
 6.4.13  Current fill state of disk stream buffers  
2867    
2868     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
2869     on a sampler channel by sending the following command:     on a sampler channel by sending the following command:
# Line 2850  Internet-Draft        LinuxSampler Contr Line 2894  Internet-Draft        LinuxSampler Contr
2894    
2895     Examples:     Examples:
2896    
   
   
 Schoenebeck             Expires January 22, 2006               [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
2897        C: "GET CHANNEL BUFFER_FILL BYTES 4"        C: "GET CHANNEL BUFFER_FILL BYTES 4"
2898    
2899        S: "[115]420500,[116]510300,[75]110000,[120]230700"        S: "[115]420500,[116]510300,[75]110000,[120]230700"
# Line 2867  Internet-Draft        LinuxSampler Contr Line 2904  Internet-Draft        LinuxSampler Contr
2904    
2905        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2906    
       S: ""  
2907    
2908    
2909  6.4.14  Setting audio output device  
2910    
2911    Schoenebeck               Expires June 23, 2007                [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol        December 2006
2914    
2915    
2916          S: ""
2917    
2918    6.4.14.  Setting audio output device
2919    
2920     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
2921     channel by sending the following command:     channel by sending the following command:
# Line 2906  Internet-Draft        LinuxSampler Contr Line 2951  Internet-Draft        LinuxSampler Contr
2951    
2952    
2953    
2954    6.4.15.  Setting audio output type
   
 Schoenebeck             Expires January 22, 2006               [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
   
   
   
 6.4.15  Setting audio output type  
2955    
2956     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
2957    
# Line 2926  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
2962        type>        type>
2963    
2964    
2965    
2966    
2967    Schoenebeck               Expires June 23, 2007                [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol        December 2006
2970    
2971    
2972     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
2973     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
2974    
# Line 2950  Internet-Draft        LinuxSampler Contr Line 2993  Internet-Draft        LinuxSampler Contr
2993    
2994    
2995    
2996    6.4.16.  Setting audio output channel
 6.4.16  Setting audio output channel  
2997    
2998     The front-end can alter the audio output channel on a specific     The front-end can alter the audio output channel on a specific
2999     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 2961  Internet-Draft        LinuxSampler Contr Line 3003  Internet-Draft        LinuxSampler Contr
3003    
3004     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
3005     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
3006     command, <audio-out> is the numerical ID of the sampler channel's     command, <audio-out> is the numerical ID of the sampler channel's
3007     audio output channel which should be rerouted and <audio-in> is the     audio output channel which should be rerouted and <audio-in> is the
3008     numerical ID of the audio channel of the selected audio output device     numerical ID of the audio channel of the selected audio output device
# Line 2982  Internet-Draft        LinuxSampler Contr Line 3016  Internet-Draft        LinuxSampler Contr
3016    
3017        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck               Expires June 23, 2007                [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol        December 2006
3026    
3027    
3028           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3029           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3030           warning message           warning message
# Line 2995  Internet-Draft        LinuxSampler Contr Line 3038  Internet-Draft        LinuxSampler Contr
3038    
3039    
3040    
3041    6.4.17.  Setting MIDI input device
 6.4.17  Setting MIDI input device  
3042    
3043     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
3044     channel by sending the following command:     channel by sending the following command:
# Line 3005  Internet-Draft        LinuxSampler Contr Line 3047  Internet-Draft        LinuxSampler Contr
3047    
3048     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
3049     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)
3050     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
3051     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)
3052     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3053    
# Line 3015  Internet-Draft        LinuxSampler Contr Line 3057  Internet-Draft        LinuxSampler Contr
3057    
3058           on success           on success
3059    
   
   
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
3060        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3061    
3062           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
# Line 3041  Internet-Draft        LinuxSampler Contr Line 3073  Internet-Draft        LinuxSampler Contr
3073    
3074    
3075    
3076  6.4.18  Setting MIDI input type  
3077    
3078    
3079    Schoenebeck               Expires June 23, 2007                [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol        December 2006
3082    
3083    
3084    6.4.18.  Setting MIDI input type
3085    
3086     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3087    
# Line 3074  Internet-Draft        LinuxSampler Contr Line 3114  Internet-Draft        LinuxSampler Contr
3114    
3115    
3116    
3117    6.4.19.  Setting MIDI input port
   
 Schoenebeck             Expires January 22, 2006               [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
   
   
   
 6.4.19  Setting MIDI input port  
3118    
3119     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
3120     channel by sending the following command:     channel by sending the following command:
# Line 3098  Internet-Draft        LinuxSampler Contr Line 3128  Internet-Draft        LinuxSampler Contr
3128    
3129        "OK" -        "OK" -
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck               Expires June 23, 2007                [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol        December 2006
3138    
3139    
3140           on success           on success
3141    
3142        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3115  Internet-Draft        LinuxSampler Contr Line 3154  Internet-Draft        LinuxSampler Contr
3154    
3155    
3156    
3157    6.4.20.  Setting MIDI input channel
 6.4.20  Setting MIDI input channel  
3158    
3159     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3160     listen to by sending the following command:     listen to by sending the following command:
# Line 3129  Internet-Draft        LinuxSampler Contr Line 3167  Internet-Draft        LinuxSampler Contr
3167    
3168     Possible Answers:     Possible Answers:
3169    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
3170        "OK" -        "OK" -
3171    
3172           on success           on success
# Line 3157  Internet-Draft        LinuxSampler Contr Line 3187  Internet-Draft        LinuxSampler Contr
3187    
3188    
3189    
3190  6.4.21  Setting channel volume  
3191    Schoenebeck               Expires June 23, 2007                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol        December 2006
3194    
3195    
3196    
3197    
3198    6.4.21.  Setting channel volume
3199    
3200     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
3201     the following command:     the following command:
# Line 3186  Internet-Draft        LinuxSampler Contr Line 3224  Internet-Draft        LinuxSampler Contr
3224           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3225           error message           error message
3226    
   
   
 Schoenebeck             Expires January 22, 2006               [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
3227     Examples:     Examples:
3228    
3229    
3230    
3231    6.4.22.  Muting a sampler channel
 6.4.22  Muting a sampler channel  
3232    
3233     The front-end can mute/unmute a specific sampler channel by sending     The front-end can mute/unmute a specific sampler channel by sending
3234     the following command:     the following command:
# Line 3212  Internet-Draft        LinuxSampler Contr Line 3242  Internet-Draft        LinuxSampler Contr
3242    
3243     Possible Answers:     Possible Answers:
3244    
3245    
3246    
3247    Schoenebeck               Expires June 23, 2007                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol        December 2006
3250    
3251    
3252        "OK" -        "OK" -
3253    
3254           on success           on success
# Line 3231  Internet-Draft        LinuxSampler Contr Line 3268  Internet-Draft        LinuxSampler Contr
3268    
3269    
3270    
3271    6.4.23.  Soloing a sampler channel
 6.4.23  Soloing a sampler channel  
3272    
3273     The front-end can solo/unsolo a specific sampler channel by sending     The front-end can solo/unsolo a specific sampler channel by sending
3274     the following command:     the following command:
# Line 3241  Internet-Draft        LinuxSampler Contr Line 3277  Internet-Draft        LinuxSampler Contr
3277    
3278     Where <sampler-channel> is the respective sampler channel number as     Where <sampler-channel> is the respective sampler channel number as
3279     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 58]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
3280     (Section 6.4.4) command and <solo> should be replaced either by "1"     (Section 6.4.4) command and <solo> should be replaced either by "1"
3281     to solo the channel or "0" to unsolo the channel.     to solo the channel or "0" to unsolo the channel.
3282    
# Line 3269  Internet-Draft        LinuxSampler Contr Line 3297  Internet-Draft        LinuxSampler Contr
3297           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3298           error message           error message
3299    
3300    
3301    
3302    
3303    Schoenebeck               Expires June 23, 2007                [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol        December 2006
3306    
3307    
3308     Examples:     Examples:
3309    
3310    
3311    
3312    6.4.24.  Assigning a MIDI instrument map to a sampler channel
3313    
3314       The front-end can assign a MIDI instrument map to a specific sampler
3315       channel by sending the following command:
3316    
3317          SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3318    
3319       Where <sampler-channel> is the respective sampler channel number as
3320       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3321       (Section 6.4.4) command and <map> can have the following
3322       possibilites:
3323    
3324  6.4.24  Resetting a sampler channel        "NONE" -
3325    
3326             This is the default setting.  In this case the sampler channel
3327             is not assigned any MIDI instrument map and thus will ignore
3328             all MIDI program change messages.
3329    
3330          "DEFAULT" -
3331    
3332             The sampler channel will always use the default MIDI instrument
3333             map to handle MIDI program change messages.
3334    
3335          numeric ID -
3336    
3337             You can assign a specific MIDI instrument map by replacing
3338             <map> with the respective numeric ID of the MIDI instrument map
3339             as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3340             command.  Once that map will be deleted, the sampler channel
3341             would fall back to "NONE".
3342    
3343       Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3344       regarding MIDI instrument mapping.
3345    
3346       Possible Answers:
3347    
3348          "OK" -
3349    
3350             on success
3351    
3352          "ERR:<error-code>:<error-message>" -
3353    
3354             in case it failed, providing an appropriate error code and
3355             error message
3356    
3357    
3358    
3359    Schoenebeck               Expires June 23, 2007                [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol        December 2006
3362    
3363    
3364       Examples:
3365    
3366    
3367    
3368    6.4.25.  Resetting a sampler channel
3369    
3370     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3371     following command:     following command:
# Line 3298  Internet-Draft        LinuxSampler Contr Line 3389  Internet-Draft        LinuxSampler Contr
3389           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3390           message           message
3391    
   
   
 Schoenebeck             Expires January 22, 2006               [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
3392        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3393    
3394           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 3398  Internet-Draft        LinuxSampler Contr
3398    
3399    
3400    
3401    6.5.  Controlling connection
 6.5  Controlling connection  
3402    
3403     The following commands are used to control the connection to     The following commands are used to control the connection to
3404     LinuxSampler.     LinuxSampler.
3405    
3406  6.5.1  Register front-end for receiving event messages  6.5.1.  Register front-end for receiving event messages
3407    
3408     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3409     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires June 23, 2007                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol        December 2006
3418    
3419    
3420        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3421    
3422     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 3443  Internet-Draft        LinuxSampler Contr
3443    
3444    
3445    
3446    6.5.2.  Unregister front-end for not receiving event messages
   
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
 6.5.2  Unregister front-end for not receiving event messages  
3447    
3448     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
3449     event messages anymore by sending the following command:     event messages anymore by sending the following command:
# Line 3383  Internet-Draft        LinuxSampler Contr Line 3465  Internet-Draft        LinuxSampler Contr
3465           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3466           message           message
3467    
3468    
3469    
3470    
3471    Schoenebeck               Expires June 23, 2007                [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol        December 2006
3474    
3475    
3476        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3477    
3478           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 3482  Internet-Draft        LinuxSampler Contr
3482    
3483    
3484    
3485    6.5.3.  Enable or disable echo of commands
 6.5.3  Enable or disable echo of commands  
3486    
3487     To enable or disable back sending of commands to the client the     To enable or disable back sending of commands to the client the
3488     following command can be used:     following command can be used:
# Line 3409  Internet-Draft        LinuxSampler Contr Line 3498  Internet-Draft        LinuxSampler Contr
3498    
3499     Possible Answers:     Possible Answers:
3500    
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
3501        "OK" -        "OK" -
3502    
3503           usually           usually
# Line 3429  Internet-Draft        LinuxSampler Contr Line 3510  Internet-Draft        LinuxSampler Contr
3510    
3511    
3512    
3513    6.5.4.  Close client connection
 6.5.4  Close client connection  
3514    
3515     The client can close its network connection to LinuxSampler by     The client can close its network connection to LinuxSampler by
3516     sending the following command:     sending the following command:
# Line 3440  Internet-Draft        LinuxSampler Contr Line 3520  Internet-Draft        LinuxSampler Contr
3520     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
3521     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
3522    
3523  6.6  Global commands  
3524    
3525    
3526    
3527    Schoenebeck               Expires June 23, 2007                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol        December 2006
3530    
3531    
3532    6.6.  Global commands
3533    
3534     The following commands have global impact on the sampler.     The following commands have global impact on the sampler.
3535    
3536  6.6.1  Reset sampler  6.6.1.  Current number of active voices
3537    
3538       The front-end can ask for the current number of active voices on the
3539       sampler by sending the following command:
3540    
3541          GET TOTAL_VOICE_COUNT
3542    
3543       Possible Answers:
3544    
3545          LinuxSampler will answer by returning the number of all active
3546          voices on the sampler.
3547    
3548    6.6.2.  Maximum amount of active voices
3549    
3550       The front-end can ask for the maximum number of active voices by
3551       sending the following command:
3552    
3553          GET TOTAL_VOICE_COUNT_MAX
3554    
3555       Possible Answers:
3556    
3557          LinuxSampler will answer by returning the maximum number of active
3558          voices.
3559    
3560    6.6.3.  Reset sampler
3561    
3562     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
3563     command:     command:
# Line 3462  Internet-Draft        LinuxSampler Contr Line 3575  Internet-Draft        LinuxSampler Contr
3575    
3576    
3577    
 6.6.2  General sampler informations  
3578    
    The client can ask for general informations about the LinuxSampler  
3579    
3580    
3581    
 Schoenebeck             Expires January 22, 2006               [Page 62]  
3582    
3583  Internet-Draft        LinuxSampler Control Protocol            July 2005  Schoenebeck               Expires June 23, 2007                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol        December 2006
3586    
3587    
3588    6.6.4.  General sampler informations
3589    
3590       The client can ask for general informations about the LinuxSampler
3591     instance by sending the following command:     instance by sending the following command:
3592    
3593        GET SERVER INFO        GET SERVER INFO
# Line 3503  Internet-Draft        LinuxSampler Contr Line 3618  Internet-Draft        LinuxSampler Contr
3618     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3619     Other fields might be added in future.     Other fields might be added in future.
3620    
3621    6.7.  MIDI Instrument Mapping
3622    
3623       The MIDI protocol provides a way to switch between instruments by
3624       sending so called MIDI bank select and MIDI program change messages
3625       which are essentially just numbers.  The following commands allow to
3626       actually map arbitrary MIDI bank select / program change numbers with
3627       real instruments.
3628    
3629       The sampler allows to manage an arbitrary amount of MIDI instrument
3630       maps which define which instrument to load on which MIDI program
3631       change message.
3632    
3633       By default, that is when the sampler is launched, there is no map,
3634       thus the sampler will simply ignore all program change messages.  The
3635       front-end has to explicitly create at least one map, add entries to
3636    
3637    
3638    
3639    Schoenebeck               Expires June 23, 2007                [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol        December 2006
3642    
3643    
3644       the map and tell the respective sampler channel(s) which MIDI
3645       instrument map to use, so the sampler knows how to react on a given
3646       program change message on the respective sampler channel, that is by
3647       switching to the respectively defined engine type and loading the
3648       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
3649       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
3650       channel.
3651    
3652       Also note per MIDI specification a bank select message does not cause
3653       to switch to another instrument.  Instead when receiving a bank
3654       select message the bank value will be stored and a subsequent program
3655       change message (which may occur at any time) will finally cause the
3656       sampler to switch to the respective instrument as reflected by the
3657       current MIDI instrument map.
3658    
3659    6.7.1.  Create a new MIDI instrument map
3660    
3661       The front-end can add a new MIDI instrument map by sending the
3662       following command:
3663    
3664          ADD MIDI_INSTRUMENT_MAP [<name>]
3665    
3666       Where <name> is an optional argument allowing to assign a custom name
3667       to the new map.  MIDI instrument Map names do not have to be unique.
3668    
3669       Possible Answers:
3670    
3671          "OK[<map>]" -
3672    
3673             in case a new MIDI instrument map could be added, where <map>
3674             reflects the unique ID of the newly created MIDI instrument map
3675    
3676          "ERR:<error-code>:<error-message>" -
3677    
3678             when a new map could not be created, which might never occur in
3679             practice
3680    
3681       Examples:
3682    
3683          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
3684    
3685          S: "OK[0]"
3686    
3687          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
3688    
3689          S: "OK[1]"
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires June 23, 2007                [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol        December 2006
3698    
3699    
3700          C: "ADD MIDI_INSTRUMENT_MAP"
3701    
3702          S: "OK[5]"
3703    
3704    6.7.2.  Delete one particular or all MIDI instrument maps
3705    
3706       The front-end can delete a particular MIDI instrument map by sending
3707       the following command:
3708    
3709          REMOVE MIDI_INSTRUMENT_MAP <map>
3710    
3711       Where <map> reflects the unique ID of the map to delete as returned
3712       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
3713    
3714       The front-end can delete all MIDI instrument maps by sending the
3715       following command:
3716    
3717          REMOVE MIDI_INSTRUMENT_MAP ALL
3718    
3719       Possible Answers:
3720    
3721          "OK" -
3722    
3723             in case the map(s) could be deleted
3724    
3725          "ERR:<error-code>:<error-message>" -
3726    
3727             when the given map does not exist
3728    
3729       Examples:
3730    
3731          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
3732    
3733          S: "OK"
3734    
3735          C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
3736    
3737          S: "OK"
3738    
3739    6.7.3.  Get amount of existing MIDI instrument maps
3740    
3741       The front-end can retrieve the current amount of MIDI instrument maps
3742       by sending the following command:
3743    
3744          GET MIDI_INSTRUMENT_MAPS
3745    
3746       Possible Answers:
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires June 23, 2007                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol        December 2006
3754    
3755    
3756          The sampler will answer by returning the current number of MIDI
3757          instrument maps.
3758    
3759       Example:
3760    
3761          C: "GET MIDI_INSTRUMENT_MAPS"
3762    
3763          S: "2"
3764    
3765    6.7.4.  Getting all created MIDI instrument maps
3766    
3767       The number of MIDI instrument maps can change on runtime.  To get the
3768       current list of MIDI instrument maps, the front-end can send the
3769       following command:
3770    
3771          LIST MIDI_INSTRUMENT_MAPS
3772    
3773       Possible Answers:
3774    
3775          The sampler will answer by returning a comma separated list with
3776          all MIDI instrument maps' numerical IDs.
3777    
3778       Example:
3779    
3780          C: "LIST MIDI_INSTRUMENT_MAPS"
3781    
3782          S: "0,1,5,12"
3783    
3784    6.7.5.  Getting MIDI instrument map information
3785    
3786       The front-end can ask for the current settings of a MIDI instrument
3787       map by sending the following command:
3788    
3789          GET MIDI_INSTRUMENT_MAP INFO <map>
3790    
3791       Where <map> is the numerical ID of the map the front-end is
3792       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
3793       (Section 6.7.4) command.
3794    
3795       Possible Answers:
3796    
3797          LinuxSampler will answer by sending a <CRLF> separated list.  Each
3798          answer line begins with the settings category name followed by a
3799          colon and then a space character <SP> and finally the info
3800          character string to that setting category.  At the moment the
3801          following categories are defined:
3802    
3803    
3804    
3805    
3806    
3807    Schoenebeck               Expires June 23, 2007                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol        December 2006
3810    
3811    
3812    
3813    
3814             NAME -
3815    
3816                custom name of the given map, which does not have to be
3817                unique
3818    
3819       The mentioned fields above don't have to be in particular order.
3820    
3821       Example:
3822    
3823          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
3824    
3825          S: "NAME: Standard Map"
3826    
3827             "."
3828    
3829    6.7.6.  Renaming a MIDI instrument map
3830    
3831       The front-end can alter the custom name of a MIDI instrument map by
3832       sending the following command:
3833    
3834          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
3835    
3836       Where <map> is the numerical ID of the map and <name> the new custom
3837       name of the map, which does not have to be unique.
3838    
3839       Possible Answers:
3840    
3841          "OK" -
3842    
3843             on success
3844    
3845          "ERR:<error-code>:<error-message>" -
3846    
3847             in case the given map does not exist
3848    
3849       Example:
3850    
3851          C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
3852    
3853          S: "OK"
3854    
3855    6.7.7.  Create or replace a MIDI instrument map entry
3856    
3857       The front-end can create a new or replace an existing entry in a
3858       sampler's MIDI instrument map by sending the following command:
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires June 23, 2007                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol        December 2006
3866    
3867    
3868          MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>
3869          <filename> <instrument_index> <volume_value> [<instr_load_mode>]
3870          [<name>]
3871    
3872       Where <map> is the numeric ID of the map to alter, <midi_bank> is an
3873       integer value between 0..16383 reflecting the MIDI bank select index,
3874       <midi_prog> an integer value between 0..127 reflecting the MIDI
3875       program change index, <engine_name> a sampler engine name as returned
3876       by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
3877       encapsulated into apostrophes), <filename> the name of the
3878       instrument's file to be deployed (encapsulated into apostrophes),
3879       <instrument_index> the index (integer value) of the instrument within
3880       the given file, <volume_value> reflects the master volume of the
3881       instrument as optionally dotted number (where a value < 1.0 means
3882       attenuation and a value > 1.0 means amplification).  This parameter
3883       easily allows to adjust the volume of all intruments within a custom
3884       instrument map without having to adjust their instrument files.  The
3885       OPTIONAL <instr_load_mode> argument defines the life time of the
3886       instrument, that is when the instrument should be loaded, when freed
3887       and has exactly the following possibilities:
3888    
3889          "ON_DEMAND" -
3890    
3891             The instrument will be loaded when needed, that is when
3892             demanded by at least one sampler channel.  It will immediately
3893             be freed from memory when not needed by any sampler channel
3894             anymore.
3895    
3896          "ON_DEMAND_HOLD" -
3897    
3898             The instrument will be loaded when needed, that is when
3899             demanded by at least one sampler channel.  It will be kept in
3900             memory even when not needed by any sampler channel anymore.
3901             Instruments with this mode are only freed when the sampler is
3902             reset or all mapping entries with this mode (and respective
3903             instrument) are explicitly changed to "ON_DEMAND" and no
3904             sampler channel is using the instrument anymore.
3905    
3906          "PERSISTENT" -
3907    
3908             The instrument will immediately be loaded into memory in the
3909             background when this mapping command is sent and the instrument
3910             is kept all the time.  Instruments with this mode are only
3911             freed when the sampler is reset or all mapping entries with
3912             this mode (and respective instrument) are explicitly changed to
3913             "ON_DEMAND" and no sampler channel is using the instrument
3914             anymore.
3915    
3916    
3917    
3918    
3919    Schoenebeck               Expires June 23, 2007                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol        December 2006
3922    
3923    
3924          not supplied -
3925    
3926             In case there is no <instr_load_mode> argument given, it will
3927             be up to the InstrumentManager to decide which mode to use.
3928             Usually it will use "ON_DEMAND" if an entry for the given
3929             instrument does not exist in the InstrumentManager's list yet,
3930             otherwise if an entry already exists, it will simply stick with
3931             the mode currently reflected by the already existing entry,
3932             that is it will not change the mode.
3933    
3934       The <instr_load_mode> argument thus allows to define an appropriate
3935       strategy (low memory consumption vs. fast instrument switching) for
3936       each instrument individually.  Note, the following restrictions apply
3937       to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
3938       supported by the respective sampler engine (which is technically the
3939       case when the engine provides an InstrumentManager for its format).
3940       If this is not the case the argument will automatically fall back to
3941       the default value "ON_DEMAND".  Also the load mode of one instrument
3942       may automatically change the laod mode of other instrument(s), i.e.
3943       because the instruments are part of the same file and the engine does
3944       not allow a way to manage load modes for them individually.  Due to
3945       this, in case the frontend shows the load modes of entries, the
3946       frontend should retrieve the actual mode by i.e. sending "GET
3947       MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
3948       OPTIONAL <name> argument allows to set a custom name (encapsulated
3949       into apostrophes) for the mapping entry, useful for frontends for
3950       displaying an appropriate name for mapped instruments (using "GET
3951       MIDI_INSTRUMENT INFO" (Section 6.7.11)).
3952    
3953       The "MAP MIDI_INSTRUMENT" command will immediately return, thus it
3954       will not block when an instrument is to be loaded due to a
3955       "PERSISTENT" type entry as instruments are loaded in the background.
3956       As a consequence this command may not necessarily return an error
3957       i.e. when the given instrument file does not exist or may turn out to
3958       be corrupt.
3959    
3960       Possible Answers:
3961    
3962          "OK" -
3963    
3964             usually
3965    
3966          "ERR:<error-code>:<error-message>" -
3967    
3968             when the given map or engine does not exist or a value is out
3969             of range
3970    
3971       Examples:
3972    
3973    
3974    
3975    Schoenebeck               Expires June 23, 2007                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol        December 2006
3978    
3979    
3980          C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
3981          0.8 PERSISTENT"
3982    
3983          S: "OK"
3984    
3985          C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
3986          1.0"
3987    
3988          S: "OK"
3989    
3990          C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0
3991          'Normal Piano'"
3992    
3993          S: "OK"
3994    
3995          C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
3996          'Silent Piano'"
3997    
3998          S: "OK"
3999    
4000          C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0
4001          PERSISTENT 'Foo Drumkit'"
4002    
4003          S: "OK"
4004    
4005    6.7.8.  Getting ammount of MIDI instrument map entries
4006    
4007       The front-end can query the amount of currently existing entries in a
4008       MIDI instrument map by sending the following command:
4009    
4010          GET MIDI_INSTRUMENTS <map>
4011    
4012       The front-end can query the amount of currently existing entries in
4013       all MIDI instrument maps by sending the following command:
4014    
4015          GET MIDI_INSTRUMENTS ALL
4016    
4017       Possible Answers:
4018    
4019          The sampler will answer by sending the current number of entries
4020          in the MIDI instrument map(s).
4021    
4022       Example:
4023    
4024          C: "GET MIDI_INSTRUMENTS 0"
4025    
4026          S: "234"
4027    
4028    
4029    
4030    
4031    Schoenebeck               Expires June 23, 2007                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol        December 2006
4034    
4035    
4036          C: "GET MIDI_INSTRUMENTS ALL"
4037    
4038          S: "954"
4039    
4040    6.7.9.  Getting indeces of all entries of a MIDI instrument map
4041    
4042       The front-end can query a list of all currently existing entries in a
4043       certain MIDI instrument map by sending the following command:
4044    
4045          LIST MIDI_INSTRUMENTS <map>
4046    
4047       Where <map> is the numeric ID of the MIDI instrument map.
4048    
4049       The front-end can query a list of all currently existing entries of
4050       all MIDI instrument maps by sending the following command:
4051    
4052          LIST MIDI_INSTRUMENTS ALL
4053    
4054       Possible Answers:
4055    
4056          The sampler will answer by sending a comma separated list of map
4057          ID - MIDI bank - MIDI program triples, where each triple is
4058          encapsulated into curly braces.  The list is returned in one
4059          single line.  Each triple just reflects the key of the respective
4060          map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4061          (Section 6.7.11) command(s) are necessary to retrieve detailed
4062          informations about each entry.
4063    
4064       Example:
4065    
4066          C: "LIST MIDI_INSTRUMENTS 0"
4067    
4068          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4069    
4070    6.7.10.  Remove an entry from the MIDI instrument map
4071    
4072       The front-end can delete an entry from a MIDI instrument map by
4073       sending the following command:
4074    
4075          UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4076    
4077       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4078       is an integer value between 0..16383 reflecting the MIDI bank value
4079       and <midi_prog> an integer value between 0..127 reflecting the MIDI
4080       program value of the map's entrie's key index triple.
4081    
4082       Possible Answers:
4083    
4084    
4085    
4086    
4087    Schoenebeck               Expires June 23, 2007                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol        December 2006
4090    
4091    
4092          "OK" -
4093    
4094             usually
4095    
4096          "ERR:<error-code>:<error-message>" -
4097    
4098             when index out of bounds
4099    
4100       Example:
4101    
4102          C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4103    
4104          S: "OK"
4105    
4106    6.7.11.  Get current settings of MIDI instrument map entry
4107    
4108       The front-end can retrieve the current settings of a certain
4109       instrument map entry by sending the following command:
4110    
4111          GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
4112    
4113       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4114       is an integer value between 0..16383 reflecting the MIDI bank value,
4115       <midi_bank> and <midi_prog> an integer value between 0..127
4116       reflecting the MIDI program value of the map's entrie's key index
4117       triple.
4118    
4119       Possible Answers:
4120    
4121          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4122          answer line begins with the information category name followed by
4123          a colon and then a space character <SP> and finally the info
4124          character string to that info category.  At the moment the
4125          following categories are defined:
4126    
4127          "NAME" -
4128    
4129             Name for this MIDI instrument map entry (if defined).  This
4130             name shall be used by frontends for displaying a name for this
4131             mapped instrument.  It can be set and changed with the "MAP
4132             MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4133             be unique.
4134    
4135          "ENGINE_NAME" -
4136    
4137             Name of the engine to be deployed for this instrument.
4138    
4139    
4140    
4141    
 Schoenebeck             Expires January 22, 2006               [Page 63]  
4142    
4143  Internet-Draft        LinuxSampler Control Protocol            July 2005  Schoenebeck               Expires June 23, 2007                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol        December 2006
4146    
4147    
4148          "INSTRUMENT_FILE" -
4149    
4150             File name of the instrument.
4151    
4152          "INSTRUMENT_NR" -
4153    
4154             Index of the instrument within the file.
4155    
4156          "INSTRUMENT_NAME" -
4157    
4158             Name of the loaded instrument as reflected by its file.  In
4159             contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4160             cannot be changed.
4161    
4162          "LOAD_MODE" -
4163    
4164             Life time of instrument (see "MAP MIDI_INSTRUMENT"
4165             (Section 6.7.7) for details about this setting).
4166    
4167          "VOLUME" -
4168    
4169             master volume of the instrument as optionally dotted number
4170             (where a value < 1.0 means attenuation and a value > 1.0 means
4171             amplification)
4172    
4173          The mentioned fields above don't have to be in particular order.
4174    
4175       Example:
4176    
4177          C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4178    
4179          S: "NAME: Drums for Foo Song"
4180    
4181             "ENGINE_NAME: GigEngine"
4182    
4183             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4184    
4185             "INSTRUMENT_NR: 0"
4186    
4187             "INSTRUMENT_NAME: Joe's Drumkit"
4188    
4189             "LOAD_MODE: PERSISTENT"
4190    
4191             "VOLUME: 1.0"
4192    
4193             "."
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck               Expires June 23, 2007                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol        December 2006
4202    
4203    
4204    6.7.12.  Clear MIDI instrument map
4205    
4206       The front-end can clear a whole MIDI instrument map, that is delete
4207       all its entries by sending the following command:
4208    
4209          CLEAR MIDI_INSTRUMENTS <map>
4210    
4211       Where <map> is the numeric ID of the map to clear.
4212    
4213       The front-end can clear all MIDI instrument maps, that is delete all
4214       entries of all maps by sending the following command:
4215    
4216          CLEAR MIDI_INSTRUMENTS ALL
4217    
4218       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4219       only their entries, thus the map's settings like custom name will be
4220       preservevd.
4221    
4222       Possible Answers:
4223    
4224          "OK" -
4225    
4226             always
4227    
4228       Examples:
4229    
4230          C: "CLEAR MIDI_INSTRUMENTS 0"
4231    
4232          S: "OK"
4233    
4234          C: "CLEAR MIDI_INSTRUMENTS ALL"
4235    
4236          S: "OK"
4237    
4238    
4239    
4240    
4241    
4242    
4243    
4244    
4245    
4246    
4247    
4248    
4249    
4250    
4251    
4252    
4253    
4254    
4255    Schoenebeck               Expires June 23, 2007                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol        December 2006
4258    
4259    
4260  7.  Command Syntax  7.  Command Syntax
# Line 3565  Internet-Draft        LinuxSampler Contr Line 4293  Internet-Draft        LinuxSampler Contr
4293    
4294     command =     command =
4295    
4296        ADD SP CHANNEL        ADD SP add_instruction
4297    
4298          / MAP SP map_instruction
4299    
4300          / UNMAP SP unmap_instruction
4301    
4302        / GET SP get_instruction        / GET SP get_instruction
4303    
# Line 3573  Internet-Draft        LinuxSampler Contr Line 4305  Internet-Draft        LinuxSampler Contr
4305    
4306        / DESTROY SP destroy_instruction        / DESTROY SP destroy_instruction
4307    
       / LIST SP list_instruction  
   
       / LOAD SP load_instruction  
4308    
4309    
4310    
4311    Schoenebeck               Expires June 23, 2007                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol        December 2006
4314    
 Schoenebeck             Expires January 22, 2006               [Page 64]  
4315    
4316  Internet-Draft        LinuxSampler Control Protocol            July 2005        / LIST SP list_instruction
4317    
4318          / LOAD SP load_instruction
4319    
4320        / REMOVE SP CHANNEL SP sampler_channel        / REMOVE SP remove_instruction
4321    
4322        / SET SP set_instruction        / SET SP set_instruction
4323    
# Line 3595  Internet-Draft        LinuxSampler Contr Line 4327  Internet-Draft        LinuxSampler Contr
4327    
4328        / SELECT SP text        / SELECT SP text
4329    
4330        / RESET SP CHANNEL SP sampler_channel        / RESET SP reset_instruction
4331    
4332          / CLEAR SP clear_instruction
4333    
4334        / RESET        / RESET
4335    
4336        / QUIT        / QUIT
4337    
4338       add_instruction =
4339    
4340          CHANNEL
4341    
4342          / MIDI_INSTRUMENT_MAP
4343    
4344          / MIDI_INSTRUMENT_MAP SP map_name
4345    
4346     subscribe_event =     subscribe_event =
4347    
4348        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4349    
4350          / AUDIO_OUTPUT_DEVICE_INFO
4351    
4352          / MIDI_INPUT_DEVICE_COUNT
4353    
4354          / MIDI_INPUT_DEVICE_INFO
4355    
4356          / CHANNEL_COUNT
4357    
4358        / VOICE_COUNT        / VOICE_COUNT
4359    
# Line 3611  Internet-Draft        LinuxSampler Contr Line 4361  Internet-Draft        LinuxSampler Contr
4361    
4362        / BUFFER_FILL        / BUFFER_FILL
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires June 23, 2007                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol        December 2006
4370    
4371    
4372        / CHANNEL_INFO        / CHANNEL_INFO
4373    
4374          / MIDI_INSTRUMENT_MAP_COUNT
4375    
4376          / MIDI_INSTRUMENT_MAP_INFO
4377    
4378          / MIDI_INSTRUMENT_COUNT
4379    
4380          / MIDI_INSTRUMENT_INFO
4381    
4382        / MISCELLANEOUS        / MISCELLANEOUS
4383    
4384          / TOTAL_VOICE_COUNT
4385    
4386     unsubscribe_event =     unsubscribe_event =
4387    
4388        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4389    
4390          / AUDIO_OUTPUT_DEVICE_INFO
4391    
4392          / MIDI_INPUT_DEVICE_COUNT
4393    
4394          / MIDI_INPUT_DEVICE_INFO
4395    
4396          / CHANNEL_COUNT
4397    
4398        / VOICE_COUNT        / VOICE_COUNT
4399    
# Line 3627  Internet-Draft        LinuxSampler Contr Line 4403  Internet-Draft        LinuxSampler Contr
4403    
4404        / CHANNEL_INFO        / CHANNEL_INFO
4405    
4406          / MIDI_INSTRUMENT_MAP_COUNT
4407    
4408          / MIDI_INSTRUMENT_MAP_INFO
4409    
4410          / MIDI_INSTRUMENT_COUNT
4411    
4412          / MIDI_INSTRUMENT_INFO
4413    
4414        / MISCELLANEOUS        / MISCELLANEOUS
4415    
4416     get_instruction =        / TOTAL_VOICE_COUNT
4417    
4418       map_instruction =
4419    
4420    
4421    
4422    
4423    Schoenebeck               Expires June 23, 2007                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol        December 2006
4426    
       AVAILABLE_ENGINES  
4427    
4428          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4429          engine_name SP filename SP instrument_index SP volume_value
4430    
4431          / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4432          engine_name SP filename SP instrument_index SP volume_value SP
4433          instr_load_mode
4434    
4435          / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4436          engine_name SP filename SP instrument_index SP volume_value SP
4437          entry_name
4438    
4439  Schoenebeck             Expires January 22, 2006               [Page 65]        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4440          engine_name SP filename SP instrument_index SP volume_value SP
4441          instr_load_mode SP entry_name
4442    
4443  Internet-Draft        LinuxSampler Control Protocol            July 2005     unmap_instruction =
4444    
4445          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
4446    
4447       remove_instruction =
4448    
4449          CHANNEL SP sampler_channel
4450    
4451          / MIDI_INSTRUMENT_MAP SP midi_map
4452    
4453          / MIDI_INSTRUMENT_MAP SP ALL
4454    
4455       get_instruction =
4456    
4457          AVAILABLE_ENGINES
4458    
4459        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
4460    
# Line 3659  Internet-Draft        LinuxSampler Contr Line 4474  Internet-Draft        LinuxSampler Contr
4474        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
4475        key_val_list        key_val_list
4476    
4477    
4478    
4479    Schoenebeck               Expires June 23, 2007                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol        December 2006
4482    
4483    
4484        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
4485    
4486        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 3688  Internet-Draft        LinuxSampler Contr Line 4510  Internet-Draft        LinuxSampler Contr
4510    
4511        / ENGINE SP INFO SP engine_name        / ENGINE SP INFO SP engine_name
4512    
4513          / SERVER SP INFO
4514    
4515          / TOTAL_VOICE_COUNT
4516    
4517          / TOTAL_VOICE_COUNT_MAX
4518    
4519          / MIDI_INSTRUMENTS SP midi_map
4520    
4521  Schoenebeck             Expires January 22, 2006               [Page 66]        / MIDI_INSTRUMENTS SP ALL
4522    
4523  Internet-Draft        LinuxSampler Control Protocol            July 2005        / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
4524    
4525          / MIDI_INSTRUMENT_MAPS
4526    
4527        / SERVER SP INFO        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
4528    
4529     set_instruction =     set_instruction =
4530    
4531    
4532    
4533    
4534    
4535    Schoenebeck               Expires June 23, 2007                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol        December 2006
4538    
4539    
4540        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
4541        param_val_list        param_val_list
4542    
# Line 3715  Internet-Draft        LinuxSampler Contr Line 4551  Internet-Draft        LinuxSampler Contr
4551    
4552        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
4553    
4554          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
4555    
4556        / ECHO SP boolean        / ECHO SP boolean
4557    
4558     create_instruction =     create_instruction =
# Line 3727  Internet-Draft        LinuxSampler Contr Line 4565  Internet-Draft        LinuxSampler Contr
4565    
4566        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
4567    
4568       reset_instruction =
4569    
4570          CHANNEL SP sampler_channel
4571    
4572       clear_instruction =
4573    
4574          MIDI_INSTRUMENTS SP midi_map
4575    
4576          / MIDI_INSTRUMENTS SP ALL
4577    
4578     destroy_instruction =     destroy_instruction =
4579    
4580        AUDIO_OUTPUT_DEVICE SP number        AUDIO_OUTPUT_DEVICE SP number
# Line 3737  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585    
4586        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
4587    
       / ENGINE SP load_engine_args  
4588    
    set_chan_instruction =  
4589    
       AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index  
4590    
4591        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index  Schoenebeck               Expires June 23, 2007                [Page 82]
4592        SP audio_channel_index  
4593    Internet-Draft        LinuxSampler Control Protocol        December 2006
4594    
4595    
4596          / ENGINE SP load_engine_args
4597    
4598  Schoenebeck             Expires January 22, 2006               [Page 67]     set_chan_instruction =
4599    
4600  Internet-Draft        LinuxSampler Control Protocol            July 2005        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
4601    
4602          / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
4603          SP audio_channel_index
4604    
4605        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
4606    
# Line 3773  Internet-Draft        LinuxSampler Contr Line 4622  Internet-Draft        LinuxSampler Contr
4622    
4623        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
4624    
4625          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
4626    
4627          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
4628    
4629          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
4630    
4631     key_val_list =     key_val_list =
4632    
4633        string '=' param_val_list        string '=' param_val_list
# Line 3787  Internet-Draft        LinuxSampler Contr Line 4642  Internet-Draft        LinuxSampler Contr
4642    
4643     list_instruction =     list_instruction =
4644    
4645    
4646    
4647    Schoenebeck               Expires June 23, 2007                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol        December 2006
4650    
4651    
4652        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
4653    
4654        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 3799  Internet-Draft        LinuxSampler Contr Line 4661  Internet-Draft        LinuxSampler Contr
4661    
4662        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
4663    
4664     load_instr_args =        / MIDI_INSTRUMENTS SP midi_map
   
   
4665    
4666          / MIDI_INSTRUMENTS SP ALL
4667    
4668  Schoenebeck             Expires January 22, 2006               [Page 68]        / MIDI_INSTRUMENT_MAPS
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
4669    
4670       load_instr_args =
4671    
4672        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
4673    
# Line 3817  Internet-Draft        LinuxSampler Contr Line 4677  Internet-Draft        LinuxSampler Contr
4677    
4678        engine_name SP sampler_channel        engine_name SP sampler_channel
4679    
4680       instr_load_mode =
4681    
4682          ON_DEMAND
4683    
4684          / ON_DEMAND_HOLD
4685    
4686          / PERSISTENT
4687    
4688     device_index =     device_index =
4689    
4690        number        number
# Line 3829  Internet-Draft        LinuxSampler Contr Line 4697  Internet-Draft        LinuxSampler Contr
4697    
4698        string        string
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires June 23, 2007                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol        December 2006
4706    
4707    
4708     midi_input_port_index =     midi_input_port_index =
4709    
4710        number        number
# Line 3843  Internet-Draft        LinuxSampler Contr Line 4719  Internet-Draft        LinuxSampler Contr
4719    
4720        string        string
4721    
4722       midi_map =
4723    
4724          number
4725    
4726       midi_bank =
4727    
4728          number
4729    
4730       midi_prog =
4731    
4732          number
4733    
4734     volume_value =     volume_value =
4735    
4736        dotnum        dotnum
# Line 3857  Internet-Draft        LinuxSampler Contr Line 4745  Internet-Draft        LinuxSampler Contr
4745    
4746        number        number
4747    
4748       engine_name =
4749    
4750          string
4751    
4752       filename =
4753    
4754  Schoenebeck             Expires January 22, 2006               [Page 69]        stringval
4755    
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
4756    
4757    
    engine_name =  
4758    
4759        string  Schoenebeck               Expires June 23, 2007                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol        December 2006
4762    
4763     filename =  
4764       map_name =
4765    
4766          stringval
4767    
4768       entry_name =
4769    
4770        stringval        stringval
4771    
# Line 3883  Internet-Draft        LinuxSampler Contr Line 4779  Internet-Draft        LinuxSampler Contr
4779    
4780        string        string
4781    
4782        / '\'' string '\''        / stringval
   
       / '\"' string '\"'  
4783    
4784        / number        / number
4785    
# Line 3916  Internet-Draft        LinuxSampler Contr Line 4810  Internet-Draft        LinuxSampler Contr
4810    
4811    
4812    
 Schoenebeck             Expires January 22, 2006               [Page 70]  
4813    
4814  Internet-Draft        LinuxSampler Control Protocol            July 2005  
4815    Schoenebeck               Expires June 23, 2007                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol        December 2006
4818    
4819    
4820  8.  Events  8.  Events
# Line 3926  Internet-Draft        LinuxSampler Contr Line 4822  Internet-Draft        LinuxSampler Contr
4822     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
4823     LinuxSampler.     LinuxSampler.
4824    
4825  8.1  Number of sampler channels changed  8.1.  Number of audio output devices changed
4826    
4827       Client may want to be notified when the total number of audio output
4828       devices on the back-end changes by issuing the following command:
4829    
4830          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
4831    
4832       Server will start sending the following notification messages:
4833    
4834          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
4835    
4836       where <devices> will be replaced by the new number of audio output
4837       devices.
4838    
4839    8.2.  Audio output device's settings changed
4840    
4841       Client may want to be notified when changes were made to audio output
4842       devices on the back-end by issuing the following command:
4843    
4844          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
4845    
4846       Server will start sending the following notification messages:
4847    
4848          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
4849    
4850       where <device-id> will be replaced by the numerical ID of the audio
4851       output device, which settings has been changed.  The front-end will
4852       have to send the respective command to actually get the audio output
4853       device info.  Because these messages will be triggered by LSCP
4854       commands issued by other clients rather than real time events
4855       happening on the server, it is believed that an empty notification
4856       message is sufficient here.
4857    
4858    8.3.  Number of MIDI input devices changed
4859    
4860       Client may want to be notified when the total number of MIDI input
4861       devices on the back-end changes by issuing the following command:
4862    
4863          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
4864    
4865       Server will start sending the following notification messages:
4866    
4867    
4868    
4869    
4870    
4871    Schoenebeck               Expires June 23, 2007                [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol        December 2006
4874    
4875    
4876          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
4877    
4878       where <devices> will be replaced by the new number of MIDI input
4879       devices.
4880    
4881    8.4.  MIDI input device's settings changed
4882    
4883       Client may want to be notified when changes were made to MIDI input
4884       devices on the back-end by issuing the following command:
4885    
4886          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
4887    
4888       Server will start sending the following notification messages:
4889    
4890          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
4891    
4892       where <device-id> will be replaced by the numerical ID of the MIDI
4893       input device, which settings has been changed.  The front-end will
4894       have to send the respective command to actually get the MIDI input
4895       device info.  Because these messages will be triggered by LSCP
4896       commands issued by other clients rather than real time events
4897       happening on the server, it is believed that an empty notification
4898       message is sufficient here.
4899    
4900    8.5.  Number of sampler channels changed
4901    
4902     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
4903     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 4911  Internet-Draft        LinuxSampler Contr
4911     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
4912     channels.     channels.
4913    
4914  8.2  Number of active voices changed  8.6.  Number of active voices changed
4915    
4916     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-
4917     end changes by issuing the following command:     end changes by issuing the following command:
# Line 3949  Internet-Draft        LinuxSampler Contr Line 4920  Internet-Draft        LinuxSampler Contr
4920    
4921     Server will start sending the following notification messages:     Server will start sending the following notification messages:
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires June 23, 2007                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol        December 2006
4930    
4931    
4932        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>
4933    
4934     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
4935     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
4936     voices on that channel.     voices on that channel.
4937    
4938  8.3  Number of active disk streams changed  8.7.  Number of active disk streams changed
4939    
4940     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
4941     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 4949  Internet-Draft        LinuxSampler Contr
4949    
4950     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
4951     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck             Expires January 22, 2006               [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
   
   
4952     active disk streams on that channel.     active disk streams on that channel.
4953    
4954  8.4  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
4955    
4956     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
4957     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 4968  Internet-Draft        LinuxSampler Contr
4968     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
4969     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
4970    
4971  8.5  Channel information changed  8.9.  Channel information changed
4972    
4973     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
4974     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 4977  Internet-Draft        LinuxSampler Contr
4977    
4978     Server will start sending the following notification messages:     Server will start sending the following notification messages:
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires June 23, 2007                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol        December 2006
4986    
4987    
4988        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
4989    
4990     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 4994  Internet-Draft        LinuxSampler Contr
4994     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
4995     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
4996    
4997  8.6  Miscellaneous and debugging events  8.10.  Total number of active voices changed
4998    
4999     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified when the total number of voices on the
5000     occurring at the server by issuing the following command:     back-end changes by issuing the following command:
5001    
5002        SUBSCRIBE MISCELLANEOUS        SUBSCRIBE TOTAL_VOICE_COUNT
5003    
5004     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5005    
5006          "NOTIFY:TOTAL_VOICE_COUNT:<voices>
5007    
5008       where <voices> will be replaced by the new number of all currently
5009       active voices.
5010    
5011    8.11.  Number of MIDI instrument maps changed
5012    
5013       Client may want to be notified when the number of MIDI instrument
5014       maps on the back-end changes by issuing the following command:
5015    
5016          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
5017    
5018  Schoenebeck             Expires January 22, 2006               [Page 72]     Server will start sending the following notification messages:
5019    
5020  Internet-Draft        LinuxSampler Control Protocol            July 2005        "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
5021    
5022       where <maps> will be replaced by the new number of MIDI instrument
5023       maps.
5024    
5025        "NOTIFY:MISCELLANEOUS:<string>"  8.12.  MIDI instrument map information changed
5026    
5027     where <string> will be replaced by whatever data server wants to send     Client may want to be notified when changes were made to MIDI
5028     to the client.  Client MAY display this data to the user AS IS to     instrument maps on the back-end by issuing the following command:
    facilitate debugging.  
5029    
5030          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
5031    
5032       Server will start sending the following notification messages:
5033    
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires June 23, 2007                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol        December 2006
5042    
5043    
5044          "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
5045    
5046       where <map-id> will be replaced by the numerical ID of the MIDI
5047       instrument map, for which information changes occurred.  The front-
5048       end will have to send the respective command to actually get the MIDI
5049       instrument map info.  Because these messages will be triggered by
5050       LSCP commands issued by other clients rather than real time events
5051       happening on the server, it is believed that an empty notification
5052       message is sufficient here.
5053    
5054    8.13.  Number of MIDI instruments changed
5055    
5056       Client may want to be notified when the number of MIDI instrument
5057       maps on the back-end changes by issuing the following command:
5058    
5059          SUBSCRIBE MIDI_INSTRUMENT_COUNT
5060    
5061       Server will start sending the following notification messages:
5062    
5063          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
5064    
5065       where <map-id> is the numerical ID of the MIDI instrument map, in
5066       which the nuber of instruments has changed and <instruments> will be
5067       replaced by the new number of MIDI instruments in the specified map.
5068    
5069    8.14.  MIDI instrument information changed
5070    
5071       Client may want to be notified when changes were made to MIDI
5072       instruments on the back-end by issuing the following command:
5073    
5074          SUBSCRIBE MIDI_INSTRUMENT_INFO
5075    
5076       Server will start sending the following notification messages:
5077    
5078          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
5079    
5080       where <map-id> will be replaced by the numerical ID of the MIDI
5081       instrument map, in which a MIDI instrument is changed. <bank> and
5082       <program> specifies the location of the changed MIDI instrument in
5083       the map.  The front-end will have to send the respective command to
5084       actually get the MIDI instrument info.  Because these messages will
5085       be triggered by LSCP commands issued by other clients rather than
5086       real time events happening on the server, it is believed that an
5087       empty notification message is sufficient here.
5088    
5089    
5090    
# Line 4068  Internet-Draft        LinuxSampler Contr Line 5092  Internet-Draft        LinuxSampler Contr
5092    
5093    
5094    
5095    Schoenebeck               Expires June 23, 2007                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol        December 2006
5098    
5099    
5100    8.15.  Miscellaneous and debugging events
5101    
5102       Client may want to be notified of miscellaneous and debugging events
5103       occurring at the server by issuing the following command:
5104    
5105          SUBSCRIBE MISCELLANEOUS
5106    
5107       Server will start sending the following notification messages:
5108    
5109          "NOTIFY:MISCELLANEOUS:<string>"
5110    
5111       where <string> will be replaced by whatever data server wants to send
5112       to the client.  Client MAY display this data to the user AS IS to
5113       facilitate debugging.
5114    
5115    
5116    
# Line 4084  Internet-Draft        LinuxSampler Contr Line 5122  Internet-Draft        LinuxSampler Contr
5122    
5123    
5124    
 Schoenebeck             Expires January 22, 2006               [Page 73]  
5125    
5126  Internet-Draft        LinuxSampler Control Protocol            July 2005  
5127    
5128    
5129    
5130    
5131    
5132    
5133    
5134    
5135    
5136    
5137    
5138    
5139    
5140    
5141    
5142    
5143    
5144    
5145    
5146    
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires June 23, 2007                [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol        December 2006
5154    
5155    
5156  9.  Security Considerations  9.  Security Considerations
# Line 4140  Internet-Draft        LinuxSampler Contr Line 5204  Internet-Draft        LinuxSampler Contr
5204    
5205    
5206    
5207  Schoenebeck             Expires January 22, 2006               [Page 74]  Schoenebeck               Expires June 23, 2007                [Page 93]
5208    
5209  Internet-Draft        LinuxSampler Control Protocol            July 2005  Internet-Draft        LinuxSampler Control Protocol        December 2006
5210    
5211    
5212  10.  Acknowledgments  10.  Acknowledgments
# Line 4160  Internet-Draft        LinuxSampler Contr Line 5224  Internet-Draft        LinuxSampler Contr
5224        Grigor Iliev        Grigor Iliev
5225    
5226    
5227    
5228    
5229    
5230    
5231    
5232    
5233    
5234    
5235    
5236    
5237    
5238    
5239    
5240    
5241    
5242    
5243    
5244    
5245    
5246    
5247    
5248    
5249    
5250    
5251    
5252    
5253    
5254    
5255    
5256    
5257    
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires June 23, 2007                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol        December 2006
5266    
5267    
5268  11.  References  11.  References
5269    
5270     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
# Line 4172  Internet-Draft        LinuxSampler Contr Line 5277  Internet-Draft        LinuxSampler Contr
5277                CONTROL PROTOCOL", RFC 793, 1981.                CONTROL PROTOCOL", RFC 793, 1981.
5278    
5279    
 Author's Address  
5280    
    C. Schoenebeck  
    Interessengemeinschaft Software Engineering e. V.  
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
5281    
    Email: schoenebeck at software minus engineering dot org  
5282    
5283    
5284    
# Line 4196  Author's Address Line 5294  Author's Address
5294    
5295    
5296    
 Schoenebeck             Expires January 22, 2006               [Page 75]  
5297    
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
5298    
5299    
 Intellectual Property Statement  
5300    
    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.  
5301    
    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.  
5302    
5303    
 Full Copyright Statement  
5304    
    Copyright (C) The Internet Society (2005).  All Rights Reserved.  
5305    
    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.  
5306    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
5307    
    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  
5308    
5309    
5310    
 Schoenebeck             Expires January 22, 2006               [Page 76]  
5311    
 Internet-Draft        LinuxSampler Control Protocol            July 2005  
5312    
5313    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
5314    
5315    
 Acknowledgment  
5316    
5317     Funding for the RFC Editor function is currently provided by the  
5318     Internet Society.  
5319    Schoenebeck               Expires June 23, 2007                [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol        December 2006
5322    
5323    
5324    Author's Address
5325    
5326       C. Schoenebeck
5327       Interessengemeinschaft Software Engineering e. V.
5328       Max-Planck-Str. 39
5329       74081 Heilbronn
5330       Germany
5331    
5332       Email: schoenebeck at software minus engineering dot org
5333    
5334    
5335    
5336    
5337    
5338    
# Line 4304  Acknowledgment Line 5372  Acknowledgment
5372    
5373    
5374    
5375    Schoenebeck               Expires June 23, 2007                [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol        December 2006
5378    
5379    
5380    Full Copyright Statement
5381    
5382       Copyright (C) The Internet Society (2006).
5383    
5384       This document is subject to the rights, licenses and restrictions
5385       contained in BCP 78, and except as set forth therein, the authors
5386       retain all their rights.
5387    
5388       This document and the information contained herein are provided on an
5389       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
5390       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
5391       ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
5392       INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
5393       INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
5394       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
5395    
5396    
5397    Intellectual Property
5398    
5399       The IETF takes no position regarding the validity or scope of any
5400       Intellectual Property Rights or other rights that might be claimed to
5401       pertain to the implementation or use of the technology described in
5402       this document or the extent to which any license under such rights
5403       might or might not be available; nor does it represent that it has
5404       made any independent effort to identify any such rights.  Information
5405       on the procedures with respect to rights in RFC documents can be
5406       found in BCP 78 and BCP 79.
5407    
5408       Copies of IPR disclosures made to the IETF Secretariat and any
5409       assurances of licenses to be made available, or the result of an
5410       attempt made to obtain a general license or permission for the use of
5411       such proprietary rights by implementers or users of this
5412       specification can be obtained from the IETF on-line IPR repository at
5413       http://www.ietf.org/ipr.
5414    
5415       The IETF invites any interested party to bring to its attention any
5416       copyrights, patents or patent applications, or other proprietary
5417       rights that may cover technology that may be required to implement
5418       this standard.  Please address the information to the IETF at
5419       ietf-ipr@ietf.org.
5420    
5421    
5422    Acknowledgment
5423    
5424       Funding for the RFC Editor function is provided by the IETF
5425       Administrative Support Activity (IASA).
5426    
5427    
5428    
5429    
 Schoenebeck             Expires January 22, 2006               [Page 77]  
5430    
5431    Schoenebeck               Expires June 23, 2007                [Page 97]
5432    
Legend:
Removed from v.709  
changed lines
  Added in v.993
  ViewVC Help
Powered by ViewVC