/[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 940 by schoenebeck, Sat Nov 25 17:18:12 2006 UTC revision 1002 by schoenebeck, Wed Dec 27 16:23:46 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: May 29, 2007                                  Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                         November 25, 2006  Expires: June 30, 2007                                 December 27, 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 May 29, 2007.     This Internet-Draft will expire on June 30, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2006).  All Rights Reserved.     Copyright (C) The Internet Society (2006).
41    
42    
43    
44    
45    
 Abstract  
46    
    The LinuxSampler Control Protocol (LSCP) is an application-level  
    protocol primarily intended for local and remote controlling the  
    LinuxSampler backend application, which is a sophisticated server-  
    like console application essentially playing back audio samples and  
    manipulating the samples in real time to certain extent.  
47    
48    
49    
# Line 52  Abstract Line 52  Abstract
52    
53    
54    
55  Schoenebeck               Expires May 29, 2007                  [Page 1]  Schoenebeck               Expires June 30, 2007                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
58    
59    
60    Abstract
61    
62       The LinuxSampler Control Protocol (LSCP) is an application-level
63       protocol primarily intended for local and remote controlling the
64       LinuxSampler backend application, which is a sophisticated server-
65       like console application essentially playing back audio samples and
66       manipulating the samples in real time to certain extent.
67    
68    
69  Table of Contents  Table of Contents
70    
71     1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  4     1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5
72     2.  Versioning of this specification . . . . . . . . . . . . . . .  5     2.  Versioning of this specification  . . . . . . . . . . . . . .   6
73     3.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  6     3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7
74     4.  Focus of this protocol . . . . . . . . . . . . . . . . . . . .  7     4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8
75     5.  Communication Overview . . . . . . . . . . . . . . . . . . . .  8     5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9
76       5.1.  Request/response communication method  . . . . . . . . . .  8       5.1.  Request/response communication method . . . . . . . . . .   9
77         5.1.1.  Result format  . . . . . . . . . . . . . . . . . . . .  9         5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10
78       5.2.  Subscribe/notify communication method  . . . . . . . . . . 11       5.2.  Subscribe/notify communication method . . . . . . . . . .  12
79     6.  Description for control commands . . . . . . . . . . . . . . . 13     6.  Description for control commands  . . . . . . . . . . . . . .  14
80       6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 13       6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14
81       6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 13       6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14
82         6.2.1.  Getting amount of available audio output drivers . . . 13         6.2.1.  Getting amount of available audio output drivers  . .  15
83         6.2.2.  Getting all available audio output drivers . . . . . . 14         6.2.2.  Getting all available audio output drivers  . . . . .  15
84         6.2.3.  Getting information about a specific audio output         6.2.3.  Getting information about a specific audio output
85                 driver . . . . . . . . . . . . . . . . . . . . . . . . 14                 driver  . . . . . . . . . . . . . . . . . . . . . . .  15
86         6.2.4.  Getting information about specific audio output         6.2.4.  Getting information about specific audio output
87                 driver parameter . . . . . . . . . . . . . . . . . . . 15                 driver parameter  . . . . . . . . . . . . . . . . . .  16
88         6.2.5.  Creating an audio output device  . . . . . . . . . . . 19         6.2.5.  Creating an audio output device . . . . . . . . . . .  20
89         6.2.6.  Destroying an audio output device  . . . . . . . . . . 20         6.2.6.  Destroying an audio output device . . . . . . . . . .  21
90         6.2.7.  Getting all created audio output device count  . . . . 21         6.2.7.  Getting all created audio output device count . . . .  22
91         6.2.8.  Getting all created audio output device list . . . . . 21         6.2.8.  Getting all created audio output device list  . . . .  22
92         6.2.9.  Getting current settings of an audio output device . . 21         6.2.9.  Getting current settings of an audio output device  .  22
93         6.2.10. Changing settings of audio output devices  . . . . . . 23         6.2.10. Changing settings of audio output devices . . . . . .  24
94         6.2.11. Getting information about an audio channel . . . . . . 23         6.2.11. Getting information about an audio channel  . . . . .  25
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter  . . . . . . . . . . . . . . . . . . . . . . 25                 parameter . . . . . . . . . . . . . . . . . . . . . .  26
97         6.2.13. Changing settings of audio output channels . . . . . . 27         6.2.13. Changing settings of audio output channels  . . . . .  28
98       6.3.  Configuring MIDI input drivers . . . . . . . . . . . . . . 28       6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29
99         6.3.1.  Getting amount of available MIDI input drivers . . . . 29         6.3.1.  Getting amount of available MIDI input drivers  . . .  30
100         6.3.2.  Getting all available MIDI input drivers . . . . . . . 29         6.3.2.  Getting all available MIDI input drivers  . . . . . .  30
101         6.3.3.  Getting information about a specific MIDI input         6.3.3.  Getting information about a specific MIDI input
102                 driver . . . . . . . . . . . . . . . . . . . . . . . . 29                 driver  . . . . . . . . . . . . . . . . . . . . . . .  31
103         6.3.4.  Getting information about specific MIDI input         6.3.4.  Getting information about specific MIDI input
104                 driver parameter . . . . . . . . . . . . . . . . . . . 30                 driver parameter  . . . . . . . . . . . . . . . . . .  32
105         6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 33         6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34
106         6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 34         6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35
107         6.3.7.  Getting all created MIDI input device count  . . . . . 35         6.3.7.  Getting all created MIDI input device count . . . . .  36
        6.3.8.  Getting all created MIDI input device list . . . . . . 35  
        6.3.9.  Getting current settings of a MIDI input device  . . . 35  
        6.3.10. Changing settings of MIDI input devices  . . . . . . . 37  
        6.3.11. Getting information about a MIDI port  . . . . . . . . 37  
        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  
108    
109    
110    
111  Schoenebeck               Expires May 29, 2007                  [Page 2]  Schoenebeck               Expires June 30, 2007                 [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
114    
115    
116         6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 42         6.3.8.  Getting all created MIDI input device list  . . . . .  36
117         6.4.3.  Getting all created sampler channel count  . . . . . . 43         6.3.9.  Getting current settings of a MIDI input device . . .  37
118         6.4.4.  Getting all created sampler channel list . . . . . . . 43         6.3.10. Changing settings of MIDI input devices . . . . . . .  38
119         6.4.5.  Adding a new sampler channel . . . . . . . . . . . . . 43         6.3.11. Getting information about a MIDI port . . . . . . . .  38
120         6.4.6.  Removing a sampler channel . . . . . . . . . . . . . . 44         6.3.12. Getting information about specific MIDI port
121         6.4.7.  Getting amount of available engines  . . . . . . . . . 45                 parameter . . . . . . . . . . . . . . . . . . . . . .  39
122         6.4.8.  Getting all available engines  . . . . . . . . . . . . 45         6.3.13. Changing settings of MIDI input ports . . . . . . . .  41
123         6.4.9.  Getting information about an engine  . . . . . . . . . 46       6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42
124         6.4.10. Getting sampler channel information  . . . . . . . . . 47         6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42
125         6.4.11. Current number of active voices  . . . . . . . . . . . 50         6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43
126         6.4.12. Current number of active disk streams  . . . . . . . . 50         6.4.3.  Getting all created sampler channel count . . . . . .  44
127         6.4.13. Current fill state of disk stream buffers  . . . . . . 50         6.4.4.  Getting all created sampler channel list  . . . . . .  44
128         6.4.14. Setting audio output device  . . . . . . . . . . . . . 51         6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44
129         6.4.15. Setting audio output type  . . . . . . . . . . . . . . 52         6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45
130         6.4.16. Setting audio output channel . . . . . . . . . . . . . 53         6.4.7.  Getting amount of available engines . . . . . . . . .  46
131         6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 54         6.4.8.  Getting all available engines . . . . . . . . . . . .  46
132         6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 54         6.4.9.  Getting information about an engine . . . . . . . . .  47
133         6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 55         6.4.10. Getting sampler channel information . . . . . . . . .  48
134         6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 56         6.4.11. Current number of active voices . . . . . . . . . . .  51
135         6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 56         6.4.12. Current number of active disk streams . . . . . . . .  51
136         6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 57         6.4.13. Current fill state of disk stream buffers . . . . . .  52
137         6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 58         6.4.14. Setting audio output device . . . . . . . . . . . . .  53
138         6.4.24. Resetting a sampler channel  . . . . . . . . . . . . . 58         6.4.15. Setting audio output type . . . . . . . . . . . . . .  53
139       6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 59         6.4.16. Setting audio output channel  . . . . . . . . . . . .  54
140         6.5.1.  Register front-end for receiving event messages  . . . 59         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. Adding an effect send to a sampler channel  . . . . .  61
150           6.4.26. Removing an effect send from a sampler channel  . . .  62
151           6.4.27. Getting amount of effect sends on a sampler channel .  63
152           6.4.28. Listing all effect sends on a sampler channel . . . .  63
153           6.4.29. Getting effect send information . . . . . . . . . . .  64
154           6.4.30. Altering effect send's audio routing  . . . . . . . .  65
155           6.4.31. Resetting a sampler channel . . . . . . . . . . . . .  66
156         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  66
157           6.5.1.  Register front-end for receiving event messages . . .  66
158         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
159                 messages . . . . . . . . . . . . . . . . . . . . . . . 60                 messages  . . . . . . . . . . . . . . . . . . . . . .  67
160         6.5.3.  Enable or disable echo of commands . . . . . . . . . . 61         6.5.3.  Enable or disable echo of commands  . . . . . . . . .  68
161         6.5.4.  Close client connection  . . . . . . . . . . . . . . . 61         6.5.4.  Close client connection . . . . . . . . . . . . . . .  68
162       6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 61       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  69
163         6.6.1.  Current number of active voices  . . . . . . . . . . . 61         6.6.1.  Current number of active voices . . . . . . . . . . .  69
164         6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 62  
165         6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 62  
166         6.6.4.  General sampler informations . . . . . . . . . . . . . 62  
167     7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 64  Schoenebeck               Expires June 30, 2007                 [Page 3]
168     8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71  
169       8.1.  Number of sampler channels changed . . . . . . . . . . . . 71  Internet-Draft        LinuxSampler Control Protocol        December 2006
170       8.2.  Number of active voices changed  . . . . . . . . . . . . . 71  
171       8.3.  Number of active disk streams changed  . . . . . . . . . . 71  
172       8.4.  Disk stream buffer fill state changed  . . . . . . . . . . 72         6.6.2.  Maximum amount of active voices . . . . . . . . . . .  69
173       8.5.  Channel information changed  . . . . . . . . . . . . . . . 72         6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  69
174       8.6.  Total number of active voices changed  . . . . . . . . . . 72         6.6.4.  General sampler informations  . . . . . . . . . . . .  70
175       8.7.  Miscellaneous and debugging events . . . . . . . . . . . . 73       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  70
176     9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 74         6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  71
177     10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 75         6.7.2.  Delete one particular or all MIDI instrument maps . .  72
178     11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 75         6.7.3.  Get amount of existing MIDI instrument maps . . . . .  72
179     Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 76         6.7.4.  Getting all created MIDI instrument maps  . . . . . .  73
180     Intellectual Property and Copyright Statements . . . . . . . . . . 77         6.7.5.  Getting MIDI instrument map information . . . . . . .  73
181           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  74
182           6.7.7.  Create or replace a MIDI instrument map entry . . . .  74
183           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  77
184           6.7.9.  Getting indeces of all entries of a MIDI
185                   instrument map  . . . . . . . . . . . . . . . . . . .  78
186           6.7.10. Remove an entry from the MIDI instrument map  . . . .  78
187           6.7.11. Get current settings of MIDI instrument map entry . .  79
188           6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  81
189       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  82
190       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  93
191         8.1.  Number of audio output devices changed  . . . . . . . . .  93
192         8.2.  Audio output device's settings changed  . . . . . . . . .  93
193         8.3.  Number of MIDI input devices changed  . . . . . . . . . .  93
194         8.4.  MIDI input device's settings changed  . . . . . . . . . .  94
195         8.5.  Number of sampler channels changed  . . . . . . . . . . .  94
196         8.6.  Number of active voices changed . . . . . . . . . . . . .  94
197         8.7.  Number of active disk streams changed . . . . . . . . . .  95
198         8.8.  Disk stream buffer fill state changed . . . . . . . . . .  95
199         8.9.  Channel information changed . . . . . . . . . . . . . . .  95
200         8.10. Total number of active voices changed . . . . . . . . . .  96
201         8.11. Number of MIDI instrument maps changed  . . . . . . . . .  96
202         8.12. MIDI instrument map information changed . . . . . . . . .  96
203         8.13. Number of MIDI instruments changed  . . . . . . . . . . .  97
204         8.14. MIDI instrument information changed . . . . . . . . . . .  97
205         8.15. Miscellaneous and debugging events  . . . . . . . . . . .  98
206       9.  Security Considerations . . . . . . . . . . . . . . . . . . .  99
207       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 100
208       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 101
209       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 102
210       Intellectual Property and Copyright Statements  . . . . . . . . . 103
211    
212    
213    
214    
215    
216    
217    
218    
219    
220    
221    
222    
223  Schoenebeck               Expires May 29, 2007                  [Page 3]  Schoenebeck               Expires June 30, 2007                 [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol        November 2006  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 May 29, 2007                  [Page 4]  Schoenebeck               Expires June 30, 2007                 [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
282    
283    
284  2.  Versioning of this specification  2.  Versioning of this specification
# Line 276  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires May 29, 2007                  [Page 5]  Schoenebeck               Expires June 30, 2007                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        November 2006  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 May 29, 2007                  [Page 6]  Schoenebeck               Expires June 30, 2007                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        November 2006  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 May 29, 2007                  [Page 7]  Schoenebeck               Expires June 30, 2007                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
450    
451    
452  5.  Communication Overview  5.  Communication Overview
# Line 444  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires May 29, 2007                  [Page 8]  Schoenebeck               Expires June 30, 2007                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
506    
507    
508  5.1.1.  Result format  5.1.1.  Result format
# Line 500  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires May 29, 2007                  [Page 9]  Schoenebeck               Expires June 30, 2007                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        November 2006  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 May 29, 2007                 [Page 10]  Schoenebeck               Expires June 30, 2007                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        November 2006  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 612  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires May 29, 2007                 [Page 11]  Schoenebeck               Expires June 30, 2007                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
674    
675    
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
# Line 668  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires May 29, 2007                 [Page 12]  Schoenebeck               Expires June 30, 2007                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
730    
731    
732  6.  Description for control commands  6.  Description for control commands
# 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    
781  Schoenebeck               Expires May 29, 2007                 [Page 13]  
782    
783    Schoenebeck               Expires June 30, 2007                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        November 2006  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 777  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839    Schoenebeck               Expires June 30, 2007                [Page 15]
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 14]  
840    
841  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
842    
843    
844        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 836  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires May 29, 2007                 [Page 15]  Schoenebeck               Expires June 30, 2007                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
898    
899    
900     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 892  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires May 29, 2007                 [Page 16]  Schoenebeck               Expires June 30, 2007                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        November 2006  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 May 29, 2007                 [Page 17]  Schoenebeck               Expires June 30, 2007                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        November 2006  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 May 29, 2007                 [Page 18]  Schoenebeck               Expires June 30, 2007                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1066    
1067    
1068           "TYPE: INT"           "TYPE: INT"
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires May 29, 2007                 [Page 19]  Schoenebeck               Expires June 30, 2007                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1122    
1123    
1124           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires May 29, 2007                 [Page 20]  Schoenebeck               Expires June 30, 2007                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1178    
1179    
1180        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires May 29, 2007                 [Page 21]  Schoenebeck               Expires June 30, 2007                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1234    
1235    
1236     Possible Answers:     Possible Answers:
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires May 29, 2007                 [Page 22]  Schoenebeck               Expires June 30, 2007                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1290    
1291    
1292           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1277  Internet-Draft        LinuxSampler Contr Line 1333  Internet-Draft        LinuxSampler Contr
1333    
1334        S: "OK"        S: "OK"
1335    
 6.2.11.  Getting information about an audio channel  
1336    
    Use the following command to get information about an audio channel:  
1337    
1338    
1339    
1340    
1341  Schoenebeck               Expires May 29, 2007                 [Page 23]  
1342    
1343    Schoenebeck               Expires June 30, 2007                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1346    
1347    
1348    6.2.11.  Getting information about an audio channel
1349    
1350       Use the following command to get information about an audio channel:
1351    
1352        GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>        GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
1353    
1354     Where <device-id> is the numerical ID of the audio output device as     Where <device-id> is the numerical ID of the audio output device as
# Line 1334  Internet-Draft        LinuxSampler Contr Line 1394  Internet-Draft        LinuxSampler Contr
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    
    Examples:  
   
   
   
1397    
1398    
1399  Schoenebeck               Expires May 29, 2007                 [Page 24]  Schoenebeck               Expires June 30, 2007                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1402    
1403    
1404       Examples:
1405    
1406        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
1407    
1408        S: "NAME: studio monitor left"        S: "NAME: studio monitor left"
# Line 1391  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
    channel number and <param> a specific channel parameter name for  
    which information should be obtained (as returned by the "GET  
1452    
1453    
1454    
1455  Schoenebeck               Expires May 29, 2007                 [Page 25]  Schoenebeck               Expires June 30, 2007                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1458    
1459    
1460       channel number and <param> a specific channel parameter name for
1461       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).
1463    
1464     Possible Answers:     Possible Answers:
# Line 1450  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511    Schoenebeck               Expires June 30, 2007                [Page 27]
   
 Schoenebeck               Expires May 29, 2007                 [Page 26]  
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1514    
1515    
1516           RANGE_MAX -           RANGE_MAX -
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires May 29, 2007                 [Page 27]  Schoenebeck               Expires June 30, 2007                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1570    
1571    
1572        "OK" -        "OK" -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires May 29, 2007                 [Page 28]  Schoenebeck               Expires June 30, 2007                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        November 2006  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
# Line 1613  Internet-Draft        LinuxSampler Contr Line 1669  Internet-Draft        LinuxSampler Contr
1669    
1670        S: "ALSA,JACK"        S: "ALSA,JACK"
1671    
 6.3.3.  Getting information about a specific MIDI input driver  
1672    
    Use the following command to get detailed information about a  
    specific MIDI input driver:  
1673    
1674    
1675    
1676  Schoenebeck               Expires May 29, 2007                 [Page 29]  
1677    
1678    
1679    Schoenebeck               Expires June 30, 2007                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1682    
1683    
1684    6.3.3.  Getting information about a specific MIDI input driver
1685    
1686       Use the following command to get detailed information about a
1687       specific MIDI input driver:
1688    
1689        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>
1690    
1691     Where <midi-input-driver> is the name of the MIDI input driver as     Where <midi-input-driver> is the name of the MIDI input driver as
# Line 1668  Internet-Draft        LinuxSampler Contr Line 1729  Internet-Draft        LinuxSampler Contr
1729    
1730           "."           "."
1731    
 6.3.4.  Getting information about specific MIDI input driver parameter  
1732    
    Use the following command to get detailed information about a  
    specific parameter of a specific MIDI input driver:  
1733    
1734    
1735    Schoenebeck               Expires June 30, 2007                [Page 31]
1736    
1737    Internet-Draft        LinuxSampler Control Protocol        December 2006
1738    
1739    
1740  Schoenebeck               Expires May 29, 2007                 [Page 30]  6.3.4.  Getting information about specific MIDI input driver parameter
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
1741    
1742       Use the following command to get detailed information about a
1743       specific parameter of a specific MIDI input driver:
1744    
1745        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
1746    
# Line 1725  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    
       FIX -  
   
          either true or false, if false then this parameter can be  
          changed at any time, once the device is created by the 'CREATE  
1789    
1790    
1791    Schoenebeck               Expires June 30, 2007                [Page 32]
 Schoenebeck               Expires May 29, 2007                 [Page 31]  
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1794    
1795    
1796          FIX -
1797    
1798             either true or false, if false then this parameter can be
1799             changed at any time, once the device is created by the 'CREATE
1800           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1801           matter which driver parameter)           matter which driver parameter)
1802    
# Line 1781  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
          may also appear without (optionally returned, dependent to  
          driver parameter)  
   
   
1844    
1845    
1846    
1847  Schoenebeck               Expires May 29, 2007                 [Page 32]  Schoenebeck               Expires June 30, 2007                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1850    
1851    
1852             may also appear without (optionally returned, dependent to
1853             driver parameter)
1854    
1855        POSSIBILITIES -        POSSIBILITIES -
1856    
1857           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
# Line 1837  Internet-Draft        LinuxSampler Contr Line 1896  Internet-Draft        LinuxSampler Contr
1896    
1897     Possible Answers:     Possible Answers:
1898    
       "OK[<device-id>]" -  
1899    
          in case the device was successfully created, where <device-id>  
          is the numerical ID of the new device  
1900    
1901    
1902    
1903  Schoenebeck               Expires May 29, 2007                 [Page 33]  Schoenebeck               Expires June 30, 2007                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1906    
1907    
1908          "OK[<device-id>]" -
1909    
1910             in case the device was successfully created, where <device-id>
1911             is the numerical ID of the new device
1912    
1913        "WRN[<device-id>]:<warning-code>:<warning-message>" -        "WRN[<device-id>]:<warning-code>:<warning-message>" -
1914    
# Line 1891  Internet-Draft        LinuxSampler Contr Line 1952  Internet-Draft        LinuxSampler Contr
1952    
1953        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1954    
          in case it failed, providing an appropriate error code and  
          error message  
1955    
    Example:  
1956    
1957    
1958    
1959    Schoenebeck               Expires June 30, 2007                [Page 35]
1960    
1961    Internet-Draft        LinuxSampler Control Protocol        December 2006
1962    
1963    
1964  Schoenebeck               Expires May 29, 2007                 [Page 34]           in case it failed, providing an appropriate error code and
1965             error message
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
1966    
1967       Example:
1968    
1969        C: "DESTROY MIDI_INPUT_DEVICE 0"        C: "DESTROY MIDI_INPUT_DEVICE 0"
1970    
# Line 1947  Internet-Draft        LinuxSampler Contr Line 2008  Internet-Draft        LinuxSampler Contr
2008    
2009        S: "1,3"        S: "1,3"
2010    
 6.3.9.  Getting current settings of a MIDI input device  
2011    
    Use the following command to get current settings of a specific,  
    created MIDI input device:  
2012    
2013    
2014    
2015    Schoenebeck               Expires June 30, 2007                [Page 36]
2016    
2017    Internet-Draft        LinuxSampler Control Protocol        December 2006
2018    
2019    
2020  Schoenebeck               Expires May 29, 2007                 [Page 35]  6.3.9.  Getting current settings of a MIDI input device
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2021    
2022       Use the following command to get current settings of a specific,
2023       created MIDI input device:
2024    
2025        GET MIDI_INPUT_DEVICE INFO <device-id>        GET MIDI_INPUT_DEVICE INFO <device-id>
2026    
# Line 2004  Internet-Draft        LinuxSampler Contr Line 2065  Internet-Draft        LinuxSampler Contr
2065    
2066        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
2067    
          "ACTIVE: true"  
   
          "."  
2068    
2069    
2070    
2071    Schoenebeck               Expires June 30, 2007                [Page 37]
2072    
2073    Internet-Draft        LinuxSampler Control Protocol        December 2006
2074    
2075    
2076  Schoenebeck               Expires May 29, 2007                 [Page 36]           "ACTIVE: true"
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2077    
2078             "."
2079    
2080  6.3.10.  Changing settings of MIDI input devices  6.3.10.  Changing settings of MIDI input devices
2081    
# Line 2061  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
    MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI  
    input port number.  
   
    Possible Answers:  
2124    
2125    
2126    
2127  Schoenebeck               Expires May 29, 2007                 [Page 37]  Schoenebeck               Expires June 30, 2007                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2130    
2131    
2132       MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
2133       input port number.
2134    
2135       Possible Answers:
2136    
2137        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2138        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2139        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 2116  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
       character string to that info category.  There is information  
       which is always returned, independently of the given channel  
       parameter and there is optional information which are only shown  
       dependently to the given MIDI port.  At the moment the following  
       information categories are defined:  
2180    
2181    
2182    
2183  Schoenebeck               Expires May 29, 2007                 [Page 38]  Schoenebeck               Expires June 30, 2007                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2186    
2187    
2188          character string to that info category.  There is information
2189          which is always returned, independently of the given channel
2190          parameter and there is optional information which are only shown
2191          dependently to the given MIDI port.  At the moment the following
2192          information categories are defined:
2193    
2194        TYPE -        TYPE -
2195    
2196           either "BOOL" for boolean value(s) or "INT" for integer           either "BOOL" for boolean value(s) or "INT" for integer
# Line 2171  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
          returned, dependent to device and port parameter)  
2236    
    The mentioned fields above don't have to be in particular order.  
2237    
    Example:  
2238    
2239    Schoenebeck               Expires June 30, 2007                [Page 40]
2240    
2241    Internet-Draft        LinuxSampler Control Protocol        December 2006
2242    
2243    
2244             returned, dependent to device and port parameter)
2245    
2246  Schoenebeck               Expires May 29, 2007                 [Page 39]     The mentioned fields above don't have to be in particular order.
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2247    
2248       Example:
2249    
2250        C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"        C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
2251    
# Line 2226  Internet-Draft        LinuxSampler Contr Line 2288  Internet-Draft        LinuxSampler Contr
2288    
2289        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2290    
          in case it failed, providing an appropriate error code and  
          error message  
   
    Example:  
2291    
2292    
2293    
2294    
2295    Schoenebeck               Expires June 30, 2007                [Page 41]
2296    
2297    Internet-Draft        LinuxSampler Control Protocol        December 2006
2298    
2299    
2300  Schoenebeck               Expires May 29, 2007                 [Page 40]           in case it failed, providing an appropriate error code and
2301             error message
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2302    
2303       Example:
2304    
2305    
2306    
# Line 2284  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
          or more patch parameters provided by the loaded instrument  
          file), providing an appropriate warning code and warning  
          message  
   
   
2348    
2349    
2350    
2351  Schoenebeck               Expires May 29, 2007                 [Page 41]  Schoenebeck               Expires June 30, 2007                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2354    
2355    
2356             or more patch parameters provided by the loaded instrument
2357             file), providing an appropriate warning code and warning
2358             message
2359    
2360        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2361    
2362           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2342  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 30, 2007                [Page 43]
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 42]  
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        November 2006  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
# Line 2398  Internet-Draft        LinuxSampler Contr Line 2456  Internet-Draft        LinuxSampler Contr
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    
       ADD CHANNEL  
2459    
    This will increment the sampler channel count by one and the new  
2460    
2461    
2462    
2463  Schoenebeck               Expires May 29, 2007                 [Page 43]  Schoenebeck               Expires June 30, 2007                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2466    
2467    
2468          ADD CHANNEL
2469    
2470       This will increment the sampler channel count by one and the new
2471     sampler channel will be appended to the end of the sampler channel     sampler channel will be appended to the end of the sampler channel
2472     list.  The front-end should send the respective, related commands     list.  The front-end should send the respective, related commands
2473     right after to e.g. load an engine, load an instrument and setting     right after to e.g. load an engine, load an instrument and setting
# Line 2457  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519    Schoenebeck               Expires June 30, 2007                [Page 45]
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 44]  
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2522    
2523    
2524        "OK" -        "OK" -
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck               Expires May 29, 2007                 [Page 45]  Schoenebeck               Expires June 30, 2007                [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        November 2006  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
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires May 29, 2007                 [Page 46]  Schoenebeck               Expires June 30, 2007                [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2634    
2635    
2636           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires May 29, 2007                 [Page 47]  Schoenebeck               Expires June 30, 2007                [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        November 2006  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
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires May 29, 2007                 [Page 48]  Schoenebeck               Expires June 30, 2007                [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2746    
2747    
2748           MUTE -           MUTE -
# Line 2702  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 2730  Internet-Draft        LinuxSampler Contr Line 2793  Internet-Draft        LinuxSampler Contr
2793    
2794           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2795    
          "MIDI_INPUT_CHANNEL: 5"  
2796    
          "."  
2797    
2798    
2799    Schoenebeck               Expires June 30, 2007                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol        December 2006
2802    
2803    
2804             "MIDI_INPUT_CHANNEL: 5"
2805    
2806             "VOLUME: 1.0"
2807    
2808             "MUTE: false"
2809    
2810  Schoenebeck               Expires May 29, 2007                 [Page 49]           "SOLO: false"
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2811    
2812             "MIDI_INSTRUMENT_MAP: NONE"
2813    
2814             "."
2815    
2816  6.4.11.  Current number of active voices  6.4.11.  Current number of active voices
2817    
# Line 2781  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
       return "NA" for not available.  
   
    Example:  
2852    
2853    
2854    
2855  6.4.13.  Current fill state of disk stream buffers  Schoenebeck               Expires June 30, 2007                [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol        December 2006
2858    
    The front-end can ask for the current fill state of all disk streams  
    on a sampler channel by sending the following command:  
2859    
2860          return "NA" for not available.
2861    
2862       Example:
2863    
2864    
2865    
2866  Schoenebeck               Expires May 29, 2007                 [Page 50]  6.4.13.  Current fill state of disk stream buffers
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
2867    
2868       The front-end can ask for the current fill state of all disk streams
2869       on a sampler channel by sending the following command:
2870    
2871        GET CHANNEL BUFFER_FILL BYTES <sampler-channel>        GET CHANNEL BUFFER_FILL BYTES <sampler-channel>
2872    
# Line 2837  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    
2907    
2908    
2909    
2910    
2911    Schoenebeck               Expires June 30, 2007                [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol        December 2006
2914    
2915    
2916        S: ""        S: ""
2917    
2918  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 2849  Internet-Draft        LinuxSampler Contr Line 2925  Internet-Draft        LinuxSampler Contr
2925    
2926     Where <sampler-channel> is the respective sampler channel number as     Where <sampler-channel> is the respective sampler channel number as
2927     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 May 29, 2007                 [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
2928     (Section 6.4.4) command and <audio-device-id> is the numerical ID of     (Section 6.4.4) command and <audio-device-id> is the numerical ID of
2929     the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"     the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
2930     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
# Line 2893  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 30, 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 2904  Internet-Draft        LinuxSampler Contr Line 2980  Internet-Draft        LinuxSampler Contr
2980    
2981        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2982    
   
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
2983           if audio output type was set, but there are noteworthy issue(s)           if audio output type was set, but there are noteworthy issue(s)
2984           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
2985           message           message
# Line 2949  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 30, 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 2962  Internet-Draft        LinuxSampler Contr Line 3038  Internet-Draft        LinuxSampler Contr
3038    
3039    
3040    
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
   
   
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
# Line 3005  Internet-Draft        LinuxSampler Contr Line 3072  Internet-Draft        LinuxSampler Contr
3072    
3073    
3074    
3075    
3076    
3077    
3078    
3079    Schoenebeck               Expires June 30, 2007                [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol        December 2006
3082    
3083    
3084  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
3085    
3086     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 3017  Internet-Draft        LinuxSampler Contr Line 3093  Internet-Draft        LinuxSampler Contr
3093     Where <midi-input-type> is currently only "ALSA" and <sampler-     Where <midi-input-type> is currently only "ALSA" and <sampler-
3094     channel> is the respective sampler channel number.     channel> is the respective sampler channel number.
3095    
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3096     Possible Answers:     Possible Answers:
3097    
3098        "OK" -        "OK" -
# Line 3060  Internet-Draft        LinuxSampler Contr Line 3128  Internet-Draft        LinuxSampler Contr
3128    
3129        "OK" -        "OK" -
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck               Expires June 30, 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 3073  Internet-Draft        LinuxSampler Contr Line 3150  Internet-Draft        LinuxSampler Contr
3150           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3151           error message           error message
3152    
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3153     Examples:     Examples:
3154    
3155    
# Line 3117  Internet-Draft        LinuxSampler Contr Line 3186  Internet-Draft        LinuxSampler Contr
3186    
3187    
3188    
3189    
3190    
3191    Schoenebeck               Expires June 30, 2007                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol        December 2006
3194    
3195    
3196    
3197    
3198  6.4.21.  Setting channel volume  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
# Line 3129  Internet-Draft        LinuxSampler Contr Line 3207  Internet-Draft        LinuxSampler Contr
3207     means amplification) and <sampler-channel> defines the sampler     means amplification) and <sampler-channel> defines the sampler
3208     channel where this volume factor should be set.     channel where this volume factor should be set.
3209    
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3210     Possible Answers:     Possible Answers:
3211    
3212        "OK" -        "OK" -
# Line 3172  Internet-Draft        LinuxSampler Contr Line 3242  Internet-Draft        LinuxSampler Contr
3242    
3243     Possible Answers:     Possible Answers:
3244    
3245    
3246    
3247    Schoenebeck               Expires June 30, 2007                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol        December 2006
3250    
3251    
3252        "OK" -        "OK" -
3253    
3254           on success           on success
# Line 3184  Internet-Draft        LinuxSampler Contr Line 3261  Internet-Draft        LinuxSampler Contr
3261    
3262        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3263    
   
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3264           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3265           error message           error message
3266    
# Line 3229  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 30, 2007                [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol        December 2006
3306    
3307    
3308     Examples:     Examples:
3309    
3310    
3311    
3312  6.4.24.  Resetting a sampler channel  6.4.24.  Assigning a MIDI instrument map to a sampler channel
3313    
3314     The front-end can reset a particular sampler channel by sending the     The front-end can assign a MIDI instrument map to a specific sampler
3315     following command:     channel by sending the following command:
3316    
3317        RESET CHANNEL <sampler-channel>        SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3318    
3319     Where <sampler-channel> defines the sampler channel to be reset.     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          "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 30, 2007                [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol        December 2006
3362    
3363    
3364       Examples:
3365    
3366    
3367    
3368    6.4.25.  Adding an effect send to a sampler channel
3369    
3370       The front-end can create an additional effect send on a specific
3371       sampler channel by sending the following command:
3372    
3373          CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3374    
3375       Where <sampler-channel> is the respective sampler channel number as
3376       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3377       (Section 6.4.4) command, that is the sampler channel on which the
3378       effect send should be created on, <midi-ctrl> is a number between
3379       0..127 defining the MIDI controller which can alter the effect send
3380       level and <name> is an optional argument defining a name for the
3381       effect send entity.  The name does not have to be unique.
3382    
3383       By default, that is as initial routing, the effect send's audio
3384       channels are automatically routed to the last audio channels of the
3385       sampler channel's audio output device, that way you can i.e. first
3386       increase the amount of audio channels on the audio output device for
3387       having dedicated effect send output channels and when "CREATE
3388       FX_SEND" is called, those channels will automatically be picked.  You
3389       can alter the destination channels however with "SET FX_SEND
3390       AUDIO_OUTPUT_CHANNEL" (Section 6.4.30).
3391    
3392       Note: Create effect sends on a sampler channel only when needed,
3393       because having effect sends on a sampler channel will decrease
3394       runtime performance, because for implementing channel effect sends,
3395       separate (sampler channel local) audio buffers are needed to render
3396       and mix the voices and route the audio signal afterwards to the
3397       master outputs and effect send outputs (along with their respective
3398       effect send levels).  A sampler channel without effect sends however
3399       can mix its voices directly into the audio output devices's audio
3400       buffers and is thus faster.
3401    
3402       Possible Answers:
3403    
3404          "OK[<fx-send-id>]" -
3405    
3406             in case a new effect send could be added to the sampler
3407             channel, where <fx-send-id> reflects the unique ID of the newly
3408             created effect send entity
3409    
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires June 30, 2007                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol        December 2006
3418    
3419    
3420          "ERR:<error-code>:<error-message>" -
3421    
3422             when a new effect send could not be added, i.e. due to invalid
3423             parameters
3424    
3425       Examples:
3426    
3427          C: "CREATE FX_SEND 0 91 'Reverb Send'"
3428    
3429          S: "OK[0]"
3430    
3431          C: "CREATE FX_SEND 0 93"
3432    
3433          S: "OK[1]"
3434    
3435    6.4.26.  Removing an effect send from a sampler channel
3436    
3437       The front-end can remove an existing effect send on a specific
3438       sampler channel by sending the following command:
3439    
3440          DESTROY FX_SEND <sampler-channel> <fx-send-id>
3441    
3442       Where <sampler-channel> is the respective sampler channel number as
3443       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3444       (Section 6.4.4) command, that is the sampler channel from which the
3445       effect send should be removed from and <fx-send-id> is the respective
3446       effect send number as returned by the "CREATE FX_SEND"
3447       (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3448    
3449       Possible Answers:
3450    
3451          "OK" -
3452    
3453             on success
3454    
3455          "ERR:<error-code>:<error-message>" -
3456    
3457             in case it failed, providing an appropriate error code and
3458             error message
3459    
3460       Example:
3461    
3462          C: "DESTROY FX_SEND 0 0"
3463    
3464          S: "OK"
3465    
3466    
3467    
3468    
3469    
3470    
3471    Schoenebeck               Expires June 30, 2007                [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol        December 2006
3474    
3475    
3476    6.4.27.  Getting amount of effect sends on a sampler channel
3477    
3478       The front-end can ask for the amount of effect sends on a specific
3479       sampler channel by sending the following command:
3480    
3481          GET FX_SENDS <sampler-channel>
3482    
3483       Where <sampler-channel> is the respective sampler channel number as
3484       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3485       (Section 6.4.4) command.
3486    
3487       Possible Answers:
3488    
3489          The sampler will answer by returning the number of effect sends on
3490          the given sampler channel.
3491    
3492       Example:
3493    
3494          C: "GET FX_SENDS 0"
3495    
3496          S: "2"
3497    
3498    6.4.28.  Listing all effect sends on a sampler channel
3499    
3500       The front-end can ask for a list of effect sends on a specific
3501       sampler channel by sending the following command:
3502    
3503          LIST FX_SENDS <sampler-channel>
3504    
3505       Where <sampler-channel> is the respective sampler channel number as
3506       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3507       (Section 6.4.4) command.
3508    
3509       Possible Answers:
3510    
3511          The sampler will answer by returning a comma separated list with
3512          all effect sends' numerical IDs on the given sampler channel.
3513    
3514       Examples:
3515    
3516          C: "LIST FX_SENDS 0"
3517    
3518          S: "0,1"
3519    
3520          C: "LIST FX_SENDS 1"
3521    
3522          S: ""
3523    
3524    
3525    
3526    
3527    Schoenebeck               Expires June 30, 2007                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol        December 2006
3530    
3531    
3532    6.4.29.  Getting effect send information
3533    
3534       The front-end can ask for the current settings of an effect send
3535       entity by sending the following command:
3536    
3537          GET FX_SEND INFO <sampler-channel> <fx-send-id>
3538    
3539       Where <sampler-channel> is the sampler channel number as returned by
3540       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3541       command and <fx-send-id> reflects the numerical ID of the effect send
3542       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3543       FX_SENDS" (Section 6.4.28) command.
3544    
3545       Possible Answers:
3546    
3547          The sampler will answer by sending a <CRLF> separated list.  Each
3548          answer line begins with the settings category name followed by a
3549          colon and then a space character <SP> and finally the info
3550          character string to that setting category.  At the moment the
3551          following categories are defined:
3552    
3553    
3554    
3555             NAME -
3556    
3557                name of the effect send entity
3558    
3559             AUDIO_OUTPUT_ROUTING -
3560    
3561                comma separated list which reflects to which audio channel
3562                of the selected audio output device each effect send output
3563                channel is routed to, e.g. "0,3" would mean the effect
3564                send's output channel 0 is routed to channel 0 of the audio
3565                output device and the effect send's output channel 1 is
3566                routed to the channel 3 of the audio output device (see "SET
3567                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)
3568    
3569       The mentioned fields above don't have to be in particular order.
3570    
3571       Example:
3572    
3573          C: "GET FX_SEND INFO 0 0"
3574    
3575          S: "NAME: Reverb Send"
3576    
3577             "AUDIO_OUTPUT_ROUTING: 2,3"
3578    
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires June 30, 2007                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol        December 2006
3586    
3587    
3588             "."
3589    
3590    6.4.30.  Altering effect send's audio routing
3591    
3592       The front-end can alter the destination of an effect send's audio
3593       channel on a specific sampler channel by sending the following
3594       command:
3595    
3596          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3597          <audio-src> <audio-dst>
3598    
3599       Where <sampler-chan> is the sampler channel number as returned by the
3600       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3601       command, <fx-send-id> reflects the numerical ID of the effect send
3602       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3603       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3604       of the effect send's audio channel which should be rerouted and
3605       <audio-dst> is the numerical ID of the audio channel of the selected
3606       audio output device where <audio-src> should be routed to.
3607    
3608       Note that effect sends can only route audio to the same audio output
3609       device as assigned to the effect send's sampler channel.  Also note
3610       that an effect send entity does always have exactly as much audio
3611       channels as its sampler channel.  So if the sampler channel is
3612       stereo, the effect send does have two audio channels as well.  Also
3613       keep in mind that the amount of audio channels on a sampler channel
3614       might be dependant not only to the deployed sampler engine on the
3615       sampler channel, but also dependant to the instrument currently
3616       loaded.  However you can (effectively) turn an i.e. stereo effect
3617       send into a mono one by simply altering its audio routing
3618       appropriately.
3619    
3620       Possible Answers:
3621    
3622          "OK" -
3623    
3624             on success
3625    
3626          "WRN:<warning-code>:<warning-message>" -
3627    
3628             if audio output channel was set, but there are noteworthy
3629             issue(s) related, providing an appropriate warning code and
3630             warning message
3631    
3632  Schoenebeck               Expires May 29, 2007                 [Page 58]        "ERR:<error-code>:<error-message>" -
3633    
3634             in case it failed, providing an appropriate error code and
3635             error message
3636    
3637    
3638    
3639    Schoenebeck               Expires June 30, 2007                [Page 65]
3640    
3641  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3642    
3643    
3644       Example:
3645    
3646          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3647    
3648          S: "OK"
3649    
3650    6.4.31.  Resetting a sampler channel
3651    
3652       The front-end can reset a particular sampler channel by sending the
3653       following command:
3654    
3655          RESET CHANNEL <sampler-channel>
3656    
3657       Where <sampler-channel> defines the sampler channel to be reset.
3658     This will cause the engine on that sampler channel, its voices and     This will cause the engine on that sampler channel, its voices and
3659     eventually disk streams and all control and status variables to be     eventually disk streams and all control and status variables to be
3660     reset.     reset.
# Line 3284  Internet-Draft        LinuxSampler Contr Line 3690  Internet-Draft        LinuxSampler Contr
3690     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3691     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3692    
3693    
3694    
3695    Schoenebeck               Expires June 30, 2007                [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol        December 2006
3698    
3699    
3700        SUBSCRIBE <event-id>        SUBSCRIBE <event-id>
3701    
3702     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 3295  Internet-Draft        LinuxSampler Contr Line 3708  Internet-Draft        LinuxSampler Contr
3708    
3709           on success           on success
3710    
   
   
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 59]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3711        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3712    
3713           if registration succeeded, but there are noteworthy issue(s)           if registration succeeded, but there are noteworthy issue(s)
# Line 3342  Internet-Draft        LinuxSampler Contr Line 3745  Internet-Draft        LinuxSampler Contr
3745           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3746           message           message
3747    
       "ERR:<error-code>:<error-message>" -  
   
          in case it failed, providing an appropriate error code and  
          error message  
   
    Examples:  
3748    
3749    
3750    
3751    Schoenebeck               Expires June 30, 2007                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol        December 2006
3754    
3755    
3756          "ERR:<error-code>:<error-message>" -
3757    
3758             in case it failed, providing an appropriate error code and
3759             error message
3760    
3761       Examples:
3762    
 Schoenebeck               Expires May 29, 2007                 [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3763    
3764    
3765  6.5.3.  Enable or disable echo of commands  6.5.3.  Enable or disable echo of commands
# Line 3399  Internet-Draft        LinuxSampler Contr Line 3800  Internet-Draft        LinuxSampler Contr
3800     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
3801     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
3802    
 6.6.  Global commands  
3803    
    The following commands have global impact on the sampler.  
3804    
 6.6.1.  Current number of active voices  
3805    
    The front-end can ask for the current number of active voices on the  
    sampler by sending the following command:  
3806    
3807    Schoenebeck               Expires June 30, 2007                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol        December 2006
3810    
3811    
3812    6.6.  Global commands
3813    
3814       The following commands have global impact on the sampler.
3815    
3816  Schoenebeck               Expires May 29, 2007                 [Page 61]  6.6.1.  Current number of active voices
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3817    
3818       The front-end can ask for the current number of active voices on the
3819       sampler by sending the following command:
3820    
3821        GET TOTAL_VOICE_COUNT        GET TOTAL_VOICE_COUNT
3822    
# Line 3453  Internet-Draft        LinuxSampler Contr Line 3854  Internet-Draft        LinuxSampler Contr
3854    
3855    
3856    
3857    
3858    
3859    
3860    
3861    
3862    
3863    Schoenebeck               Expires June 30, 2007                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol        December 2006
3866    
3867    
3868  6.6.4.  General sampler informations  6.6.4.  General sampler informations
3869    
3870     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
# Line 3465  Internet-Draft        LinuxSampler Contr Line 3877  Internet-Draft        LinuxSampler Contr
3877        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
3878        answer line begins with the information category name followed by        answer line begins with the information category name followed by
3879        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3880        character string to that information category.  At the moment the        character string to that information category.  At the moment the
3881        following categories are defined:        following categories are defined:
3882    
# Line 3494  Internet-Draft        LinuxSampler Contr Line 3898  Internet-Draft        LinuxSampler Contr
3898     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
3899     Other fields might be added in future.     Other fields might be added in future.
3900    
3901    6.7.  MIDI Instrument Mapping
3902    
3903       The MIDI protocol provides a way to switch between instruments by
3904       sending so called MIDI bank select and MIDI program change messages
3905       which are essentially just numbers.  The following commands allow to
3906       actually map arbitrary MIDI bank select / program change numbers with
3907       real instruments.
3908    
3909       The sampler allows to manage an arbitrary amount of MIDI instrument
3910       maps which define which instrument to load on which MIDI program
3911       change message.
3912    
3913       By default, that is when the sampler is launched, there is no map,
3914       thus the sampler will simply ignore all program change messages.  The
3915       front-end has to explicitly create at least one map, add entries to
3916    
3917    
3918    
3919    Schoenebeck               Expires June 30, 2007                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol        December 2006
3922    
3923    
3924       the map and tell the respective sampler channel(s) which MIDI
3925       instrument map to use, so the sampler knows how to react on a given
3926       program change message on the respective sampler channel, that is by
3927       switching to the respectively defined engine type and loading the
3928       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
3929       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
3930       channel.
3931    
3932       Also note per MIDI specification a bank select message does not cause
3933       to switch to another instrument.  Instead when receiving a bank
3934       select message the bank value will be stored and a subsequent program
3935       change message (which may occur at any time) will finally cause the
3936       sampler to switch to the respective instrument as reflected by the
3937       current MIDI instrument map.
3938    
3939    6.7.1.  Create a new MIDI instrument map
3940    
3941       The front-end can add a new MIDI instrument map by sending the
3942       following command:
3943    
3944          ADD MIDI_INSTRUMENT_MAP [<name>]
3945    
3946       Where <name> is an optional argument allowing to assign a custom name
3947       to the new map.  MIDI instrument Map names do not have to be unique.
3948    
3949       Possible Answers:
3950    
3951          "OK[<map>]" -
3952    
3953             in case a new MIDI instrument map could be added, where <map>
3954             reflects the unique ID of the newly created MIDI instrument map
3955    
3956          "ERR:<error-code>:<error-message>" -
3957    
3958             when a new map could not be created, which might never occur in
3959             practice
3960    
3961       Examples:
3962    
3963          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
3964    
3965          S: "OK[0]"
3966    
3967          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
3968    
3969          S: "OK[1]"
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires June 30, 2007                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol        December 2006
3978    
3979    
3980          C: "ADD MIDI_INSTRUMENT_MAP"
3981    
3982          S: "OK[5]"
3983    
3984    6.7.2.  Delete one particular or all MIDI instrument maps
3985    
3986       The front-end can delete a particular MIDI instrument map by sending
3987       the following command:
3988    
3989          REMOVE MIDI_INSTRUMENT_MAP <map>
3990    
3991       Where <map> reflects the unique ID of the map to delete as returned
3992       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
3993    
3994       The front-end can delete all MIDI instrument maps by sending the
3995       following command:
3996    
3997          REMOVE MIDI_INSTRUMENT_MAP ALL
3998    
3999       Possible Answers:
4000    
4001          "OK" -
4002    
4003             in case the map(s) could be deleted
4004    
4005          "ERR:<error-code>:<error-message>" -
4006    
4007             when the given map does not exist
4008    
4009       Examples:
4010    
4011          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4012    
4013  Schoenebeck               Expires May 29, 2007                 [Page 63]        S: "OK"
4014    
4015          C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
4016    
4017          S: "OK"
4018    
4019    6.7.3.  Get amount of existing MIDI instrument maps
4020    
4021       The front-end can retrieve the current amount of MIDI instrument maps
4022       by sending the following command:
4023    
4024          GET MIDI_INSTRUMENT_MAPS
4025    
4026       Possible Answers:
4027    
4028    
4029    
4030    
4031    Schoenebeck               Expires June 30, 2007                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol        December 2006
4034    
4035    
4036          The sampler will answer by returning the current number of MIDI
4037          instrument maps.
4038    
4039       Example:
4040    
4041          C: "GET MIDI_INSTRUMENT_MAPS"
4042    
4043          S: "2"
4044    
4045    6.7.4.  Getting all created MIDI instrument maps
4046    
4047       The number of MIDI instrument maps can change on runtime.  To get the
4048       current list of MIDI instrument maps, the front-end can send the
4049       following command:
4050    
4051          LIST MIDI_INSTRUMENT_MAPS
4052    
4053       Possible Answers:
4054    
4055          The sampler will answer by returning a comma separated list with
4056          all MIDI instrument maps' numerical IDs.
4057    
4058       Example:
4059    
4060          C: "LIST MIDI_INSTRUMENT_MAPS"
4061    
4062          S: "0,1,5,12"
4063    
4064    6.7.5.  Getting MIDI instrument map information
4065    
4066       The front-end can ask for the current settings of a MIDI instrument
4067       map by sending the following command:
4068    
4069          GET MIDI_INSTRUMENT_MAP INFO <map>
4070    
4071       Where <map> is the numerical ID of the map the front-end is
4072       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4073       (Section 6.7.4) command.
4074    
4075       Possible Answers:
4076    
4077          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4078          answer line begins with the settings category name followed by a
4079          colon and then a space character <SP> and finally the info
4080          character string to that setting category.  At the moment the
4081          following categories are defined:
4082    
4083    
4084    
4085    
4086    
4087    Schoenebeck               Expires June 30, 2007                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol        December 2006
4090    
4091    
4092    
4093    
4094             NAME -
4095    
4096                custom name of the given map, which does not have to be
4097                unique
4098    
4099       The mentioned fields above don't have to be in particular order.
4100    
4101       Example:
4102    
4103          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4104    
4105          S: "NAME: Standard Map"
4106    
4107             "."
4108    
4109    6.7.6.  Renaming a MIDI instrument map
4110    
4111       The front-end can alter the custom name of a MIDI instrument map by
4112       sending the following command:
4113    
4114          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4115    
4116       Where <map> is the numerical ID of the map and <name> the new custom
4117       name of the map, which does not have to be unique.
4118    
4119       Possible Answers:
4120    
4121          "OK" -
4122    
4123             on success
4124    
4125          "ERR:<error-code>:<error-message>" -
4126    
4127             in case the given map does not exist
4128    
4129       Example:
4130    
4131          C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4132    
4133          S: "OK"
4134    
4135    6.7.7.  Create or replace a MIDI instrument map entry
4136    
4137       The front-end can create a new or replace an existing entry in a
4138       sampler's MIDI instrument map by sending the following command:
4139    
4140    
4141    
4142    
4143    Schoenebeck               Expires June 30, 2007                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol        December 2006
4146    
4147    
4148          MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>
4149          <filename> <instrument_index> <volume_value> [<instr_load_mode>]
4150          [<name>]
4151    
4152       Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4153       integer value between 0..16383 reflecting the MIDI bank select index,
4154       <midi_prog> an integer value between 0..127 reflecting the MIDI
4155       program change index, <engine_name> a sampler engine name as returned
4156       by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4157       encapsulated into apostrophes), <filename> the name of the
4158       instrument's file to be deployed (encapsulated into apostrophes),
4159       <instrument_index> the index (integer value) of the instrument within
4160       the given file, <volume_value> reflects the master volume of the
4161       instrument as optionally dotted number (where a value < 1.0 means
4162       attenuation and a value > 1.0 means amplification).  This parameter
4163       easily allows to adjust the volume of all intruments within a custom
4164       instrument map without having to adjust their instrument files.  The
4165       OPTIONAL <instr_load_mode> argument defines the life time of the
4166       instrument, that is when the instrument should be loaded, when freed
4167       and has exactly the following possibilities:
4168    
4169          "ON_DEMAND" -
4170    
4171             The instrument will be loaded when needed, that is when
4172             demanded by at least one sampler channel.  It will immediately
4173             be freed from memory when not needed by any sampler channel
4174             anymore.
4175    
4176          "ON_DEMAND_HOLD" -
4177    
4178             The instrument will be loaded when needed, that is when
4179             demanded by at least one sampler channel.  It will be kept in
4180             memory even when not needed by any sampler channel anymore.
4181             Instruments with this mode are only freed when the sampler is
4182             reset or all mapping entries with this mode (and respective
4183             instrument) are explicitly changed to "ON_DEMAND" and no
4184             sampler channel is using the instrument anymore.
4185    
4186          "PERSISTENT" -
4187    
4188             The instrument will immediately be loaded into memory in the
4189             background when this mapping command is sent and the instrument
4190             is kept all the time.  Instruments with this mode are only
4191             freed when the sampler is reset or all mapping entries with
4192             this mode (and respective instrument) are explicitly changed to
4193             "ON_DEMAND" and no sampler channel is using the instrument
4194             anymore.
4195    
4196    
4197    
4198    
4199    Schoenebeck               Expires June 30, 2007                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol        December 2006
4202    
4203    
4204          not supplied -
4205    
4206             In case there is no <instr_load_mode> argument given, it will
4207             be up to the InstrumentManager to decide which mode to use.
4208             Usually it will use "ON_DEMAND" if an entry for the given
4209             instrument does not exist in the InstrumentManager's list yet,
4210             otherwise if an entry already exists, it will simply stick with
4211             the mode currently reflected by the already existing entry,
4212             that is it will not change the mode.
4213    
4214       The <instr_load_mode> argument thus allows to define an appropriate
4215       strategy (low memory consumption vs. fast instrument switching) for
4216       each instrument individually.  Note, the following restrictions apply
4217       to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4218       supported by the respective sampler engine (which is technically the
4219       case when the engine provides an InstrumentManager for its format).
4220       If this is not the case the argument will automatically fall back to
4221       the default value "ON_DEMAND".  Also the load mode of one instrument
4222       may automatically change the laod mode of other instrument(s), i.e.
4223       because the instruments are part of the same file and the engine does
4224       not allow a way to manage load modes for them individually.  Due to
4225       this, in case the frontend shows the load modes of entries, the
4226       frontend should retrieve the actual mode by i.e. sending "GET
4227       MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4228       OPTIONAL <name> argument allows to set a custom name (encapsulated
4229       into apostrophes) for the mapping entry, useful for frontends for
4230       displaying an appropriate name for mapped instruments (using "GET
4231       MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4232    
4233       The "MAP MIDI_INSTRUMENT" command will immediately return, thus it
4234       will not block when an instrument is to be loaded due to a
4235       "PERSISTENT" type entry as instruments are loaded in the background.
4236       As a consequence this command may not necessarily return an error
4237       i.e. when the given instrument file does not exist or may turn out to
4238       be corrupt.
4239    
4240       Possible Answers:
4241    
4242          "OK" -
4243    
4244             usually
4245    
4246          "ERR:<error-code>:<error-message>" -
4247    
4248             when the given map or engine does not exist or a value is out
4249             of range
4250    
4251       Examples:
4252    
4253    
4254    
4255    Schoenebeck               Expires June 30, 2007                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol        December 2006
4258    
4259    
4260          C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4261          0.8 PERSISTENT"
4262    
4263          S: "OK"
4264    
4265          C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
4266          1.0"
4267    
4268          S: "OK"
4269    
4270          C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0
4271          'Normal Piano'"
4272    
4273          S: "OK"
4274    
4275          C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4276          'Silent Piano'"
4277    
4278          S: "OK"
4279    
4280          C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0
4281          PERSISTENT 'Foo Drumkit'"
4282    
4283          S: "OK"
4284    
4285    6.7.8.  Getting ammount of MIDI instrument map entries
4286    
4287       The front-end can query the amount of currently existing entries in a
4288       MIDI instrument map by sending the following command:
4289    
4290          GET MIDI_INSTRUMENTS <map>
4291    
4292       The front-end can query the amount of currently existing entries in
4293       all MIDI instrument maps by sending the following command:
4294    
4295          GET MIDI_INSTRUMENTS ALL
4296    
4297       Possible Answers:
4298    
4299          The sampler will answer by sending the current number of entries
4300          in the MIDI instrument map(s).
4301    
4302       Example:
4303    
4304          C: "GET MIDI_INSTRUMENTS 0"
4305    
4306          S: "234"
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires June 30, 2007                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol        December 2006
4314    
4315    
4316          C: "GET MIDI_INSTRUMENTS ALL"
4317    
4318          S: "954"
4319    
4320    6.7.9.  Getting indeces of all entries of a MIDI instrument map
4321    
4322       The front-end can query a list of all currently existing entries in a
4323       certain MIDI instrument map by sending the following command:
4324    
4325          LIST MIDI_INSTRUMENTS <map>
4326    
4327       Where <map> is the numeric ID of the MIDI instrument map.
4328    
4329       The front-end can query a list of all currently existing entries of
4330       all MIDI instrument maps by sending the following command:
4331    
4332          LIST MIDI_INSTRUMENTS ALL
4333    
4334       Possible Answers:
4335    
4336          The sampler will answer by sending a comma separated list of map
4337          ID - MIDI bank - MIDI program triples, where each triple is
4338          encapsulated into curly braces.  The list is returned in one
4339          single line.  Each triple just reflects the key of the respective
4340          map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4341          (Section 6.7.11) command(s) are necessary to retrieve detailed
4342          informations about each entry.
4343    
4344       Example:
4345    
4346          C: "LIST MIDI_INSTRUMENTS 0"
4347    
4348          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4349    
4350    6.7.10.  Remove an entry from the MIDI instrument map
4351    
4352       The front-end can delete an entry from a MIDI instrument map by
4353       sending the following command:
4354    
4355          UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4356    
4357       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4358       is an integer value between 0..16383 reflecting the MIDI bank value
4359       and <midi_prog> an integer value between 0..127 reflecting the MIDI
4360       program value of the map's entrie's key index triple.
4361    
4362       Possible Answers:
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires June 30, 2007                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol        December 2006
4370    
4371    
4372          "OK" -
4373    
4374             usually
4375    
4376          "ERR:<error-code>:<error-message>" -
4377    
4378             when index out of bounds
4379    
4380       Example:
4381    
4382          C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4383    
4384          S: "OK"
4385    
4386    6.7.11.  Get current settings of MIDI instrument map entry
4387    
4388       The front-end can retrieve the current settings of a certain
4389       instrument map entry by sending the following command:
4390    
4391          GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
4392    
4393       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4394       is an integer value between 0..16383 reflecting the MIDI bank value,
4395       <midi_bank> and <midi_prog> an integer value between 0..127
4396       reflecting the MIDI program value of the map's entrie's key index
4397       triple.
4398    
4399       Possible Answers:
4400    
4401          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4402          answer line begins with the information category name followed by
4403          a colon and then a space character <SP> and finally the info
4404          character string to that info category.  At the moment the
4405          following categories are defined:
4406    
4407          "NAME" -
4408    
4409             Name for this MIDI instrument map entry (if defined).  This
4410             name shall be used by frontends for displaying a name for this
4411             mapped instrument.  It can be set and changed with the "MAP
4412             MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4413             be unique.
4414    
4415          "ENGINE_NAME" -
4416    
4417             Name of the engine to be deployed for this instrument.
4418    
4419    
4420    
4421    
4422    
4423    Schoenebeck               Expires June 30, 2007                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol        December 2006
4426    
4427    
4428          "INSTRUMENT_FILE" -
4429    
4430             File name of the instrument.
4431    
4432          "INSTRUMENT_NR" -
4433    
4434             Index of the instrument within the file.
4435    
4436          "INSTRUMENT_NAME" -
4437    
4438             Name of the loaded instrument as reflected by its file.  In
4439             contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4440             cannot be changed.
4441    
4442          "LOAD_MODE" -
4443    
4444             Life time of instrument (see "MAP MIDI_INSTRUMENT"
4445             (Section 6.7.7) for details about this setting).
4446    
4447          "VOLUME" -
4448    
4449             master volume of the instrument as optionally dotted number
4450             (where a value < 1.0 means attenuation and a value > 1.0 means
4451             amplification)
4452    
4453          The mentioned fields above don't have to be in particular order.
4454    
4455       Example:
4456    
4457          C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4458    
4459          S: "NAME: Drums for Foo Song"
4460    
4461             "ENGINE_NAME: GigEngine"
4462    
4463             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4464    
4465             "INSTRUMENT_NR: 0"
4466    
4467             "INSTRUMENT_NAME: Joe's Drumkit"
4468    
4469             "LOAD_MODE: PERSISTENT"
4470    
4471             "VOLUME: 1.0"
4472    
4473             "."
4474    
4475    
4476    
4477    
4478    
4479    Schoenebeck               Expires June 30, 2007                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol        December 2006
4482    
4483    
4484    6.7.12.  Clear MIDI instrument map
4485    
4486       The front-end can clear a whole MIDI instrument map, that is delete
4487       all its entries by sending the following command:
4488    
4489          CLEAR MIDI_INSTRUMENTS <map>
4490    
4491       Where <map> is the numeric ID of the map to clear.
4492    
4493       The front-end can clear all MIDI instrument maps, that is delete all
4494       entries of all maps by sending the following command:
4495    
4496          CLEAR MIDI_INSTRUMENTS ALL
4497    
4498       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4499       only their entries, thus the map's settings like custom name will be
4500       preservevd.
4501    
4502       Possible Answers:
4503    
4504          "OK" -
4505    
4506             always
4507    
4508       Examples:
4509    
4510          C: "CLEAR MIDI_INSTRUMENTS 0"
4511    
4512          S: "OK"
4513    
4514          C: "CLEAR MIDI_INSTRUMENTS ALL"
4515    
4516          S: "OK"
4517    
4518    
4519    
4520    
4521    
4522    
4523    
4524    
4525    
4526    
4527    
4528    
4529    
4530    
4531    
4532    
4533    
4534    
4535    Schoenebeck               Expires June 30, 2007                [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4538    
4539    
4540  7.  Command Syntax  7.  Command Syntax
# Line 3565  Internet-Draft        LinuxSampler Contr Line 4573  Internet-Draft        LinuxSampler Contr
4573    
4574     command =     command =
4575    
4576        ADD SP CHANNEL        ADD SP add_instruction
4577    
4578          / MAP SP map_instruction
4579    
4580          / UNMAP SP unmap_instruction
4581    
4582        / GET SP get_instruction        / GET SP get_instruction
4583    
# Line 3573  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585    
4586        / DESTROY SP destroy_instruction        / DESTROY SP destroy_instruction
4587    
       / LIST SP list_instruction  
4588    
       / LOAD SP load_instruction  
4589    
4590    
4591    Schoenebeck               Expires June 30, 2007                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol        December 2006
4594    
4595    
4596  Schoenebeck               Expires May 29, 2007                 [Page 64]        / LIST SP list_instruction
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4597    
4598          / LOAD SP load_instruction
4599    
4600        / REMOVE SP CHANNEL SP sampler_channel        / REMOVE SP remove_instruction
4601    
4602        / SET SP set_instruction        / SET SP set_instruction
4603    
# Line 3595  Internet-Draft        LinuxSampler Contr Line 4607  Internet-Draft        LinuxSampler Contr
4607    
4608        / SELECT SP text        / SELECT SP text
4609    
4610        / RESET SP CHANNEL SP sampler_channel        / RESET SP reset_instruction
4611    
4612          / CLEAR SP clear_instruction
4613    
4614        / RESET        / RESET
4615    
4616        / QUIT        / QUIT
4617    
4618       add_instruction =
4619    
4620          CHANNEL
4621    
4622          / MIDI_INSTRUMENT_MAP
4623    
4624          / MIDI_INSTRUMENT_MAP SP map_name
4625    
4626     subscribe_event =     subscribe_event =
4627    
4628        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4629    
4630          / AUDIO_OUTPUT_DEVICE_INFO
4631    
4632          / MIDI_INPUT_DEVICE_COUNT
4633    
4634          / MIDI_INPUT_DEVICE_INFO
4635    
4636          / CHANNEL_COUNT
4637    
4638        / VOICE_COUNT        / VOICE_COUNT
4639    
# Line 3611  Internet-Draft        LinuxSampler Contr Line 4641  Internet-Draft        LinuxSampler Contr
4641    
4642        / BUFFER_FILL        / BUFFER_FILL
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires June 30, 2007                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol        December 2006
4650    
4651    
4652        / CHANNEL_INFO        / CHANNEL_INFO
4653    
4654          / MIDI_INSTRUMENT_MAP_COUNT
4655    
4656          / MIDI_INSTRUMENT_MAP_INFO
4657    
4658          / MIDI_INSTRUMENT_COUNT
4659    
4660          / MIDI_INSTRUMENT_INFO
4661    
4662        / MISCELLANEOUS        / MISCELLANEOUS
4663    
4664        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4665    
4666     unsubscribe_event =     unsubscribe_event =
4667    
4668        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4669    
4670          / AUDIO_OUTPUT_DEVICE_INFO
4671    
4672          / MIDI_INPUT_DEVICE_COUNT
4673    
4674          / MIDI_INPUT_DEVICE_INFO
4675    
4676          / CHANNEL_COUNT
4677    
4678        / VOICE_COUNT        / VOICE_COUNT
4679    
# Line 3629  Internet-Draft        LinuxSampler Contr Line 4683  Internet-Draft        LinuxSampler Contr
4683    
4684        / CHANNEL_INFO        / CHANNEL_INFO
4685    
4686          / MIDI_INSTRUMENT_MAP_COUNT
4687    
4688          / MIDI_INSTRUMENT_MAP_INFO
4689    
4690          / MIDI_INSTRUMENT_COUNT
4691    
4692          / MIDI_INSTRUMENT_INFO
4693    
4694        / MISCELLANEOUS        / MISCELLANEOUS
4695    
4696        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4697    
4698       map_instruction =
4699    
4700    
4701    
4702    
4703  Schoenebeck               Expires May 29, 2007                 [Page 65]  Schoenebeck               Expires June 30, 2007                [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4706    
4707    
4708          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4709          engine_name SP filename SP instrument_index SP volume_value
4710    
4711          / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4712          engine_name SP filename SP instrument_index SP volume_value SP
4713          instr_load_mode
4714    
4715          / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4716          engine_name SP filename SP instrument_index SP volume_value SP
4717          entry_name
4718    
4719          / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4720          engine_name SP filename SP instrument_index SP volume_value SP
4721          instr_load_mode SP entry_name
4722    
4723       unmap_instruction =
4724    
4725          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
4726    
4727       remove_instruction =
4728    
4729          CHANNEL SP sampler_channel
4730    
4731          / MIDI_INSTRUMENT_MAP SP midi_map
4732    
4733          / MIDI_INSTRUMENT_MAP SP ALL
4734    
4735     get_instruction =     get_instruction =
4736    
# Line 3663  Internet-Draft        LinuxSampler Contr Line 4754  Internet-Draft        LinuxSampler Contr
4754        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
4755        key_val_list        key_val_list
4756    
4757    
4758    
4759    Schoenebeck               Expires June 30, 2007                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol        December 2006
4762    
4763    
4764        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
4765    
4766        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
# Line 3688  Internet-Draft        LinuxSampler Contr Line 4786  Internet-Draft        LinuxSampler Contr
4786    
4787        / CHANNEL SP STREAM_COUNT SP sampler_channel        / CHANNEL SP STREAM_COUNT SP sampler_channel
4788    
4789          / CHANNEL SP VOICE_COUNT SP sampler_channel
4790    
4791          / ENGINE SP INFO SP engine_name
4792    
4793          / SERVER SP INFO
4794    
4795          / TOTAL_VOICE_COUNT
4796    
4797          / TOTAL_VOICE_COUNT_MAX
4798    
4799  Schoenebeck               Expires May 29, 2007                 [Page 66]        / MIDI_INSTRUMENTS SP midi_map
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4800    
4801          / MIDI_INSTRUMENTS SP ALL
4802    
4803        / CHANNEL SP VOICE_COUNT SP sampler_channel        / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
4804    
4805        / ENGINE SP INFO SP engine_name        / MIDI_INSTRUMENT_MAPS
4806    
4807        / SERVER SP INFO        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
4808    
4809        / TOTAL_VOICE_COUNT        / FX_SENDS SP sampler_channel
4810    
4811        / TOTAL_VOICE_COUNT_MAX  
4812    
4813    
4814    
4815    Schoenebeck               Expires June 30, 2007                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol        December 2006
4818    
4819    
4820          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
4821    
4822     set_instruction =     set_instruction =
4823    
# Line 3723  Internet-Draft        LinuxSampler Contr Line 4835  Internet-Draft        LinuxSampler Contr
4835    
4836        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
4837    
4838          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
4839    
4840          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
4841          SP audio_channel_index SP audio_channel_index
4842    
4843        / ECHO SP boolean        / ECHO SP boolean
4844    
4845     create_instruction =     create_instruction =
# Line 3735  Internet-Draft        LinuxSampler Contr Line 4852  Internet-Draft        LinuxSampler Contr
4852    
4853        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
4854    
4855     destroy_instruction =        / FX_SEND SP sampler_channel SP midi_ctrl
4856    
4857        AUDIO_OUTPUT_DEVICE SP number        / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
4858    
4859        / MIDI_INPUT_DEVICE SP number     reset_instruction =
4860    
4861     load_instruction =        CHANNEL SP sampler_channel
4862    
4863        INSTRUMENT SP load_instr_args     clear_instruction =
4864    
4865          MIDI_INSTRUMENTS SP midi_map
4866    
4867    
4868    
4869  Schoenebeck               Expires May 29, 2007                 [Page 67]  
4870    
4871    Schoenebeck               Expires June 30, 2007                [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4874    
4875    
4876          / MIDI_INSTRUMENTS SP ALL
4877    
4878       destroy_instruction =
4879    
4880          AUDIO_OUTPUT_DEVICE SP number
4881    
4882          / MIDI_INPUT_DEVICE SP number
4883    
4884          / FX_SEND SP sampler_channel SP fx_send_id
4885    
4886       load_instruction =
4887    
4888          INSTRUMENT SP load_instr_args
4889    
4890        / ENGINE SP load_engine_args        / ENGINE SP load_engine_args
4891    
# Line 3782  Internet-Draft        LinuxSampler Contr Line 4916  Internet-Draft        LinuxSampler Contr
4916    
4917        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
4918    
4919          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
4920    
4921          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires June 30, 2007                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol        December 2006
4930    
4931    
4932          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
4933    
4934     key_val_list =     key_val_list =
4935    
4936        string '=' param_val_list        string '=' param_val_list
# Line 3800  Internet-Draft        LinuxSampler Contr Line 4949  Internet-Draft        LinuxSampler Contr
4949    
4950        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
4951    
   
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
4952        / CHANNELS        / CHANNELS
4953    
4954        / AVAILABLE_ENGINES        / AVAILABLE_ENGINES
# Line 3817  Internet-Draft        LinuxSampler Contr Line 4957  Internet-Draft        LinuxSampler Contr
4957    
4958        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
4959    
4960          / MIDI_INSTRUMENTS SP midi_map
4961    
4962          / MIDI_INSTRUMENTS SP ALL
4963    
4964          / MIDI_INSTRUMENT_MAPS
4965    
4966          / FX_SENDS SP sampler_channel
4967    
4968     load_instr_args =     load_instr_args =
4969    
4970        filename SP instrument_index SP sampler_channel        filename SP instrument_index SP sampler_channel
# Line 3827  Internet-Draft        LinuxSampler Contr Line 4975  Internet-Draft        LinuxSampler Contr
4975    
4976        engine_name SP sampler_channel        engine_name SP sampler_channel
4977    
4978       instr_load_mode =
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires June 30, 2007                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol        December 2006
4986    
4987    
4988          ON_DEMAND
4989    
4990          / ON_DEMAND_HOLD
4991    
4992          / PERSISTENT
4993    
4994     device_index =     device_index =
4995    
4996        number        number
# Line 3853  Internet-Draft        LinuxSampler Contr Line 5017  Internet-Draft        LinuxSampler Contr
5017    
5018        string        string
5019    
5020     volume_value =     midi_map =
5021    
5022        dotnum        number
5023    
5024       midi_bank =
5025    
5026          number
5027    
5028       midi_prog =
5029    
5030          number
5031    
5032       midi_ctrl =
5033    
5034          number
5035    
5036    
5037    
5038    
5039  Schoenebeck               Expires May 29, 2007                 [Page 69]  Schoenebeck               Expires June 30, 2007                [Page 90]
5040    
5041  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5042    
5043    
5044       volume_value =
5045    
5046          dotnum
5047    
5048        / number        / number
5049    
5050     sampler_channel =     sampler_channel =
# Line 3875  Internet-Draft        LinuxSampler Contr Line 5055  Internet-Draft        LinuxSampler Contr
5055    
5056        number        number
5057    
5058       fx_send_id =
5059    
5060          number
5061    
5062     engine_name =     engine_name =
5063    
5064        string        string
# Line 3883  Internet-Draft        LinuxSampler Contr Line 5067  Internet-Draft        LinuxSampler Contr
5067    
5068        stringval        stringval
5069    
5070       map_name =
5071    
5072          stringval
5073    
5074       entry_name =
5075    
5076          stringval
5077    
5078       fx_send_name =
5079    
5080          stringval
5081    
5082     param_val_list =     param_val_list =
5083    
5084        param_val        param_val
# Line 3893  Internet-Draft        LinuxSampler Contr Line 5089  Internet-Draft        LinuxSampler Contr
5089    
5090        string        string
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires June 30, 2007                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol        December 2006
5098    
5099    
5100        / stringval        / stringval
5101    
5102        / number        / number
# Line 3916  Internet-Draft        LinuxSampler Contr Line 5120  Internet-Draft        LinuxSampler Contr
5120    
5121    
5122    
5123  Schoenebeck               Expires May 29, 2007                 [Page 70]  
5124    
5125    
5126    
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 30, 2007                [Page 92]
5152    
5153  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5154    
5155    
5156  8.  Events  8.  Events
# Line 3926  Internet-Draft        LinuxSampler Contr Line 5158  Internet-Draft        LinuxSampler Contr
5158     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
5159     LinuxSampler.     LinuxSampler.
5160    
5161  8.1.  Number of sampler channels changed  8.1.  Number of audio output devices changed
5162    
5163       Client may want to be notified when the total number of audio output
5164       devices on the back-end changes by issuing the following command:
5165    
5166          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
5167    
5168       Server will start sending the following notification messages:
5169    
5170          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
5171    
5172       where <devices> will be replaced by the new number of audio output
5173       devices.
5174    
5175    8.2.  Audio output device's settings changed
5176    
5177       Client may want to be notified when changes were made to audio output
5178       devices on the back-end by issuing the following command:
5179    
5180          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
5181    
5182       Server will start sending the following notification messages:
5183    
5184          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
5185    
5186       where <device-id> will be replaced by the numerical ID of the audio
5187       output device, which settings has been changed.  The front-end will
5188       have to send the respective command to actually get the audio output
5189       device info.  Because these messages will be triggered by LSCP
5190       commands issued by other clients rather than real time events
5191       happening on the server, it is believed that an empty notification
5192       message is sufficient here.
5193    
5194    8.3.  Number of MIDI input devices changed
5195    
5196       Client may want to be notified when the total number of MIDI input
5197       devices on the back-end changes by issuing the following command:
5198    
5199          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
5200    
5201       Server will start sending the following notification messages:
5202    
5203    
5204    
5205    
5206    
5207    Schoenebeck               Expires June 30, 2007                [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol        December 2006
5210    
5211    
5212          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
5213    
5214       where <devices> will be replaced by the new number of MIDI input
5215       devices.
5216    
5217    8.4.  MIDI input device's settings changed
5218    
5219       Client may want to be notified when changes were made to MIDI input
5220       devices on the back-end by issuing the following command:
5221    
5222          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
5223    
5224       Server will start sending the following notification messages:
5225    
5226          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
5227    
5228       where <device-id> will be replaced by the numerical ID of the MIDI
5229       input device, which settings has been changed.  The front-end will
5230       have to send the respective command to actually get the MIDI input
5231       device info.  Because these messages will be triggered by LSCP
5232       commands issued by other clients rather than real time events
5233       happening on the server, it is believed that an empty notification
5234       message is sufficient here.
5235    
5236    8.5.  Number of sampler channels changed
5237    
5238     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
5239     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 5247  Internet-Draft        LinuxSampler Contr
5247     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
5248     channels.     channels.
5249    
5250  8.2.  Number of active voices changed  8.6.  Number of active voices changed
5251    
5252     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-
5253     end changes by issuing the following command:     end changes by issuing the following command:
# Line 3949  Internet-Draft        LinuxSampler Contr Line 5256  Internet-Draft        LinuxSampler Contr
5256    
5257     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires June 30, 2007                [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol        December 2006
5266    
5267    
5268        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>
5269    
5270     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5271     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
5272     voices on that channel.     voices on that channel.
5273    
5274  8.3.  Number of active disk streams changed  8.7.  Number of active disk streams changed
5275    
5276     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
5277     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 5285  Internet-Draft        LinuxSampler Contr
5285    
5286     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5287     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck               Expires May 29, 2007                 [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
5288     active disk streams on that channel.     active disk streams on that channel.
5289    
5290  8.4.  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
5291    
5292     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
5293     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 5304  Internet-Draft        LinuxSampler Contr
5304     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
5305     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
5306    
5307  8.5.  Channel information changed  8.9.  Channel information changed
5308    
5309     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
5310     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 5313  Internet-Draft        LinuxSampler Contr
5313    
5314     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5315    
5316    
5317    
5318    
5319    Schoenebeck               Expires June 30, 2007                [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol        December 2006
5322    
5323    
5324        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
5325    
5326     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 5330  Internet-Draft        LinuxSampler Contr
5330     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
5331     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
5332    
5333  8.6.  Total number of active voices changed  8.10.  Total number of active voices changed
5334    
5335     Client may want to be notified when the total number of voices on the     Client may want to be notified when the total number of voices on the
5336     back-end changes by issuing the following command:     back-end changes by issuing the following command:
# Line 4023  Internet-Draft        LinuxSampler Contr Line 5339  Internet-Draft        LinuxSampler Contr
5339    
5340     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5341    
5342          "NOTIFY:TOTAL_VOICE_COUNT:<voices>
5343    
5344       where <voices> will be replaced by the new number of all currently
5345       active voices.
5346    
5347    8.11.  Number of MIDI instrument maps changed
5348    
5349       Client may want to be notified when the number of MIDI instrument
5350       maps on the back-end changes by issuing the following command:
5351    
5352          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
5353    
5354       Server will start sending the following notification messages:
5355    
5356          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
5357    
5358       where <maps> will be replaced by the new number of MIDI instrument
5359       maps.
5360    
5361    8.12.  MIDI instrument map information changed
5362    
5363       Client may want to be notified when changes were made to MIDI
5364       instrument maps on the back-end by issuing the following command:
5365    
5366          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
5367    
5368       Server will start sending the following notification messages:
5369    
5370    
5371    
5372    
5373  Schoenebeck               Expires May 29, 2007                 [Page 72]  
5374    
5375    Schoenebeck               Expires June 30, 2007                [Page 96]
5376    
5377  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5378    
5379    
5380        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
5381    
5382       where <map-id> will be replaced by the numerical ID of the MIDI
5383       instrument map, for which information changes occurred.  The front-
5384       end will have to send the respective command to actually get the MIDI
5385       instrument map info.  Because these messages will be triggered by
5386       LSCP commands issued by other clients rather than real time events
5387       happening on the server, it is believed that an empty notification
5388       message is sufficient here.
5389    
5390    8.13.  Number of MIDI instruments changed
5391    
5392       Client may want to be notified when the number of MIDI instrument
5393       maps on the back-end changes by issuing the following command:
5394    
5395          SUBSCRIBE MIDI_INSTRUMENT_COUNT
5396    
5397       Server will start sending the following notification messages:
5398    
5399          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
5400    
5401       where <map-id> is the numerical ID of the MIDI instrument map, in
5402       which the nuber of instruments has changed and <instruments> will be
5403       replaced by the new number of MIDI instruments in the specified map.
5404    
5405    8.14.  MIDI instrument information changed
5406    
5407       Client may want to be notified when changes were made to MIDI
5408       instruments on the back-end by issuing the following command:
5409    
5410          SUBSCRIBE MIDI_INSTRUMENT_INFO
5411    
5412       Server will start sending the following notification messages:
5413    
5414          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
5415    
5416       where <map-id> will be replaced by the numerical ID of the MIDI
5417       instrument map, in which a MIDI instrument is changed. <bank> and
5418       <program> specifies the location of the changed MIDI instrument in
5419       the map.  The front-end will have to send the respective command to
5420       actually get the MIDI instrument info.  Because these messages will
5421       be triggered by LSCP commands issued by other clients rather than
5422       real time events happening on the server, it is believed that an
5423       empty notification message is sufficient here.
5424    
5425    
5426    
5427    
5428    
5429    
5430    
5431    Schoenebeck               Expires June 30, 2007                [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol        December 2006
5434    
    where <voices> will be replaced by the new number of all currently  
    active voices.  
5435    
5436  8.7.  Miscellaneous and debugging events  8.15.  Miscellaneous and debugging events
5437    
5438     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
5439     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 4084  Internet-Draft        LinuxSampler Contr Line 5479  Internet-Draft        LinuxSampler Contr
5479    
5480    
5481    
5482  Schoenebeck               Expires May 29, 2007                 [Page 73]  
5483    
5484    
5485    
5486    
5487    Schoenebeck               Expires June 30, 2007                [Page 98]
5488    
5489  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5490    
5491    
5492  9.  Security Considerations  9.  Security Considerations
# Line 4140  Internet-Draft        LinuxSampler Contr Line 5540  Internet-Draft        LinuxSampler Contr
5540    
5541    
5542    
5543  Schoenebeck               Expires May 29, 2007                 [Page 74]  Schoenebeck               Expires June 30, 2007                [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5546    
5547    
5548  10.  Acknowledgments  10.  Acknowledgments
# Line 4160  Internet-Draft        LinuxSampler Contr Line 5560  Internet-Draft        LinuxSampler Contr
5560        Grigor Iliev        Grigor Iliev
5561    
5562    
 11.  References  
5563    
    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate  
               Requirement Levels", RFC 2119, 1997.  
5564    
    [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax  
               Specifications", RFC 2234, 1997.  
5565    
    [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION  
               CONTROL PROTOCOL", RFC 793, 1981.  
5566    
5567    
5568    
# Line 4196  Internet-Draft        LinuxSampler Contr Line 5589  Internet-Draft        LinuxSampler Contr
5589    
5590    
5591    
5592  Schoenebeck               Expires May 29, 2007                 [Page 75]  
5593    
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck               Expires June 30, 2007               [Page 100]
5600    
5601  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5602    
5603    
5604  Author's Address  11.  References
5605    
5606     C. Schoenebeck     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
5607     Interessengemeinschaft Software Engineering e. V.                Requirement Levels", RFC 2119, 1997.
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
5608    
5609     Email: schoenebeck at software minus engineering dot org     [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
5610                  Specifications", RFC 2234, 1997.
5611    
5612       [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION
5613                  CONTROL PROTOCOL", RFC 793, 1981.
5614    
5615    
5616    
# Line 4252  Author's Address Line 5652  Author's Address
5652    
5653    
5654    
5655  Schoenebeck               Expires May 29, 2007                 [Page 76]  Schoenebeck               Expires June 30, 2007               [Page 101]
5656    
5657  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5658    
5659    
5660  Intellectual Property Statement  Author's Address
5661    
5662     The IETF takes no position regarding the validity or scope of any     C. Schoenebeck
5663     intellectual property or other rights that might be claimed to     Interessengemeinschaft Software Engineering e. V.
5664     pertain to the implementation or use of the technology described in     Max-Planck-Str. 39
5665     this document or the extent to which any license under such rights     74081 Heilbronn
5666     might or might not be available; neither does it represent that it     Germany
    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.  
5667    
5668     The IETF invites any interested party to bring to its attention any     Email: schoenebeck at software minus engineering dot org
    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.  
5669    
5670    
 Full Copyright Statement  
5671    
    Copyright (C) The Internet Society (2006).  All Rights Reserved.  
5672    
    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.  
5673    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
5674    
    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  
5675    
5676    
5677    
 Schoenebeck               Expires May 29, 2007                 [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5678    
5679    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
5680    
5681    
 Acknowledgment  
5682    
    Funding for the RFC Editor function is currently provided by the  
    Internet Society.  
5683    
5684    
5685    
# Line 4349  Acknowledgment Line 5708  Acknowledgment
5708    
5709    
5710    
5711    Schoenebeck               Expires June 30, 2007               [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol        December 2006
5714    
5715    
5716    Full Copyright Statement
5717    
5718       Copyright (C) The Internet Society (2006).
5719    
5720       This document is subject to the rights, licenses and restrictions
5721       contained in BCP 78, and except as set forth therein, the authors
5722       retain all their rights.
5723    
5724       This document and the information contained herein are provided on an
5725       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
5726       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
5727       ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
5728       INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
5729       INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
5730       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
5731    
5732    
5733    Intellectual Property
5734    
5735       The IETF takes no position regarding the validity or scope of any
5736       Intellectual Property Rights or other rights that might be claimed to
5737       pertain to the implementation or use of the technology described in
5738       this document or the extent to which any license under such rights
5739       might or might not be available; nor does it represent that it has
5740       made any independent effort to identify any such rights.  Information
5741       on the procedures with respect to rights in RFC documents can be
5742       found in BCP 78 and BCP 79.
5743    
5744       Copies of IPR disclosures made to the IETF Secretariat and any
5745       assurances of licenses to be made available, or the result of an
5746       attempt made to obtain a general license or permission for the use of
5747       such proprietary rights by implementers or users of this
5748       specification can be obtained from the IETF on-line IPR repository at
5749       http://www.ietf.org/ipr.
5750    
5751       The IETF invites any interested party to bring to its attention any
5752       copyrights, patents or patent applications, or other proprietary
5753       rights that may cover technology that may be required to implement
5754       this standard.  Please address the information to the IETF at
5755       ietf-ipr@ietf.org.
5756    
5757    
5758    Acknowledgment
5759    
5760       Funding for the RFC Editor function is provided by the IETF
5761       Administrative Support Activity (IASA).
5762    
5763    
5764    
5765    
5766    
5767  Schoenebeck               Expires May 29, 2007                 [Page 78]  Schoenebeck               Expires June 30, 2007               [Page 103]
5768    
Legend:
Removed from v.940  
changed lines
  Added in v.1002
  ViewVC Help
Powered by ViewVC