/[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 945 by schoenebeck, Sun Nov 26 16:39:49 2006 UTC revision 1110 by iliev, Thu Mar 22 21:12:10 2007 UTC
# Line 3  Line 3 
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Expires: May 30, 2007                                  Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                         November 26, 2006  Expires: September 23, 2007                               March 22, 2007
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
# Line 12  Expires: May 30, 2007 Line 12  Expires: May 30, 2007
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 30, 2007.     This Internet-Draft will expire on September 23, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2006).  All Rights Reserved.     Copyright (C) The IETF Trust (2007).
   
 Abstract  
   
    The LinuxSampler Control Protocol (LSCP) is an application-level  
    protocol primarily intended for local and remote controlling the  
    LinuxSampler backend application, which is a sophisticated server-  
    like console application essentially playing back audio samples and  
    manipulating the samples in real time to certain extent.  
   
   
41    
42    
43    
44    
45    
46    
 Schoenebeck               Expires May 30, 2007                  [Page 1]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
47    
 Table of Contents  
48    
    1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  5  
    2.  Versioning of this specification . . . . . . . . . . . . . . .  6  
    3.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  7  
    4.  Focus of this protocol . . . . . . . . . . . . . . . . . . . .  8  
    5.  Communication Overview . . . . . . . . . . . . . . . . . . . .  9  
      5.1.  Request/response communication method  . . . . . . . . . .  9  
        5.1.1.  Result format  . . . . . . . . . . . . . . . . . . . . 10  
      5.2.  Subscribe/notify communication method  . . . . . . . . . . 12  
    6.  Description for control commands . . . . . . . . . . . . . . . 14  
      6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 14  
      6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 14  
        6.2.1.  Getting amount of available audio output drivers . . . 14  
        6.2.2.  Getting all available audio output drivers . . . . . . 15  
        6.2.3.  Getting information about a specific audio output  
                driver . . . . . . . . . . . . . . . . . . . . . . . . 15  
        6.2.4.  Getting information about specific audio output  
                driver parameter . . . . . . . . . . . . . . . . . . . 16  
        6.2.5.  Creating an audio output device  . . . . . . . . . . . 20  
        6.2.6.  Destroying an audio output device  . . . . . . . . . . 21  
        6.2.7.  Getting all created audio output device count  . . . . 22  
        6.2.8.  Getting all created audio output device list . . . . . 22  
        6.2.9.  Getting current settings of an audio output device . . 22  
        6.2.10. Changing settings of audio output devices  . . . . . . 24  
        6.2.11. Getting information about an audio channel . . . . . . 24  
        6.2.12. Getting information about specific audio channel  
                parameter  . . . . . . . . . . . . . . . . . . . . . . 26  
        6.2.13. Changing settings of audio output channels . . . . . . 28  
      6.3.  Configuring MIDI input drivers . . . . . . . . . . . . . . 29  
        6.3.1.  Getting amount of available MIDI input drivers . . . . 30  
        6.3.2.  Getting all available MIDI input drivers . . . . . . . 30  
        6.3.3.  Getting information about a specific MIDI input  
                driver . . . . . . . . . . . . . . . . . . . . . . . . 30  
        6.3.4.  Getting information about specific MIDI input  
                driver parameter . . . . . . . . . . . . . . . . . . . 31  
        6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 34  
        6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 35  
        6.3.7.  Getting all created MIDI input device count  . . . . . 36  
        6.3.8.  Getting all created MIDI input device list . . . . . . 36  
        6.3.9.  Getting current settings of a MIDI input device  . . . 36  
        6.3.10. Changing settings of MIDI input devices  . . . . . . . 38  
        6.3.11. Getting information about a MIDI port  . . . . . . . . 38  
        6.3.12. Getting information about specific MIDI port  
                parameter  . . . . . . . . . . . . . . . . . . . . . . 39  
        6.3.13. Changing settings of MIDI input ports  . . . . . . . . 41  
      6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 42  
        6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 42  
49    
50    
51    
 Schoenebeck               Expires May 30, 2007                  [Page 2]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
        6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 43  
        6.4.3.  Getting all created sampler channel count  . . . . . . 44  
        6.4.4.  Getting all created sampler channel list . . . . . . . 44  
        6.4.5.  Adding a new sampler channel . . . . . . . . . . . . . 44  
        6.4.6.  Removing a sampler channel . . . . . . . . . . . . . . 45  
        6.4.7.  Getting amount of available engines  . . . . . . . . . 46  
        6.4.8.  Getting all available engines  . . . . . . . . . . . . 46  
        6.4.9.  Getting information about an engine  . . . . . . . . . 47  
        6.4.10. Getting sampler channel information  . . . . . . . . . 48  
        6.4.11. Current number of active voices  . . . . . . . . . . . 51  
        6.4.12. Current number of active disk streams  . . . . . . . . 51  
        6.4.13. Current fill state of disk stream buffers  . . . . . . 51  
        6.4.14. Setting audio output device  . . . . . . . . . . . . . 52  
        6.4.15. Setting audio output type  . . . . . . . . . . . . . . 53  
        6.4.16. Setting audio output channel . . . . . . . . . . . . . 54  
        6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 55  
        6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 55  
        6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 56  
        6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57  
        6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 57  
        6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58  
        6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 59  
        6.4.24. Resetting a sampler channel  . . . . . . . . . . . . . 59  
      6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 60  
        6.5.1.  Register front-end for receiving event messages  . . . 60  
        6.5.2.  Unregister front-end for not receiving event  
                messages . . . . . . . . . . . . . . . . . . . . . . . 61  
        6.5.3.  Enable or disable echo of commands . . . . . . . . . . 62  
        6.5.4.  Close client connection  . . . . . . . . . . . . . . . 62  
      6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 62  
        6.6.1.  Current number of active voices  . . . . . . . . . . . 62  
        6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 63  
        6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 63  
        6.6.4.  General sampler informations . . . . . . . . . . . . . 63  
      6.7.  MIDI Instrument Mapping  . . . . . . . . . . . . . . . . . 64  
        6.7.1.  Create or replace a MIDI instrument map entry  . . . . 64  
        6.7.2.  Getting ammount of MIDI instrument map entries . . . . 67  
        6.7.3.  Getting indeces of all MIDI instrument map entries . . 67  
        6.7.4.  Remove an entry from the MIDI instrument map . . . . . 68  
        6.7.5.  Get current settings of MIDI instrument map entry  . . 69  
        6.7.6.  Clear MIDI instrument map  . . . . . . . . . . . . . . 70  
    7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 72  
    8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81  
      8.1.  Number of sampler channels changed . . . . . . . . . . . . 81  
      8.2.  Number of active voices changed  . . . . . . . . . . . . . 81  
      8.3.  Number of active disk streams changed  . . . . . . . . . . 81  
      8.4.  Disk stream buffer fill state changed  . . . . . . . . . . 82  
      8.5.  Channel information changed  . . . . . . . . . . . . . . . 82  
52    
53    
54    
55  Schoenebeck               Expires May 30, 2007                  [Page 3]  Schoenebeck            Expires September 23, 2007               [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
   
   
      8.6.  Total number of active voices changed  . . . . . . . . . . 82  
      8.7.  Miscellaneous and debugging events . . . . . . . . . . . . 83  
    9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 84  
    10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 85  
    11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 85  
    Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 86  
    Intellectual Property and Copyright Statements . . . . . . . . . . 87  
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
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
70    
71       1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5
72       2.  Versioning of this specification  . . . . . . . . . . . . . .   6
73       3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7
74       4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8
75       5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9
76         5.1.  Request/response communication method . . . . . . . . . .   9
77           5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10
78         5.2.  Subscribe/notify communication method . . . . . . . . . .  12
79       6.  Description for control commands  . . . . . . . . . . . . . .  14
80         6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14
81         6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14
82           6.2.1.  Getting amount of available audio output drivers  . .  15
83           6.2.2.  Getting all available audio output drivers  . . . . .  15
84           6.2.3.  Getting information about a specific audio output
85                   driver  . . . . . . . . . . . . . . . . . . . . . . .  15
86           6.2.4.  Getting information about specific audio output
87                   driver parameter  . . . . . . . . . . . . . . . . . .  16
88           6.2.5.  Creating an audio output device . . . . . . . . . . .  20
89           6.2.6.  Destroying an audio output device . . . . . . . . . .  21
90           6.2.7.  Getting all created audio output device count . . . .  22
91           6.2.8.  Getting all created audio output device list  . . . .  22
92           6.2.9.  Getting current settings of an audio output device  .  22
93           6.2.10. Changing settings of audio output devices . . . . . .  24
94           6.2.11. Getting information about an audio channel  . . . . .  25
95           6.2.12. Getting information about specific audio channel
96                   parameter . . . . . . . . . . . . . . . . . . . . . .  26
97           6.2.13. Changing settings of audio output channels  . . . . .  28
98         6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29
99           6.3.1.  Getting amount of available MIDI input drivers  . . .  30
100           6.3.2.  Getting all available MIDI input drivers  . . . . . .  30
101           6.3.3.  Getting information about a specific MIDI input
102                   driver  . . . . . . . . . . . . . . . . . . . . . . .  31
103           6.3.4.  Getting information about specific MIDI input
104                   driver parameter  . . . . . . . . . . . . . . . . . .  32
105           6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34
106           6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35
107           6.3.7.  Getting all created MIDI input device count . . . . .  36
108    
109    
110    
111    Schoenebeck            Expires September 23, 2007               [Page 2]
112    
113    Internet-Draft        LinuxSampler Control Protocol           March 2007
114    
115    
116           6.3.8.  Getting all created MIDI input device list  . . . . .  36
117           6.3.9.  Getting current settings of a MIDI input device . . .  37
118           6.3.10. Changing settings of MIDI input devices . . . . . . .  38
119           6.3.11. Getting information about a MIDI port . . . . . . . .  38
120           6.3.12. Getting information about specific MIDI port
121                   parameter . . . . . . . . . . . . . . . . . . . . . .  39
122           6.3.13. Changing settings of MIDI input ports . . . . . . . .  41
123         6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42
124           6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42
125           6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43
126           6.4.3.  Getting all created sampler channel count . . . . . .  44
127           6.4.4.  Getting all created sampler channel list  . . . . . .  44
128           6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44
129           6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45
130           6.4.7.  Getting amount of available engines . . . . . . . . .  46
131           6.4.8.  Getting all available engines . . . . . . . . . . . .  46
132           6.4.9.  Getting information about an engine . . . . . . . . .  47
133           6.4.10. Getting sampler channel information . . . . . . . . .  48
134           6.4.11. Current number of active voices . . . . . . . . . . .  51
135           6.4.12. Current number of active disk streams . . . . . . . .  51
136           6.4.13. Current fill state of disk stream buffers . . . . . .  52
137           6.4.14. Setting audio output device . . . . . . . . . . . . .  53
138           6.4.15. Setting audio output type . . . . . . . . . . . . . .  53
139           6.4.16. Setting audio output channel  . . . . . . . . . . . .  54
140           6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  55
141           6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  56
142           6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56
143           6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57
144           6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58
145           6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58
146           6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59
147           6.4.24. Assigning a MIDI instrument map to a sampler
148                   channel . . . . . . . . . . . . . . . . . . . . . . .  60
149           6.4.25. 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. Altering effect send's MIDI controller  . . . . . . .  66
156           6.4.32. Altering effect send's send level . . . . . . . . . .  67
157           6.4.33. Resetting a sampler channel . . . . . . . . . . . . .  68
158         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  68
159           6.5.1.  Register front-end for receiving event messages . . .  68
160           6.5.2.  Unregister front-end for not receiving event
161                   messages  . . . . . . . . . . . . . . . . . . . . . .  69
162           6.5.3.  Enable or disable echo of commands  . . . . . . . . .  70
163           6.5.4.  Close client connection . . . . . . . . . . . . . . .  70
164    
165    
166    
167    Schoenebeck            Expires September 23, 2007               [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol           March 2007
170    
171    
172         6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  71
173           6.6.1.  Current number of active voices . . . . . . . . . . .  71
174           6.6.2.  Maximum amount of active voices . . . . . . . . . . .  71
175           6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  71
176           6.6.4.  General sampler informations  . . . . . . . . . . . .  72
177           6.6.5.  Getting global volume attenuation . . . . . . . . . .  72
178           6.6.6.  Setting global volume attenuation . . . . . . . . . .  73
179         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  73
180           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  74
181           6.7.2.  Delete one particular or all MIDI instrument maps . .  75
182           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  75
183           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  76
184           6.7.5.  Getting MIDI instrument map information . . . . . . .  76
185           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  77
186           6.7.7.  Create or replace a MIDI instrument map entry . . . .  77
187           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  80
188           6.7.9.  Getting indeces of all entries of a MIDI
189                   instrument map  . . . . . . . . . . . . . . . . . . .  81
190           6.7.10. Remove an entry from the MIDI instrument map  . . . .  82
191           6.7.11. Get current settings of MIDI instrument map entry . .  82
192           6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  84
193       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  85
194       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  96
195         8.1.  Number of audio output devices changed  . . . . . . . . .  96
196         8.2.  Audio output device's settings changed  . . . . . . . . .  96
197         8.3.  Number of MIDI input devices changed  . . . . . . . . . .  96
198         8.4.  MIDI input device's settings changed  . . . . . . . . . .  97
199         8.5.  Number of sampler channels changed  . . . . . . . . . . .  97
200         8.6.  Number of active voices changed . . . . . . . . . . . . .  97
201         8.7.  Number of active disk streams changed . . . . . . . . . .  98
202         8.8.  Disk stream buffer fill state changed . . . . . . . . . .  98
203         8.9.  Channel information changed . . . . . . . . . . . . . . .  98
204         8.10. Number of effect sends changed  . . . . . . . . . . . . .  99
205         8.11. Effect send information changed . . . . . . . . . . . . .  99
206         8.12. Total number of active voices changed . . . . . . . . . .  99
207         8.13. Number of MIDI instrument maps changed  . . . . . . . . . 100
208         8.14. MIDI instrument map information changed . . . . . . . . . 100
209         8.15. Number of MIDI instruments changed  . . . . . . . . . . . 100
210         8.16. MIDI instrument information changed . . . . . . . . . . . 101
211         8.17. Global settings changed . . . . . . . . . . . . . . . . . 101
212         8.18. Miscellaneous and debugging events  . . . . . . . . . . . 102
213       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 103
214       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 104
215       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 105
216       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 106
217       Intellectual Property and Copyright Statements  . . . . . . . . . 107
218    
219    
220    
221    
222    
223  Schoenebeck               Expires May 30, 2007                  [Page 4]  Schoenebeck            Expires September 23, 2007               [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
226    
227    
228  1.  Requirements notation  1.  Requirements notation
# Line 276  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck               Expires May 30, 2007                  [Page 5]  Schoenebeck            Expires September 23, 2007               [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
282    
283    
284  2.  Versioning of this specification  2.  Versioning of this specification
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires May 30, 2007                  [Page 6]  Schoenebeck            Expires September 23, 2007               [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
338    
339    
340  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires May 30, 2007                  [Page 7]  Schoenebeck            Expires September 23, 2007               [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
394    
395    
396  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires May 30, 2007                  [Page 8]  Schoenebeck            Expires September 23, 2007               [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
450    
451    
452  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires May 30, 2007                  [Page 9]  Schoenebeck            Expires September 23, 2007               [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
506    
507    
508  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires May 30, 2007                 [Page 10]  Schoenebeck            Expires September 23, 2007              [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
562    
563    
564     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires May 30, 2007                 [Page 11]  Schoenebeck            Expires September 23, 2007              [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
618    
619    
620     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires May 30, 2007                 [Page 12]  Schoenebeck            Expires September 23, 2007              [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires May 30, 2007                 [Page 13]  Schoenebeck            Expires September 23, 2007              [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
730    
731    
732  6.  Description for control commands  6.  Description for control commands
# Line 774  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 30, 2007                 [Page 14]  
782    
783    Schoenebeck            Expires September 23, 2007              [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 833  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839    Schoenebeck            Expires September 23, 2007              [Page 15]
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 15]  
840    
841  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
842    
843    
844        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires May 30, 2007                 [Page 16]  Schoenebeck            Expires September 23, 2007              [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
898    
899    
900     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires May 30, 2007                 [Page 17]  Schoenebeck            Expires September 23, 2007              [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
954    
955    
956        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires May 30, 2007                 [Page 18]  Schoenebeck            Expires September 23, 2007              [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1010    
1011    
1012           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires May 30, 2007                 [Page 19]  Schoenebeck            Expires September 23, 2007              [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1066    
1067    
1068           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires May 30, 2007                 [Page 20]  Schoenebeck            Expires September 23, 2007              [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1122    
1123    
1124           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires May 30, 2007                 [Page 21]  Schoenebeck            Expires September 23, 2007              [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1178    
1179    
1180        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires May 30, 2007                 [Page 22]  Schoenebeck            Expires September 23, 2007              [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1234    
1235    
1236     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires May 30, 2007                 [Page 23]  Schoenebeck            Expires September 23, 2007              [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1290    
1291    
1292           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1333  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 30, 2007                 [Page 24]  
1342    
1343    Schoenebeck            Expires September 23, 2007              [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 1390  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 30, 2007                 [Page 25]  Schoenebeck            Expires September 23, 2007              [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 1447  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 30, 2007                 [Page 26]  Schoenebeck            Expires September 23, 2007              [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 1506  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511    Schoenebeck            Expires September 23, 2007              [Page 27]
   
 Schoenebeck               Expires May 30, 2007                 [Page 27]  
1512    
1513  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1514    
1515    
1516           RANGE_MAX -           RANGE_MAX -
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck               Expires May 30, 2007                 [Page 28]  Schoenebeck            Expires September 23, 2007              [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1570    
1571    
1572        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires May 30, 2007                 [Page 29]  Schoenebeck            Expires September 23, 2007              [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
1626    
1627    
1628     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1669  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 30, 2007                 [Page 30]  
1677    
1678    
1679    Schoenebeck            Expires September 23, 2007              [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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    
# Line 1724  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 September 23, 2007              [Page 31]
1736    
1737    Internet-Draft        LinuxSampler Control Protocol           March 2007
1738    
1739    
1740  Schoenebeck               Expires May 30, 2007                 [Page 31]  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 1781  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 May 30, 2007                 [Page 32]  Schoenebeck            Expires September 23, 2007              [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 1837  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 30, 2007                 [Page 33]  Schoenebeck            Expires September 23, 2007              [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 1893  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 30, 2007                 [Page 34]  Schoenebeck            Expires September 23, 2007              [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 1947  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 September 23, 2007              [Page 35]
1960    
1961    Internet-Draft        LinuxSampler Control Protocol           March 2007
1962    
1963    
1964  Schoenebeck               Expires May 30, 2007                 [Page 35]           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 2003  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 September 23, 2007              [Page 36]
2016    
2017    Internet-Draft        LinuxSampler Control Protocol           March 2007
2018    
2019    
2020  Schoenebeck               Expires May 30, 2007                 [Page 36]  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 2060  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 September 23, 2007              [Page 37]
2072    
2073    Internet-Draft        LinuxSampler Control Protocol           March 2007
2074    
2075    
2076  Schoenebeck               Expires May 30, 2007                 [Page 37]           "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 2117  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 30, 2007                 [Page 38]  Schoenebeck            Expires September 23, 2007              [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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
# Line 2172  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 30, 2007                 [Page 39]  Schoenebeck            Expires September 23, 2007              [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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    
# Line 2227  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 September 23, 2007              [Page 40]
2240    
2241    Internet-Draft        LinuxSampler Control Protocol           March 2007
2242    
2243    
2244             returned, dependent to device and port parameter)
2245    
2246  Schoenebeck               Expires May 30, 2007                 [Page 40]     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 2282  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 September 23, 2007              [Page 41]
2296    
2297    Internet-Draft        LinuxSampler Control Protocol           March 2007
2298    
2299    
2300  Schoenebeck               Expires May 30, 2007                 [Page 41]           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 2340  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 30, 2007                 [Page 42]  Schoenebeck            Expires September 23, 2007              [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 2398  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 May 30, 2007                 [Page 43]  Schoenebeck            Expires September 23, 2007              [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 2454  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 30, 2007                 [Page 44]  Schoenebeck            Expires September 23, 2007              [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 2513  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519    Schoenebeck            Expires September 23, 2007              [Page 45]
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 45]  
2520    
2521  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
2522    
2523    
2524        "OK" -        "OK" -
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck               Expires May 30, 2007                 [Page 46]  Schoenebeck            Expires September 23, 2007              [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 2628  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires May 30, 2007                 [Page 47]  Schoenebeck            Expires September 23, 2007              [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
2634    
2635    
2636           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires May 30, 2007                 [Page 48]  Schoenebeck            Expires September 23, 2007              [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 2740  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires May 30, 2007                 [Page 49]  Schoenebeck            Expires September 23, 2007              [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
2746    
2747    
2748           MUTE -           MUTE -
# Line 2758  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 2786  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 September 23, 2007              [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol           March 2007
2802    
2803    
2804             "MIDI_INPUT_CHANNEL: 5"
2805    
2806             "VOLUME: 1.0"
2807    
2808             "MUTE: false"
2809    
2810  Schoenebeck               Expires May 30, 2007                 [Page 50]           "SOLO: false"
2811    
2812  Internet-Draft        LinuxSampler Control Protocol        November 2006           "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 2837  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.  
2852    
    Example:  
2853    
2854    
2855    Schoenebeck            Expires September 23, 2007              [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol           March 2007
2858    
 6.4.13.  Current fill state of disk stream buffers  
   
    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 30, 2007                 [Page 51]  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 2893  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 September 23, 2007              [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol           March 2007
2914    
2915    
2916        S: ""        S: ""
2917    
2918  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 2905  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 30, 2007                 [Page 52]  
   
 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 2949  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 September 23, 2007              [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol           March 2007
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 2960  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 30, 2007                 [Page 53]  
   
 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 3005  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 September 23, 2007              [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol           March 2007
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 3018  Internet-Draft        LinuxSampler Contr Line 3038  Internet-Draft        LinuxSampler Contr
3038    
3039    
3040    
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 54]  
   
 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 3061  Internet-Draft        LinuxSampler Contr Line 3072  Internet-Draft        LinuxSampler Contr
3072    
3073    
3074    
3075    
3076    
3077    
3078    
3079    Schoenebeck            Expires September 23, 2007              [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol           March 2007
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 3073  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 30, 2007                 [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3096     Possible Answers:     Possible Answers:
3097    
3098        "OK" -        "OK" -
# Line 3116  Internet-Draft        LinuxSampler Contr Line 3128  Internet-Draft        LinuxSampler Contr
3128    
3129        "OK" -        "OK" -
3130    
3131    
3132    
3133    
3134    
3135    Schoenebeck            Expires September 23, 2007              [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol           March 2007
3138    
3139    
3140           on success           on success
3141    
3142        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 3129  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 30, 2007                 [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3153     Examples:     Examples:
3154    
3155    
# Line 3173  Internet-Draft        LinuxSampler Contr Line 3186  Internet-Draft        LinuxSampler Contr
3186    
3187    
3188    
3189    
3190    
3191    Schoenebeck            Expires September 23, 2007              [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol           March 2007
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 3185  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 30, 2007                 [Page 57]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3210     Possible Answers:     Possible Answers:
3211    
3212        "OK" -        "OK" -
# Line 3228  Internet-Draft        LinuxSampler Contr Line 3242  Internet-Draft        LinuxSampler Contr
3242    
3243     Possible Answers:     Possible Answers:
3244    
3245    
3246    
3247    Schoenebeck            Expires September 23, 2007              [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol           March 2007
3250    
3251    
3252        "OK" -        "OK" -
3253    
3254           on success           on success
# Line 3240  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 30, 2007                 [Page 58]  
   
 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 3285  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 September 23, 2007              [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol           March 2007
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 September 23, 2007              [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol           March 2007
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 September 23, 2007              [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol           March 2007
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  Schoenebeck               Expires May 30, 2007                 [Page 59]        C: "DESTROY FX_SEND 0 0"
3463    
3464          S: "OK"
3465    
3466    
3467    
3468    
3469    
3470    
3471    Schoenebeck            Expires September 23, 2007              [Page 62]
3472    
3473  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
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 September 23, 2007              [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol           March 2007
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             MIDI_CONTROLLER -
3560    
3561                a value between 0 and 127 reflecting the MIDI controller
3562                which is able to modify the effect send's send level
3563    
3564             LEVEL -
3565    
3566                optionally dotted number reflecting the effect send's
3567                current send level (where a value < 1.0 means attenuation
3568                and a value > 1.0 means amplification)
3569    
3570             AUDIO_OUTPUT_ROUTING -
3571    
3572                comma separated list which reflects to which audio channel
3573                of the selected audio output device each effect send output
3574                channel is routed to, e.g. "0,3" would mean the effect
3575                send's output channel 0 is routed to channel 0 of the audio
3576                output device and the effect send's output channel 1 is
3577                routed to the channel 3 of the audio output device (see "SET
3578                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)
3579    
3580    
3581    
3582    
3583    Schoenebeck            Expires September 23, 2007              [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol           March 2007
3586    
3587    
3588       The mentioned fields above don't have to be in particular order.
3589    
3590       Example:
3591    
3592          C: "GET FX_SEND INFO 0 0"
3593    
3594          S: "NAME: Reverb Send"
3595    
3596             "MIDI_CONTROLLER: 91"
3597    
3598             "LEVEL: 0.3"
3599    
3600             "AUDIO_OUTPUT_ROUTING: 2,3"
3601    
3602             "."
3603    
3604    6.4.30.  Altering effect send's audio routing
3605    
3606       The front-end can alter the destination of an effect send's audio
3607       channel on a specific sampler channel by sending the following
3608       command:
3609    
3610          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3611          <audio-src> <audio-dst>
3612    
3613       Where <sampler-chan> is the sampler channel number as returned by the
3614       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3615       command, <fx-send-id> reflects the numerical ID of the effect send
3616       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3617       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3618       of the effect send's audio channel which should be rerouted and
3619       <audio-dst> is the numerical ID of the audio channel of the selected
3620       audio output device where <audio-src> should be routed to.
3621    
3622       Note that effect sends can only route audio to the same audio output
3623       device as assigned to the effect send's sampler channel.  Also note
3624       that an effect send entity does always have exactly as much audio
3625       channels as its sampler channel.  So if the sampler channel is
3626       stereo, the effect send does have two audio channels as well.  Also
3627       keep in mind that the amount of audio channels on a sampler channel
3628       might be dependant not only to the deployed sampler engine on the
3629       sampler channel, but also dependant to the instrument currently
3630       loaded.  However you can (effectively) turn an i.e. stereo effect
3631       send into a mono one by simply altering its audio routing
3632       appropriately.
3633    
3634       Possible Answers:
3635    
3636    
3637    
3638    
3639    Schoenebeck            Expires September 23, 2007              [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol           March 2007
3642    
3643    
3644          "OK" -
3645    
3646             on success
3647    
3648          "WRN:<warning-code>:<warning-message>" -
3649    
3650             if audio output channel was set, but there are noteworthy
3651             issue(s) related, providing an appropriate warning code and
3652             warning message
3653    
3654          "ERR:<error-code>:<error-message>" -
3655    
3656             in case it failed, providing an appropriate error code and
3657             error message
3658    
3659       Example:
3660    
3661          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3662    
3663          S: "OK"
3664    
3665    6.4.31.  Altering effect send's MIDI controller
3666    
3667       The front-end can alter the MIDI controller of an effect send entity
3668       by sending the following command:
3669    
3670          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3671          ctrl>
3672    
3673       Where <sampler-chan> is the sampler channel number as returned by the
3674       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3675       command, <fx-send-id> reflects the numerical ID of the effect send
3676       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3677       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3678       controller which shall be able to modify the effect send's send
3679       level.
3680    
3681       Possible Answers:
3682    
3683          "OK" -
3684    
3685             on success
3686    
3687          "WRN:<warning-code>:<warning-message>" -
3688    
3689             if MIDI controller was set, but there are noteworthy issue(s)
3690             related, providing an appropriate warning code and warning
3691             message
3692    
3693    
3694    
3695    Schoenebeck            Expires September 23, 2007              [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol           March 2007
3698    
3699    
3700          "ERR:<error-code>:<error-message>" -
3701    
3702             in case it failed, providing an appropriate error code and
3703             error message
3704    
3705       Example:
3706    
3707          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3708    
3709          S: "OK"
3710    
3711    6.4.32.  Altering effect send's send level
3712    
3713       The front-end can alter the current send level of an effect send
3714       entity by sending the following command:
3715    
3716          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3717    
3718       Where <sampler-chan> is the sampler channel number as returned by the
3719       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3720       command, <fx-send-id> reflects the numerical ID of the effect send
3721       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3722       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3723       dotted positive number (a value smaller than 1.0 means attenuation,
3724       whereas a value greater than 1.0 means amplification) reflecting the
3725       new send level.
3726    
3727       Possible Answers:
3728    
3729          "OK" -
3730    
3731             on success
3732    
3733          "WRN:<warning-code>:<warning-message>" -
3734    
3735             if new send level was set, but there are noteworthy issue(s)
3736             related, providing an appropriate warning code and warning
3737             message
3738    
3739          "ERR:<error-code>:<error-message>" -
3740    
3741             in case it failed, providing an appropriate error code and
3742             error message
3743    
3744       Example:
3745    
3746    
3747    
3748    
3749    
3750    
3751    Schoenebeck            Expires September 23, 2007              [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol           March 2007
3754    
3755    
3756          C: "SET FX_SEND LEVEL 0 0 0.15"
3757    
3758          S: "OK"
3759    
3760    6.4.33.  Resetting a sampler channel
3761    
3762       The front-end can reset a particular sampler channel by sending the
3763       following command:
3764    
3765          RESET CHANNEL <sampler-channel>
3766    
3767       Where <sampler-channel> defines the sampler channel to be reset.
3768     This will cause the engine on that sampler channel, its voices and     This will cause the engine on that sampler channel, its voices and
3769     eventually disk streams and all control and status variables to be     eventually disk streams and all control and status variables to be
3770     reset.     reset.
# Line 3340  Internet-Draft        LinuxSampler Contr Line 3800  Internet-Draft        LinuxSampler Contr
3800     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3801     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3802    
       SUBSCRIBE <event-id>  
3803    
    where <event-id> will be replaced by the respective event that client  
    wants to subscribe to.  
   
    Possible Answers:  
3804    
       "OK" -  
3805    
          on success  
3806    
3807    Schoenebeck            Expires September 23, 2007              [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol           March 2007
3810    
3811    
3812          SUBSCRIBE <event-id>
3813    
3814       where <event-id> will be replaced by the respective event that client
3815       wants to subscribe to.
3816    
3817       Possible Answers:
3818    
3819  Schoenebeck               Expires May 30, 2007                 [Page 60]        "OK" -
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3820    
3821             on success
3822    
3823        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3824    
# Line 3398  Internet-Draft        LinuxSampler Contr Line 3857  Internet-Draft        LinuxSampler Contr
3857           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3858           message           message
3859    
       "ERR:<error-code>:<error-message>" -  
   
          in case it failed, providing an appropriate error code and  
          error message  
   
    Examples:  
3860    
3861    
3862    
3863    Schoenebeck            Expires September 23, 2007              [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol           March 2007
3866    
3867    
3868          "ERR:<error-code>:<error-message>" -
3869    
3870             in case it failed, providing an appropriate error code and
3871             error message
3872    
3873       Examples:
3874    
 Schoenebeck               Expires May 30, 2007                 [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3875    
3876    
3877  6.5.3.  Enable or disable echo of commands  6.5.3.  Enable or disable echo of commands
# Line 3455  Internet-Draft        LinuxSampler Contr Line 3912  Internet-Draft        LinuxSampler Contr
3912     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
3913     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
3914    
 6.6.  Global commands  
3915    
    The following commands have global impact on the sampler.  
3916    
 6.6.1.  Current number of active voices  
3917    
    The front-end can ask for the current number of active voices on the  
    sampler by sending the following command:  
3918    
3919    Schoenebeck            Expires September 23, 2007              [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol           March 2007
3922    
3923    
3924    6.6.  Global commands
3925    
3926       The following commands have global impact on the sampler.
3927    
3928  Schoenebeck               Expires May 30, 2007                 [Page 62]  6.6.1.  Current number of active voices
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3929    
3930       The front-end can ask for the current number of active voices on the
3931       sampler by sending the following command:
3932    
3933        GET TOTAL_VOICE_COUNT        GET TOTAL_VOICE_COUNT
3934    
# Line 3509  Internet-Draft        LinuxSampler Contr Line 3966  Internet-Draft        LinuxSampler Contr
3966    
3967    
3968    
3969    
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck            Expires September 23, 2007              [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol           March 2007
3978    
3979    
3980  6.6.4.  General sampler informations  6.6.4.  General sampler informations
3981    
3982     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
# Line 3521  Internet-Draft        LinuxSampler Contr Line 3989  Internet-Draft        LinuxSampler Contr
3989        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
3990        answer line begins with the information category name followed by        answer line begins with the information category name followed by
3991        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 30, 2007                 [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
3992        character string to that information category.  At the moment the        character string to that information category.  At the moment the
3993        following categories are defined:        following categories are defined:
3994    
# Line 3550  Internet-Draft        LinuxSampler Contr Line 4010  Internet-Draft        LinuxSampler Contr
4010     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4011     Other fields might be added in future.     Other fields might be added in future.
4012    
4013    6.6.5.  Getting global volume attenuation
4014    
4015       The client can ask for the current global sampler-wide volume
4016       attenuation by sending the following command:
4017    
4018          GET VOLUME
4019    
4020       Possible Answers:
4021    
4022          The sampler will always answer by returning the optional dotted
4023          floating point coefficient, reflecting the current global volume
4024          attenuation.
4025    
4026       Note: it is up to the respective sampler engine whether to obey that
4027       global volume parameter or not, but in general all engines SHOULD use
4028    
4029    
4030    
4031    Schoenebeck            Expires September 23, 2007              [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol           March 2007
4034    
4035    
4036       this parameter.
4037    
4038    6.6.6.  Setting global volume attenuation
4039    
4040       The client can alter the current global sampler-wide volume
4041       attenuation by sending the following command:
4042    
4043          SET VOLUME <volume>
4044    
4045       Where <volume> should be replaced by the optional dotted floating
4046       point value, reflecting the new global volume parameter.  This value
4047       might usually be in the range between 0.0 and 1.0, that is for
4048       attenuating the overall volume.
4049    
4050       Possible Answers:
4051    
4052          "OK" -
4053    
4054             on success
4055    
4056          "WRN:<warning-code>:<warning-message>" -
4057    
4058             if the global volume was set, but there are noteworthy issue(s)
4059             related, providing an appropriate warning code and warning
4060             message
4061    
4062          "ERR:<error-code>:<error-message>" -
4063    
4064             in case it failed, providing an appropriate error code and
4065             error message
4066    
4067  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4068    
4069     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 3558  Internet-Draft        LinuxSampler Contr Line 4072  Internet-Draft        LinuxSampler Contr
4072     actually map arbitrary MIDI bank select / program change numbers with     actually map arbitrary MIDI bank select / program change numbers with
4073     real instruments.     real instruments.
4074    
4075     By default, that is when the sampler is launched, this map will be     The sampler allows to manage an arbitrary amount of MIDI instrument
4076     empty, thus the sampler will simply ignore all program change     maps which define which instrument to load on which MIDI program
4077     messages.  The front-end has to explicitly add entries to the map so     change message.
4078     the sampler knows how to react on a given program change message,  
4079     that is by switching to the respectively defined engine type and     By default, that is when the sampler is launched, there is no map,
4080     loading the respective instrument.     thus the sampler will simply ignore all program change messages.  The
4081       front-end has to explicitly create at least one map, add entries to
4082       the map and tell the respective sampler channel(s) which MIDI
4083       instrument map to use, so the sampler knows how to react on a given
4084    
4085    
4086    
4087    Schoenebeck            Expires September 23, 2007              [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol           March 2007
4090    
4091    
4092       program change message on the respective sampler channel, that is by
4093       switching to the respectively defined engine type and loading the
4094       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4095       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4096       channel.
4097    
4098     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
4099     to switch to another instrument.  Instead when receiving a bank     to switch to another instrument.  Instead when receiving a bank
# Line 3572  Internet-Draft        LinuxSampler Contr Line 4102  Internet-Draft        LinuxSampler Contr
4102     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
4103     current MIDI instrument map.     current MIDI instrument map.
4104    
4105  6.7.1.  Create or replace a MIDI instrument map entry  6.7.1.  Create a new MIDI instrument map
4106    
4107       The front-end can add a new MIDI instrument map by sending the
4108       following command:
4109    
4110          ADD MIDI_INSTRUMENT_MAP [<name>]
4111    
4112       Where <name> is an optional argument allowing to assign a custom name
4113       to the new map.  MIDI instrument Map names do not have to be unique.
4114    
4115       Possible Answers:
4116    
4117          "OK[<map>]" -
4118    
4119             in case a new MIDI instrument map could be added, where <map>
4120             reflects the unique ID of the newly created MIDI instrument map
4121    
4122          "ERR:<error-code>:<error-message>" -
4123    
4124             when a new map could not be created, which might never occur in
4125             practice
4126    
4127       Examples:
4128    
4129          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4130    
4131          S: "OK[0]"
4132    
4133          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4134    
4135          S: "OK[1]"
4136    
4137          C: "ADD MIDI_INSTRUMENT_MAP"
4138    
4139    
4140    
4141    
4142    
4143    Schoenebeck            Expires September 23, 2007              [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol           March 2007
4146    
4147    
4148          S: "OK[5]"
4149    
4150    6.7.2.  Delete one particular or all MIDI instrument maps
4151    
4152       The front-end can delete a particular MIDI instrument map by sending
4153       the following command:
4154    
4155          REMOVE MIDI_INSTRUMENT_MAP <map>
4156    
4157       Where <map> reflects the unique ID of the map to delete as returned
4158       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4159    
4160       The front-end can delete all MIDI instrument maps by sending the
4161       following command:
4162    
4163          REMOVE MIDI_INSTRUMENT_MAP ALL
4164    
4165       Possible Answers:
4166    
4167          "OK" -
4168    
4169             in case the map(s) could be deleted
4170    
4171          "ERR:<error-code>:<error-message>" -
4172    
4173             when the given map does not exist
4174    
4175       Examples:
4176    
4177          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4178    
4179          S: "OK"
4180    
4181          C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
4182    
4183          S: "OK"
4184    
4185    6.7.3.  Get amount of existing MIDI instrument maps
4186    
4187       The front-end can retrieve the current amount of MIDI instrument maps
4188       by sending the following command:
4189    
4190          GET MIDI_INSTRUMENT_MAPS
4191    
4192       Possible Answers:
4193    
4194    
4195    
4196    
4197    
4198    
4199    Schoenebeck            Expires September 23, 2007              [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol           March 2007
4202    
4203    
4204          The sampler will answer by returning the current number of MIDI
4205          instrument maps.
4206    
4207       Example:
4208    
4209          C: "GET MIDI_INSTRUMENT_MAPS"
4210    
4211     The front-end can create a new or replace an existing entry in the        S: "2"
4212    
4213    6.7.4.  Getting all created MIDI instrument maps
4214    
4215       The number of MIDI instrument maps can change on runtime.  To get the
4216       current list of MIDI instrument maps, the front-end can send the
4217       following command:
4218    
4219          LIST MIDI_INSTRUMENT_MAPS
4220    
4221       Possible Answers:
4222    
4223          The sampler will answer by returning a comma separated list with
4224          all MIDI instrument maps' numerical IDs.
4225    
4226       Example:
4227    
4228          C: "LIST MIDI_INSTRUMENT_MAPS"
4229    
4230          S: "0,1,5,12"
4231    
4232    6.7.5.  Getting MIDI instrument map information
4233    
4234       The front-end can ask for the current settings of a MIDI instrument
4235       map by sending the following command:
4236    
4237          GET MIDI_INSTRUMENT_MAP INFO <map>
4238    
4239       Where <map> is the numerical ID of the map the front-end is
4240       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4241       (Section 6.7.4) command.
4242    
4243       Possible Answers:
4244    
4245          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4246          answer line begins with the settings category name followed by a
4247          colon and then a space character <SP> and finally the info
4248          character string to that setting category.  At the moment the
4249          following categories are defined:
4250    
4251    
4252    
4253    
4254    
4255    Schoenebeck            Expires September 23, 2007              [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol           March 2007
4258    
4259    
4260    
4261    
4262             NAME -
4263    
4264                custom name of the given map, which does not have to be
4265                unique
4266    
4267       The mentioned fields above don't have to be in particular order.
4268    
4269       Example:
4270    
4271          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4272    
4273          S: "NAME: Standard Map"
4274    
4275             "."
4276    
4277    6.7.6.  Renaming a MIDI instrument map
4278    
4279       The front-end can alter the custom name of a MIDI instrument map by
4280       sending the following command:
4281    
4282          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4283    
4284       Where <map> is the numerical ID of the map and <name> the new custom
4285       name of the map, which does not have to be unique.
4286    
4287       Possible Answers:
4288    
4289          "OK" -
4290    
4291             on success
4292    
4293          "ERR:<error-code>:<error-message>" -
4294    
4295             in case the given map does not exist
4296    
4297       Example:
4298    
4299          C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4300    
4301          S: "OK"
4302    
4303    6.7.7.  Create or replace a MIDI instrument map entry
4304    
4305       The front-end can create a new or replace an existing entry in a
4306     sampler's MIDI instrument map by sending the following command:     sampler's MIDI instrument map by sending the following command:
4307    
4308    
4309    
4310    
4311  Schoenebeck               Expires May 30, 2007                 [Page 64]  Schoenebeck            Expires September 23, 2007              [Page 77]
4312    
4313  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
4314    
4315    
4316        MAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog>        MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4317        <engine_name> <filename> <instrument_index> <volume_value>        <engine_name> <filename> <instrument_index> <volume_value>
4318        [<instr_load_mode>] [<name>]        [<instr_load_mode>] [<name>]
4319    
4320     Where <midi_bank_msb> is an integer value between 0..127 reflecting     Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4321     the MIDI bank select MSB (coarse) index, <midi_bank_lsb> an integer     integer value between 0..16383 reflecting the MIDI bank select index,
4322     value between 0..127 reflecting the MIDI bank select LSB (fine)     <midi_prog> an integer value between 0..127 reflecting the MIDI
4323     index, <midi_prog> an integer value between 0..127 reflecting the     program change index, <engine_name> a sampler engine name as returned
4324     MIDI program change index, <engine_name> a sampler engine name as     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
    returned by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not  
4325     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
4326     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes),
4327     <instrument_index> the index (integer value) of the instrument within     <instrument_index> the index (integer value) of the instrument within
# Line 3626  Internet-Draft        LinuxSampler Contr Line 4353  Internet-Draft        LinuxSampler Contr
4353    
4354        "PERSISTENT" -        "PERSISTENT" -
4355    
4356           The instrument will immediately be loaded into memory in the           The instrument will immediately be loaded into memory when this
4357           background when this mapping command is sent and the instrument           mapping command is sent and the instrument is kept all the
4358           is kept all the time.  Instruments with this mode are only           time.  Instruments with this mode are only freed when the
4359           freed when the sampler is reset or all mapping entries with           sampler is reset or all mapping entries with this mode (and
4360           this mode (and respective instrument) are explicitly changed to           respective instrument) are explicitly changed to "ON_DEMAND"
4361           "ON_DEMAND" and no sampler channel is using the instrument           and no sampler channel is using the instrument anymore.
4362           anymore.  
4363    
4364    
4365    
4366  Schoenebeck               Expires May 30, 2007                 [Page 65]  
4367    Schoenebeck            Expires September 23, 2007              [Page 78]
4368    
4369  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
4370    
4371    
4372        not supplied -        not supplied -
# Line 3664  Internet-Draft        LinuxSampler Contr Line 4392  Internet-Draft        LinuxSampler Contr
4392     not allow a way to manage load modes for them individually.  Due to     not allow a way to manage load modes for them individually.  Due to
4393     this, in case the frontend shows the load modes of entries, the     this, in case the frontend shows the load modes of entries, the
4394     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
4395     MIDI_INSTRUMENT INFO" (Section 6.7.5) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4396     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
4397     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes) for the mapping entry, useful for frontends for
4398     displaying an appropriate name for mapped instruments (using "GET     displaying an appropriate name for mapped instruments (using "GET
4399     MIDI_INSTRUMENT INFO" (Section 6.7.5)).     MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4400    
4401     The "MAP MIDI_INSTRUMENT" command will immediately return, thus it     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4402     will not block when an instrument is to be loaded due to a     completely established in the sampler.  The OPTIONAL "NON_MODAL"
4403     "PERSISTENT" type entry as instruments are loaded in the background.     argument however causes the respective "MAP MIDI_INSTRUMENT" command
4404     As a consequence this command may not necessarily return an error     to return immediately, that is to let the sampler establish the
4405     i.e. when the given instrument file does not exist or may turn out to     mapping in the background.  So this argument might be especially
4406     be corrupt.     useful for mappings with a "PERSISTENT" type, because these have to
4407       load the respective instruments immediately and might thus block for
4408       a very long time.  It is recommended however to use the OPTIONAL
4409       "NON_MODAL" argument only if really necessary, because it has the
4410       following drawbacks: as "NON_MODAL" instructions return immediately,
4411       they may not necessarily return an error i.e. when the given
4412       instrument file turns out to be corrupt, beside that subsequent
4413       commands in a LSCP instruction sequence might fail, because mandatory
4414       mappings are not yet completed.
4415    
4416     Possible Answers:     Possible Answers:
4417    
       "OK" -  
4418    
          usually  
4419    
       "ERR:<error-code>:<error-message>" -  
4420    
          when the given engine does not exist or a value is out of range  
4421    
    Examples:  
4422    
4423    Schoenebeck            Expires September 23, 2007              [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol           March 2007
4426    
4427    
4428          "OK" -
4429    
4430  Schoenebeck               Expires May 30, 2007                 [Page 66]           usually
4431    
4432  Internet-Draft        LinuxSampler Control Protocol        November 2006        "ERR:<error-code>:<error-message>" -
4433    
4434             when the given map or engine does not exist or a value is out
4435             of range
4436    
4437        C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0     Examples:
4438    
4439          C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4440        0.8 PERSISTENT"        0.8 PERSISTENT"
4441    
4442        S: "OK"        S: "OK"
4443    
4444        C: "MAP MIDI_INSTRUMENT 127 4 50 gig '/home/john/foostrings.gig' 7        C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
4445        1.0"        1.0"
4446    
4447        S: "OK"        S: "OK"
# Line 3712  Internet-Draft        LinuxSampler Contr Line 4451  Internet-Draft        LinuxSampler Contr
4451    
4452        S: "OK"        S: "OK"
4453    
4454        C: "MAP MIDI_INSTRUMENT 1 0 0 gig '/usr/share/piano.gig' 0 0.25        C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4455        'Silent Piano'"        'Silent Piano'"
4456    
4457        S: "OK"        S: "OK"
4458    
4459        C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0        C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4460        1.0 PERSISTENT 'Foo Drumkit'"        foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4461    
4462        S: "OK"        S: "OK"
4463    
4464  6.7.2.  Getting ammount of MIDI instrument map entries  6.7.8.  Getting ammount of MIDI instrument map entries
4465    
4466       The front-end can query the amount of currently existing entries in a
4467       MIDI instrument map by sending the following command:
4468    
4469          GET MIDI_INSTRUMENTS <map>
4470    
4471       The front-end can query the amount of currently existing entries in
4472       all MIDI instrument maps by sending the following command:
4473    
4474    
4475    
4476    
4477    
4478    
4479    Schoenebeck            Expires September 23, 2007              [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol           March 2007
4482    
    The front-end can query the amount of currently existing MIDI  
    instrument map entries by sending the following command:  
4483    
4484        GET MIDI_INSTRUMENTS        GET MIDI_INSTRUMENTS ALL
4485    
4486     Possible Answers:     Possible Answers:
4487    
4488        LinuxSampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
4489        in the sampler's MIDI instrument map.        in the MIDI instrument map(s).
4490    
4491     Example:     Example:
4492    
4493        C: "GET MIDI_INSTRUMENTS"        C: "GET MIDI_INSTRUMENTS 0"
4494    
4495        S: "634"        S: "234"
4496    
4497  6.7.3.  Getting indeces of all MIDI instrument map entries        C: "GET MIDI_INSTRUMENTS ALL"
4498    
4499     The front-end can query a list of all currently existing MIDI        S: "954"
    instrument map entries by sending the following command:  
4500    
4501    6.7.9.  Getting indeces of all entries of a MIDI instrument map
4502    
4503       The front-end can query a list of all currently existing entries in a
4504       certain MIDI instrument map by sending the following command:
4505    
4506          LIST MIDI_INSTRUMENTS <map>
4507    
4508  Schoenebeck               Expires May 30, 2007                 [Page 67]     Where <map> is the numeric ID of the MIDI instrument map.
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4509    
4510       The front-end can query a list of all currently existing entries of
4511       all MIDI instrument maps by sending the following command:
4512    
4513        LIST MIDI_INSTRUMENTS        LIST MIDI_INSTRUMENTS ALL
4514    
4515     Possible Answers:     Possible Answers:
4516    
4517        LinuxSampler will answer by sending a comma separated list of MIDI        The sampler will answer by sending a comma separated list of map
4518        bank MSB (coarse) - MIDI bank LSB (fine) - MIDI program triples,        ID - MIDI bank - MIDI program triples, where each triple is
4519        where each triple is encapsulated into curly braces.  The list is        encapsulated into curly braces.  The list is returned in one
4520        returned in one single line.  Each triple just reflects the key of        single line.  Each triple just reflects the key of the respective
4521        the respective map entry, thus subsequent "GET MIDI_INSTRUMENT        map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4522        INFO" (Section 6.7.5) command(s) are necessary to retrieve        (Section 6.7.11) command(s) are necessary to retrieve detailed
4523        detailed informations about each entry.        informations about each entry.
4524    
4525     Example:     Example:
4526    
4527        C: "LIST MIDI_INSTRUMENTS"        C: "LIST MIDI_INSTRUMENTS 0"
4528    
4529          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4530    
4531    
4532    
4533    
4534    
4535    Schoenebeck            Expires September 23, 2007              [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol           March 2007
4538    
       S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"  
4539    
4540  6.7.4.  Remove an entry from the MIDI instrument map  6.7.10.  Remove an entry from the MIDI instrument map
4541    
4542     The front-end can delete an entry from the MIDI instrument map by     The front-end can delete an entry from a MIDI instrument map by
4543     sending the following command:     sending the following command:
4544    
4545        UNMAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4546    
4547     Where <midi_bank_msb> is an integer value between 0..127 reflecting     Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4548     the MIDI bank MSB (coarse) value, <midi_bank_lsb> an integer value     is an integer value between 0..16383 reflecting the MIDI bank value
4549     between 0..127 reflecting the MIDI bank LSB (fine) value and     and <midi_prog> an integer value between 0..127 reflecting the MIDI
4550     <midi_prog> an integer value between 0..127 reflecting the MIDI     program value of the map's entrie's key index triple.
    program value of the map entrie's key index triple.  
4551    
4552     Possible Answers:     Possible Answers:
4553    
# Line 3796  Internet-Draft        LinuxSampler Contr Line 4561  Internet-Draft        LinuxSampler Contr
4561    
4562     Example:     Example:
4563    
4564        C: "UNMAP MIDI_INSTRUMENT 2 40 127"        C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4565    
4566        S: "OK"        S: "OK"
4567    
4568    6.7.11.  Get current settings of MIDI instrument map entry
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 68]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
 6.7.5.  Get current settings of MIDI instrument map entry  
4569    
4570     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
4571     instrument map entry by sending the following command:     instrument map entry by sending the following command:
4572    
4573        GET MIDI_INSTRUMENT INFO <midi_bank_msb> <midi_bank_lsb>        GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
       <midi_prog>  
4574    
4575     Where <midi_bank_msb> is an integer value between 0..127 reflecting     Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4576     the MIDI bank MSB (coarse) value, <midi_bank_lsb> an integer value     is an integer value between 0..16383 reflecting the MIDI bank value,
4577     between 0..127 reflecting the MIDI bank LSB (fine) value and     <midi_bank> and <midi_prog> an integer value between 0..127
4578     <midi_prog> an integer value between 0..127 reflecting the MIDI     reflecting the MIDI program value of the map's entrie's key index
4579     program value of the map entrie's key index triple.     triple.
4580    
4581     Possible Answers:     Possible Answers:
4582    
# Line 3831  Internet-Draft        LinuxSampler Contr Line 4586  Internet-Draft        LinuxSampler Contr
4586        character string to that info category.  At the moment the        character string to that info category.  At the moment the
4587        following categories are defined:        following categories are defined:
4588    
4589    
4590    
4591    Schoenebeck            Expires September 23, 2007              [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol           March 2007
4594    
4595    
4596        "NAME" -        "NAME" -
4597    
4598           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
4599           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
4600           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
4601           MIDI_INSTRUMENT" (Section 6.7.1) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4602           be unique.           be unique.
4603    
4604        "ENGINE_NAME" -        "ENGINE_NAME" -
# Line 3857  Internet-Draft        LinuxSampler Contr Line 4619  Internet-Draft        LinuxSampler Contr
4619           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4620           cannot be changed.           cannot be changed.
4621    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
4622        "LOAD_MODE" -        "LOAD_MODE" -
4623    
4624           Life time of instrument (see "MAP MIDI_INSTRUMENT"           Life time of instrument (see "MAP MIDI_INSTRUMENT"
4625           (Section 6.7.1) for details about this setting).           (Section 6.7.7) for details about this setting).
4626    
4627        "VOLUME" -        "VOLUME" -
4628    
# Line 3880  Internet-Draft        LinuxSampler Contr Line 4634  Internet-Draft        LinuxSampler Contr
4634    
4635     Example:     Example:
4636    
4637        C: "GET MIDI_INSTRUMENT INFO 3 45 120"        C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4638    
4639        S: "NAME: Drums for Foo Song"        S: "NAME: Drums for Foo Song"
4640    
4641           "ENGINE_NAME: GigEngine"           "ENGINE_NAME: GigEngine"
4642    
          "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"  
   
          "INSTRUMENT_NR: 0"  
   
          "INSTRUMENT_NAME: Joe's Drumkit"  
   
          "LOAD_MODE: PERSISTENT"  
   
          "VOLUME: 1.0"  
   
          "."  
   
 6.7.6.  Clear MIDI instrument map  
   
    The front-end can clear the whole MIDI instrument map, that is delete  
    all entries by sending the following command:  
   
       CLEAR MIDI_INSTRUMENTS  
   
    Possible Answers:  
4643    
       "OK" -  
4644    
          always  
   
    Example:  
4645    
4646    
4647    Schoenebeck            Expires September 23, 2007              [Page 83]
   
 Schoenebeck               Expires May 30, 2007                 [Page 70]  
4648    
4649  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
   
   
       C: "CLEAR MIDI_INSTRUMENTS"  
   
       S: "OK"  
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
4650    
4651    
4652             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4653    
4654             "INSTRUMENT_NR: 0"
4655    
4656             "INSTRUMENT_NAME: Joe's Drumkit"
4657    
4658             "LOAD_MODE: PERSISTENT"
4659    
4660             "VOLUME: 1.0"
4661    
4662             "."
4663    
4664    6.7.12.  Clear MIDI instrument map
4665    
4666       The front-end can clear a whole MIDI instrument map, that is delete
4667       all its entries by sending the following command:
4668    
4669          CLEAR MIDI_INSTRUMENTS <map>
4670    
4671       Where <map> is the numeric ID of the map to clear.
4672    
4673       The front-end can clear all MIDI instrument maps, that is delete all
4674       entries of all maps by sending the following command:
4675    
4676          CLEAR MIDI_INSTRUMENTS ALL
4677    
4678       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4679       only their entries, thus the map's settings like custom name will be
4680       preservevd.
4681    
4682       Possible Answers:
4683    
4684          "OK" -
4685    
4686             always
4687    
4688       Examples:
4689    
4690          C: "CLEAR MIDI_INSTRUMENTS 0"
4691    
4692          S: "OK"
4693    
4694          C: "CLEAR MIDI_INSTRUMENTS ALL"
4695    
4696          S: "OK"
4697    
4698    
4699    
4700    
4701    
4702    
4703  Schoenebeck               Expires May 30, 2007                 [Page 71]  Schoenebeck            Expires September 23, 2007              [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
4706    
4707    
4708  7.  Command Syntax  7.  Command Syntax
# Line 4013  Internet-Draft        LinuxSampler Contr Line 4741  Internet-Draft        LinuxSampler Contr
4741    
4742     command =     command =
4743    
4744        ADD SP CHANNEL        ADD SP add_instruction
4745    
4746        / MAP SP map_instruction        / MAP SP map_instruction
4747    
# Line 4028  Internet-Draft        LinuxSampler Contr Line 4756  Internet-Draft        LinuxSampler Contr
4756    
4757    
4758    
4759  Schoenebeck               Expires May 30, 2007                 [Page 72]  Schoenebeck            Expires September 23, 2007              [Page 85]
4760    
4761  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
4762    
4763    
4764        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4055  Internet-Draft        LinuxSampler Contr Line 4783  Internet-Draft        LinuxSampler Contr
4783    
4784        / QUIT        / QUIT
4785    
4786       add_instruction =
4787    
4788          CHANNEL
4789    
4790          / MIDI_INSTRUMENT_MAP
4791    
4792          / MIDI_INSTRUMENT_MAP SP map_name
4793    
4794     subscribe_event =     subscribe_event =
4795    
4796        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4797    
4798          / AUDIO_OUTPUT_DEVICE_INFO
4799    
4800          / MIDI_INPUT_DEVICE_COUNT
4801    
4802          / MIDI_INPUT_DEVICE_INFO
4803    
4804          / CHANNEL_COUNT
4805    
4806        / VOICE_COUNT        / VOICE_COUNT
4807    
# Line 4065  Internet-Draft        LinuxSampler Contr Line 4809  Internet-Draft        LinuxSampler Contr
4809    
4810        / BUFFER_FILL        / BUFFER_FILL
4811    
4812    
4813    
4814    
4815    Schoenebeck            Expires September 23, 2007              [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol           March 2007
4818    
4819    
4820        / CHANNEL_INFO        / CHANNEL_INFO
4821    
4822          / FX_SEND_COUNT
4823    
4824          / FX_SEND_INFO
4825    
4826          / MIDI_INSTRUMENT_MAP_COUNT
4827    
4828          / MIDI_INSTRUMENT_MAP_INFO
4829    
4830          / MIDI_INSTRUMENT_COUNT
4831    
4832          / MIDI_INSTRUMENT_INFO
4833    
4834        / MISCELLANEOUS        / MISCELLANEOUS
4835    
4836        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4837    
4838          / GLOBAL_INFO
4839    
4840     unsubscribe_event =     unsubscribe_event =
4841    
4842        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4843    
4844          / AUDIO_OUTPUT_DEVICE_INFO
4845    
4846          / MIDI_INPUT_DEVICE_COUNT
4847    
4848          / MIDI_INPUT_DEVICE_INFO
4849    
4850          / CHANNEL_COUNT
4851    
4852        / VOICE_COUNT        / VOICE_COUNT
4853    
# Line 4081  Internet-Draft        LinuxSampler Contr Line 4855  Internet-Draft        LinuxSampler Contr
4855    
4856        / BUFFER_FILL        / BUFFER_FILL
4857    
4858          / CHANNEL_INFO
4859    
4860          / FX_SEND_COUNT
4861    
4862          / FX_SEND_INFO
4863    
4864          / MIDI_INSTRUMENT_MAP_COUNT
4865    
4866          / MIDI_INSTRUMENT_MAP_INFO
4867    
4868    
4869    
4870    
4871  Schoenebeck               Expires May 30, 2007                 [Page 73]  Schoenebeck            Expires September 23, 2007              [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
4874    
4875    
4876        / CHANNEL_INFO        / MIDI_INSTRUMENT_COUNT
4877    
4878          / MIDI_INSTRUMENT_INFO
4879    
4880        / MISCELLANEOUS        / MISCELLANEOUS
4881    
4882        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4883    
4884          / GLOBAL_INFO
4885    
4886     map_instruction =     map_instruction =
4887    
4888        MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP        MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
4889        engine_name SP filename SP instrument_index SP volume_value        engine_name SP filename SP instrument_index SP volume_value
4890    
4891        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
4892        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
4893        instr_load_mode        instr_load_mode
4894    
4895        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
4896        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
4897        entry_name        entry_name
4898    
4899        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
4900        SP engine_name SP filename SP instrument_index SP volume_value SP        SP engine_name SP filename SP instrument_index SP volume_value SP
4901        instr_load_mode SP entry_name        instr_load_mode SP entry_name
4902    
4903     unmap_instruction =     unmap_instruction =
4904    
4905        MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
4906    
4907     remove_instruction =     remove_instruction =
4908    
4909        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
4910    
4911          / MIDI_INSTRUMENT_MAP SP midi_map
4912    
4913          / MIDI_INSTRUMENT_MAP SP ALL
4914    
4915     get_instruction =     get_instruction =
4916    
4917        AVAILABLE_ENGINES        AVAILABLE_ENGINES
# Line 4128  Internet-Draft        LinuxSampler Contr Line 4920  Internet-Draft        LinuxSampler Contr
4920    
4921        / MIDI_INPUT_DRIVER SP INFO SP string        / MIDI_INPUT_DRIVER SP INFO SP string
4922    
       / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string  
4923    
       / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP  
       key_val_list  
4924    
       / AVAILABLE_AUDIO_OUTPUT_DRIVERS  
4925    
       / AUDIO_OUTPUT_DRIVER SP INFO SP string  
4926    
4927    Schoenebeck            Expires September 23, 2007              [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol           March 2007
4930    
4931    
4932          / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
4933    
4934  Schoenebeck               Expires May 30, 2007                 [Page 74]        / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
4935          key_val_list
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4936    
4937          / AVAILABLE_AUDIO_OUTPUT_DRIVERS
4938    
4939          / AUDIO_OUTPUT_DRIVER SP INFO SP string
4940    
4941        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
4942    
# Line 4183  Internet-Draft        LinuxSampler Contr Line 4976  Internet-Draft        LinuxSampler Contr
4976    
4977        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck            Expires September 23, 2007              [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol           March 2007
4986    
4987    
4988        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
4989    
4990        / MIDI_INSTRUMENTS        / MIDI_INSTRUMENTS SP midi_map
4991    
4992        / MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP        / MIDI_INSTRUMENTS SP ALL
       midi_prog  
4993    
4994     set_instruction =        / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
4995    
4996          / MIDI_INSTRUMENT_MAPS
4997    
4998          / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
4999    
5000          / FX_SENDS SP sampler_channel
5001    
5002          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
5003    
5004  Schoenebeck               Expires May 30, 2007                 [Page 75]        / VOLUME
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5005    
5006       set_instruction =
5007    
5008        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
5009        param_val_list        param_val_list
# Line 4215  Internet-Draft        LinuxSampler Contr Line 5019  Internet-Draft        LinuxSampler Contr
5019    
5020        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
5021    
5022          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5023    
5024          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
5025          SP audio_channel_index SP audio_channel_index
5026    
5027          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
5028          midi_ctrl
5029    
5030          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
5031          volume_value
5032    
5033        / ECHO SP boolean        / ECHO SP boolean
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck            Expires September 23, 2007              [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol           March 2007
5042    
5043    
5044          / VOLUME SP volume_value
5045    
5046     create_instruction =     create_instruction =
5047    
5048        AUDIO_OUTPUT_DEVICE SP string SP key_val_list        AUDIO_OUTPUT_DEVICE SP string SP key_val_list
# Line 4227  Internet-Draft        LinuxSampler Contr Line 5053  Internet-Draft        LinuxSampler Contr
5053    
5054        / MIDI_INPUT_DEVICE SP string        / MIDI_INPUT_DEVICE SP string
5055    
5056          / FX_SEND SP sampler_channel SP midi_ctrl
5057    
5058          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
5059    
5060     reset_instruction =     reset_instruction =
5061    
5062        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
5063    
5064     clear_instruction =     clear_instruction =
5065    
5066        MIDI_INSTRUMENTS        MIDI_INSTRUMENTS SP midi_map
5067    
5068          / MIDI_INSTRUMENTS SP ALL
5069    
5070     destroy_instruction =     destroy_instruction =
5071    
# Line 4241  Internet-Draft        LinuxSampler Contr Line 5073  Internet-Draft        LinuxSampler Contr
5073    
5074        / MIDI_INPUT_DEVICE SP number        / MIDI_INPUT_DEVICE SP number
5075    
5076          / FX_SEND SP sampler_channel SP fx_send_id
5077    
5078     load_instruction =     load_instruction =
5079    
5080        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
# Line 4249  Internet-Draft        LinuxSampler Contr Line 5083  Internet-Draft        LinuxSampler Contr
5083    
5084     set_chan_instruction =     set_chan_instruction =
5085    
5086          AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
5087    
5088          / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
5089          SP audio_channel_index
5090    
5091    
 Schoenebeck               Expires May 30, 2007                 [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5092    
5093    
       AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index  
5094    
5095        / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index  Schoenebeck            Expires September 23, 2007              [Page 91]
5096        SP audio_channel_index  
5097    Internet-Draft        LinuxSampler Control Protocol           March 2007
5098    
5099    
5100        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name        / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
5101    
# Line 4282  Internet-Draft        LinuxSampler Contr Line 5117  Internet-Draft        LinuxSampler Contr
5117    
5118        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
5119    
5120          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
5121    
5122          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
5123    
5124          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
5125    
5126       modal_arg =
5127    
5128          /* epsilon (empty argument) */
5129    
5130          / NON_MODAL SP
5131    
5132     key_val_list =     key_val_list =
5133    
5134        string '=' param_val_list        string '=' param_val_list
# Line 4298  Internet-Draft        LinuxSampler Contr Line 5145  Internet-Draft        LinuxSampler Contr
5145    
5146        AUDIO_OUTPUT_DEVICES        AUDIO_OUTPUT_DEVICES
5147    
       / MIDI_INPUT_DEVICES  
5148    
       / CHANNELS  
   
       / AVAILABLE_ENGINES  
5149    
5150    
5151    Schoenebeck            Expires September 23, 2007              [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol           March 2007
5154    
5155    
5156          / MIDI_INPUT_DEVICES
5157    
5158  Schoenebeck               Expires May 30, 2007                 [Page 77]        / CHANNELS
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5159    
5160          / AVAILABLE_ENGINES
5161    
5162        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
5163    
5164        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
5165    
5166        / MIDI_INSTRUMENTS        / MIDI_INSTRUMENTS SP midi_map
5167    
5168          / MIDI_INSTRUMENTS SP ALL
5169    
5170          / MIDI_INSTRUMENT_MAPS
5171    
5172          / FX_SENDS SP sampler_channel
5173    
5174     load_instr_args =     load_instr_args =
5175    
# Line 4349  Internet-Draft        LinuxSampler Contr Line 5201  Internet-Draft        LinuxSampler Contr
5201    
5202        string        string
5203    
5204    
5205    
5206    
5207    Schoenebeck            Expires September 23, 2007              [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol           March 2007
5210    
5211    
5212     midi_input_port_index =     midi_input_port_index =
5213    
5214        number        number
# Line 4361  Internet-Draft        LinuxSampler Contr Line 5221  Internet-Draft        LinuxSampler Contr
5221    
5222     midi_input_type_name =     midi_input_type_name =
5223    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
5224        string        string
5225    
5226     midi_bank_msb =     midi_map =
5227    
5228        number        number
5229    
5230     midi_bank_lsb =     midi_bank =
5231    
5232        number        number
5233    
# Line 4383  Internet-Draft        LinuxSampler Contr Line 5235  Internet-Draft        LinuxSampler Contr
5235    
5236        number        number
5237    
5238       midi_ctrl =
5239    
5240          number
5241    
5242     volume_value =     volume_value =
5243    
5244        dotnum        dotnum
# Line 4397  Internet-Draft        LinuxSampler Contr Line 5253  Internet-Draft        LinuxSampler Contr
5253    
5254        number        number
5255    
5256       fx_send_id =
5257    
5258          number
5259    
5260    
5261    
5262    
5263    Schoenebeck            Expires September 23, 2007              [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol           March 2007
5266    
5267    
5268     engine_name =     engine_name =
5269    
5270        string        string
# Line 4405  Internet-Draft        LinuxSampler Contr Line 5273  Internet-Draft        LinuxSampler Contr
5273    
5274        stringval        stringval
5275    
5276       map_name =
5277    
5278          stringval
5279    
5280     entry_name =     entry_name =
5281    
5282        stringval        stringval
5283    
5284       fx_send_name =
5285    
5286          stringval
5287    
5288     param_val_list =     param_val_list =
5289    
5290        param_val        param_val
# Line 4417  Internet-Draft        LinuxSampler Contr Line 5293  Internet-Draft        LinuxSampler Contr
5293    
5294     param_val =     param_val =
5295    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 79]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
5296        string        string
5297    
5298        / stringval        / stringval
# Line 4448  Internet-Draft        LinuxSampler Contr Line 5316  Internet-Draft        LinuxSampler Contr
5316    
5317    
5318    
5319    Schoenebeck            Expires September 23, 2007              [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol           March 2007
5322    
5323    
5324    8.  Events
5325    
5326       This chapter will describe all currently defined events supported by
5327       LinuxSampler.
5328    
5329    8.1.  Number of audio output devices changed
5330    
5331       Client may want to be notified when the total number of audio output
5332       devices on the back-end changes by issuing the following command:
5333    
5334          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
5335    
5336       Server will start sending the following notification messages:
5337    
5338          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
5339    
5340       where <devices> will be replaced by the new number of audio output
5341       devices.
5342    
5343    8.2.  Audio output device's settings changed
5344    
5345       Client may want to be notified when changes were made to audio output
5346       devices on the back-end by issuing the following command:
5347    
5348          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
5349    
5350       Server will start sending the following notification messages:
5351    
5352          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
5353    
5354       where <device-id> will be replaced by the numerical ID of the audio
5355       output device, which settings has been changed.  The front-end will
5356       have to send the respective command to actually get the audio output
5357       device info.  Because these messages will be triggered by LSCP
5358       commands issued by other clients rather than real time events
5359       happening on the server, it is believed that an empty notification
5360       message is sufficient here.
5361    
5362    8.3.  Number of MIDI input devices changed
5363    
5364       Client may want to be notified when the total number of MIDI input
5365       devices on the back-end changes by issuing the following command:
5366    
5367          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
5368    
5369       Server will start sending the following notification messages:
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck            Expires September 23, 2007              [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol           March 2007
5378    
5379    
5380          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
5381    
5382       where <devices> will be replaced by the new number of MIDI input
5383       devices.
5384    
5385  Schoenebeck               Expires May 30, 2007                 [Page 80]  8.4.  MIDI input device's settings changed
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5386    
5387       Client may want to be notified when changes were made to MIDI input
5388       devices on the back-end by issuing the following command:
5389    
5390  8.  Events        SUBSCRIBE MIDI_INPUT_DEVICE_INFO
5391    
5392     This chapter will describe all currently defined events supported by     Server will start sending the following notification messages:
5393     LinuxSampler.  
5394          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
5395    
5396  8.1.  Number of sampler channels changed     where <device-id> will be replaced by the numerical ID of the MIDI
5397       input device, which settings has been changed.  The front-end will
5398       have to send the respective command to actually get the MIDI input
5399       device info.  Because these messages will be triggered by LSCP
5400       commands issued by other clients rather than real time events
5401       happening on the server, it is believed that an empty notification
5402       message is sufficient here.
5403    
5404    8.5.  Number of sampler channels changed
5405    
5406     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
5407     the back-end changes by issuing the following command:     the back-end changes by issuing the following command:
# Line 4500  Internet-Draft        LinuxSampler Contr Line 5415  Internet-Draft        LinuxSampler Contr
5415     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
5416     channels.     channels.
5417    
5418  8.2.  Number of active voices changed  8.6.  Number of active voices changed
5419    
5420     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-
5421     end changes by issuing the following command:     end changes by issuing the following command:
# Line 4509  Internet-Draft        LinuxSampler Contr Line 5424  Internet-Draft        LinuxSampler Contr
5424    
5425     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5426    
5427        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>  
5428    
5429    
5430    
5431    Schoenebeck            Expires September 23, 2007              [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol           March 2007
5434    
5435    
5436          "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
5437    
5438     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5439     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
5440     voices on that channel.     voices on that channel.
5441    
5442  8.3.  Number of active disk streams changed  8.7.  Number of active disk streams changed
5443    
5444     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
5445     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 4529  Internet-Draft        LinuxSampler Contr Line 5453  Internet-Draft        LinuxSampler Contr
5453    
5454     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5455     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 30, 2007                 [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
5456     active disk streams on that channel.     active disk streams on that channel.
5457    
5458  8.4.  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
5459    
5460     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
5461     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 4556  Internet-Draft        LinuxSampler Contr Line 5472  Internet-Draft        LinuxSampler Contr
5472     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
5473     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
5474    
5475  8.5.  Channel information changed  8.9.  Channel information changed
5476    
5477     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
5478     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
# Line 4565  Internet-Draft        LinuxSampler Contr Line 5481  Internet-Draft        LinuxSampler Contr
5481    
5482     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5483    
5484    
5485    
5486    
5487    Schoenebeck            Expires September 23, 2007              [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol           March 2007
5490    
5491    
5492        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
5493    
5494     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
# Line 4574  Internet-Draft        LinuxSampler Contr Line 5498  Internet-Draft        LinuxSampler Contr
5498     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
5499     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
5500    
5501  8.6.  Total number of active voices changed  8.10.  Number of effect sends changed
5502    
5503       Client may want to be notified when the number of effect sends on a
5504       particular sampler channel is changed by issuing the following
5505       command:
5506    
5507          SUBSCRIBE FX_SEND_COUNT
5508    
5509       Server will start sending the following notification messages:
5510    
5511          "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
5512    
5513       where <channel-id> will be replaced by the numerical ID of the
5514       sampler channel, on which the effect sends number is changed and <fx-
5515       sends> will be replaced by the new number of effect sends on that
5516       channel.
5517    
5518    8.11.  Effect send information changed
5519    
5520       Client may want to be notified when changes were made to effect sends
5521       on a a particular sampler channel by issuing the following command:
5522    
5523          SUBSCRIBE FX_SEND_INFO
5524    
5525       Server will start sending the following notification messages:
5526    
5527          "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
5528    
5529       where <channel-id> will be replaced by the numerical ID of the
5530       sampler channel, on which an effect send entity is changed and <fx-
5531       send-id> will be replaced by the numerical ID of the changed effect
5532       send.
5533    
5534    8.12.  Total number of active voices changed
5535    
5536     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
5537     back-end changes by issuing the following command:     back-end changes by issuing the following command:
5538    
5539    
5540    
5541    
5542    
5543    Schoenebeck            Expires September 23, 2007              [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol           March 2007
5546    
5547    
5548        SUBSCRIBE TOTAL_VOICE_COUNT        SUBSCRIBE TOTAL_VOICE_COUNT
5549    
5550     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5551    
5552          "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
5553    
5554       where <voices> will be replaced by the new number of all currently
5555       active voices.
5556    
5557    8.13.  Number of MIDI instrument maps changed
5558    
5559       Client may want to be notified when the number of MIDI instrument
5560       maps on the back-end changes by issuing the following command:
5561    
5562          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
5563    
5564       Server will start sending the following notification messages:
5565    
5566          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
5567    
5568  Schoenebeck               Expires May 30, 2007                 [Page 82]     where <maps> will be replaced by the new number of MIDI instrument
5569       maps.
5570    
5571    8.14.  MIDI instrument map information changed
5572    
5573       Client may want to be notified when changes were made to MIDI
5574       instrument maps on the back-end by issuing the following command:
5575    
5576          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
5577    
5578       Server will start sending the following notification messages:
5579    
5580          "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
5581    
5582       where <map-id> will be replaced by the numerical ID of the MIDI
5583       instrument map, for which information changes occurred.  The front-
5584       end will have to send the respective command to actually get the MIDI
5585       instrument map info.  Because these messages will be triggered by
5586       LSCP commands issued by other clients rather than real time events
5587       happening on the server, it is believed that an empty notification
5588       message is sufficient here.
5589    
5590    8.15.  Number of MIDI instruments changed
5591    
5592       Client may want to be notified when the number of MIDI instrument
5593       maps on the back-end changes by issuing the following command:
5594    
5595    
5596    
5597    
5598    
5599    Schoenebeck            Expires September 23, 2007             [Page 100]
5600    
5601  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
5602    
5603    
5604        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        SUBSCRIBE MIDI_INSTRUMENT_COUNT
5605    
5606     where <voices> will be replaced by the new number of all currently     Server will start sending the following notification messages:
5607     active voices.  
5608          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
5609    
5610       where <map-id> is the numerical ID of the MIDI instrument map, in
5611       which the nuber of instruments has changed and <instruments> will be
5612       replaced by the new number of MIDI instruments in the specified map.
5613    
5614  8.7.  Miscellaneous and debugging events  8.16.  MIDI instrument information changed
5615    
5616       Client may want to be notified when changes were made to MIDI
5617       instruments on the back-end by issuing the following command:
5618    
5619          SUBSCRIBE MIDI_INSTRUMENT_INFO
5620    
5621       Server will start sending the following notification messages:
5622    
5623          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
5624    
5625       where <map-id> will be replaced by the numerical ID of the MIDI
5626       instrument map, in which a MIDI instrument is changed. <bank> and
5627       <program> specifies the location of the changed MIDI instrument in
5628       the map.  The front-end will have to send the respective command to
5629       actually get the MIDI instrument info.  Because these messages will
5630       be triggered by LSCP commands issued by other clients rather than
5631       real time events happening on the server, it is believed that an
5632       empty notification message is sufficient here.
5633    
5634    8.17.  Global settings changed
5635    
5636       Client may want to be notified when changes to the global settings of
5637       the sampler were made by issuing the following command:
5638    
5639          SUBSCRIBE GLOBAL_INFO
5640    
5641       Server will start sending the following types of notification
5642       messages:
5643    
5644          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
5645          volume of the sampler is changed, where <volume> will be replaced
5646          by the optional dotted floating point value, reflecting the new
5647          global volume parameter.
5648    
5649    
5650    
5651    
5652    
5653    
5654    
5655    Schoenebeck            Expires September 23, 2007             [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol           March 2007
5658    
5659    
5660    8.18.  Miscellaneous and debugging events
5661    
5662     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
5663     occurring at the server by issuing the following command:     occurring at the server by issuing the following command:
# Line 4644  Internet-Draft        LinuxSampler Contr Line 5703  Internet-Draft        LinuxSampler Contr
5703    
5704    
5705    
5706  Schoenebeck               Expires May 30, 2007                 [Page 83]  
5707    
5708    
5709    
5710    
5711    Schoenebeck            Expires September 23, 2007             [Page 102]
5712    
5713  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
5714    
5715    
5716  9.  Security Considerations  9.  Security Considerations
# Line 4700  Internet-Draft        LinuxSampler Contr Line 5764  Internet-Draft        LinuxSampler Contr
5764    
5765    
5766    
5767  Schoenebeck               Expires May 30, 2007                 [Page 84]  Schoenebeck            Expires September 23, 2007             [Page 103]
5768    
5769  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
5770    
5771    
5772  10.  Acknowledgments  10.  Acknowledgments
# Line 4720  Internet-Draft        LinuxSampler Contr Line 5784  Internet-Draft        LinuxSampler Contr
5784        Grigor Iliev        Grigor Iliev
5785    
5786    
 11.  References  
5787    
    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate  
               Requirement Levels", RFC 2119, 1997.  
5788    
    [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax  
               Specifications", RFC 2234, 1997.  
5789    
    [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION  
               CONTROL PROTOCOL", RFC 793, 1981.  
5790    
5791    
5792    
# Line 4756  Internet-Draft        LinuxSampler Contr Line 5813  Internet-Draft        LinuxSampler Contr
5813    
5814    
5815    
5816  Schoenebeck               Expires May 30, 2007                 [Page 85]  
5817    
5818    
5819    
5820    
5821    
5822    
5823    Schoenebeck            Expires September 23, 2007             [Page 104]
5824    
5825  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
5826    
5827    
5828  Author's Address  11.  References
5829    
5830     C. Schoenebeck     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
5831     Interessengemeinschaft Software Engineering e. V.                Requirement Levels", RFC 2119, 1997.
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
5832    
5833     Email: schoenebeck at software minus engineering dot org     [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
5834                  Specifications", RFC 2234, 1997.
5835    
5836       [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION
5837                  CONTROL PROTOCOL", RFC 793, 1981.
5838    
5839    
5840    
# Line 4812  Author's Address Line 5876  Author's Address
5876    
5877    
5878    
5879  Schoenebeck               Expires May 30, 2007                 [Page 86]  Schoenebeck            Expires September 23, 2007             [Page 105]
5880    
5881  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol           March 2007
5882    
5883    
5884  Intellectual Property Statement  Author's Address
5885    
5886     The IETF takes no position regarding the validity or scope of any     C. Schoenebeck
5887     intellectual property or other rights that might be claimed to     Interessengemeinschaft Software Engineering e. V.
5888     pertain to the implementation or use of the technology described in     Max-Planck-Str. 39
5889     this document or the extent to which any license under such rights     74081 Heilbronn
5890     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.  
5891    
5892     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.  
5893    
5894    
 Full Copyright Statement  
5895    
    Copyright (C) The Internet Society (2006).  All Rights Reserved.  
5896    
    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.  
5897    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
5898    
    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  
5899    
5900    
5901    
 Schoenebeck               Expires May 30, 2007                 [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5902    
5903    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
5904    
5905    
 Acknowledgment  
5906    
    Funding for the RFC Editor function is currently provided by the  
    Internet Society.  
5907    
5908    
5909    
# Line 4909  Acknowledgment Line 5932  Acknowledgment
5932    
5933    
5934    
5935    Schoenebeck            Expires September 23, 2007             [Page 106]
5936    
5937    Internet-Draft        LinuxSampler Control Protocol           March 2007
5938    
5939    
5940    Full Copyright Statement
5941    
5942       Copyright (C) The IETF Trust (2007).
5943    
5944       This document is subject to the rights, licenses and restrictions
5945       contained in BCP 78, and except as set forth therein, the authors
5946       retain all their rights.
5947    
5948       This document and the information contained herein are provided on an
5949       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
5950       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
5951       THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
5952       OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
5953       THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
5954       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
5955    
5956    
5957    Intellectual Property
5958    
5959       The IETF takes no position regarding the validity or scope of any
5960       Intellectual Property Rights or other rights that might be claimed to
5961       pertain to the implementation or use of the technology described in
5962       this document or the extent to which any license under such rights
5963       might or might not be available; nor does it represent that it has
5964       made any independent effort to identify any such rights.  Information
5965       on the procedures with respect to rights in RFC documents can be
5966       found in BCP 78 and BCP 79.
5967    
5968       Copies of IPR disclosures made to the IETF Secretariat and any
5969       assurances of licenses to be made available, or the result of an
5970       attempt made to obtain a general license or permission for the use of
5971       such proprietary rights by implementers or users of this
5972       specification can be obtained from the IETF on-line IPR repository at
5973       http://www.ietf.org/ipr.
5974    
5975       The IETF invites any interested party to bring to its attention any
5976       copyrights, patents or patent applications, or other proprietary
5977       rights that may cover technology that may be required to implement
5978       this standard.  Please address the information to the IETF at
5979       ietf-ipr@ietf.org.
5980    
5981    
5982    Acknowledgment
5983    
5984       Funding for the RFC Editor function is provided by the IETF
5985       Administrative Support Activity (IASA).
5986    
5987    
5988    
5989    
5990    
5991  Schoenebeck               Expires May 30, 2007                 [Page 88]  Schoenebeck            Expires September 23, 2007             [Page 107]
5992    
Legend:
Removed from v.945  
changed lines
  Added in v.1110
  ViewVC Help
Powered by ViewVC