/[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 993 by iliev, Wed Dec 20 19:56:43 2006 UTC
# Line 3  Line 3 
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Expires: May 30, 2007                                  Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                         November 26, 2006  Expires: June 23, 2007                                 December 20, 2006
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 June 23, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2006).  All Rights Reserved.     Copyright (C) The Internet Society (2006).
41    
42    
 Abstract  
43    
    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.  
44    
45    
46    
# Line 52  Abstract Line 49  Abstract
49    
50    
51    
52  Schoenebeck               Expires May 30, 2007                  [Page 1]  
53    
54    
55    Schoenebeck               Expires June 23, 2007                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
58    
59    
60    Abstract
61    
62       The LinuxSampler Control Protocol (LSCP) is an application-level
63       protocol primarily intended for local and remote controlling the
64       LinuxSampler backend application, which is a sophisticated server-
65       like console application essentially playing back audio samples and
66       manipulating the samples in real time to certain extent.
67    
68    
69  Table of Contents  Table of Contents
# Line 70  Table of Contents Line 79  Table of Contents
79     6.  Description for control commands . . . . . . . . . . . . . . . 14     6.  Description for control commands . . . . . . . . . . . . . . . 14
80       6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 14       6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 14
81       6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 14       6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 14
82         6.2.1.  Getting amount of available audio output drivers . . . 14         6.2.1.  Getting amount of available audio output drivers . . . 15
83         6.2.2.  Getting all available audio output drivers . . . . . . 15         6.2.2.  Getting all available audio output drivers . . . . . . 15
84         6.2.3.  Getting information about a specific audio output         6.2.3.  Getting information about a specific audio output
85                 driver . . . . . . . . . . . . . . . . . . . . . . . . 15                 driver . . . . . . . . . . . . . . . . . . . . . . . . 15
# Line 82  Table of Contents Line 91  Table of Contents
91         6.2.8.  Getting all created audio output device list . . . . . 22         6.2.8.  Getting all created audio output device list . . . . . 22
92         6.2.9.  Getting current settings of an audio output device . . 22         6.2.9.  Getting current settings of an audio output device . . 22
93         6.2.10. Changing settings of audio output devices  . . . . . . 24         6.2.10. Changing settings of audio output devices  . . . . . . 24
94         6.2.11. Getting information about an audio channel . . . . . . 24         6.2.11. Getting information about an audio channel . . . . . . 25
95         6.2.12. Getting information about specific audio channel         6.2.12. Getting information about specific audio channel
96                 parameter  . . . . . . . . . . . . . . . . . . . . . . 26                 parameter  . . . . . . . . . . . . . . . . . . . . . . 26
97         6.2.13. Changing settings of audio output channels . . . . . . 28         6.2.13. Changing settings of audio output channels . . . . . . 28
# Line 90  Table of Contents Line 99  Table of Contents
99         6.3.1.  Getting amount of available MIDI input drivers . . . . 30         6.3.1.  Getting amount of available MIDI input drivers . . . . 30
100         6.3.2.  Getting all available MIDI input drivers . . . . . . . 30         6.3.2.  Getting all available MIDI input drivers . . . . . . . 30
101         6.3.3.  Getting information about a specific MIDI input         6.3.3.  Getting information about a specific MIDI input
102                 driver . . . . . . . . . . . . . . . . . . . . . . . . 30                 driver . . . . . . . . . . . . . . . . . . . . . . . . 31
103         6.3.4.  Getting information about specific MIDI input         6.3.4.  Getting information about specific MIDI input
104                 driver parameter . . . . . . . . . . . . . . . . . . . 31                 driver parameter . . . . . . . . . . . . . . . . . . . 32
105         6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 34         6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 34
106         6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 35         6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 35
107         6.3.7.  Getting all created MIDI input device count  . . . . . 36         6.3.7.  Getting all created MIDI input device count  . . . . . 36
108    
109    
110    
111    Schoenebeck               Expires June 23, 2007                 [Page 2]
112    
113    Internet-Draft        LinuxSampler Control Protocol        December 2006
114    
115    
116         6.3.8.  Getting all created MIDI input device list . . . . . . 36         6.3.8.  Getting all created MIDI input device list . . . . . . 36
117         6.3.9.  Getting current settings of a MIDI input device  . . . 36         6.3.9.  Getting current settings of a MIDI input device  . . . 37
118         6.3.10. Changing settings of MIDI input devices  . . . . . . . 38         6.3.10. Changing settings of MIDI input devices  . . . . . . . 38
119         6.3.11. Getting information about a MIDI port  . . . . . . . . 38         6.3.11. Getting information about a MIDI port  . . . . . . . . 38
120         6.3.12. Getting information about specific MIDI port         6.3.12. Getting information about specific MIDI port
# Line 105  Table of Contents Line 122  Table of Contents
122         6.3.13. Changing settings of MIDI input ports  . . . . . . . . 41         6.3.13. Changing settings of MIDI input ports  . . . . . . . . 41
123       6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 42       6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 42
124         6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 42         6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 42
   
   
   
 Schoenebeck               Expires May 30, 2007                  [Page 2]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
125         6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 43         6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 43
126         6.4.3.  Getting all created sampler channel count  . . . . . . 44         6.4.3.  Getting all created sampler channel count  . . . . . . 44
127         6.4.4.  Getting all created sampler channel list . . . . . . . 44         6.4.4.  Getting all created sampler channel list . . . . . . . 44
# Line 124  Internet-Draft        LinuxSampler Contr Line 133  Internet-Draft        LinuxSampler Contr
133         6.4.10. Getting sampler channel information  . . . . . . . . . 48         6.4.10. Getting sampler channel information  . . . . . . . . . 48
134         6.4.11. Current number of active voices  . . . . . . . . . . . 51         6.4.11. Current number of active voices  . . . . . . . . . . . 51
135         6.4.12. Current number of active disk streams  . . . . . . . . 51         6.4.12. Current number of active disk streams  . . . . . . . . 51
136         6.4.13. Current fill state of disk stream buffers  . . . . . . 51         6.4.13. Current fill state of disk stream buffers  . . . . . . 52
137         6.4.14. Setting audio output device  . . . . . . . . . . . . . 52         6.4.14. Setting audio output device  . . . . . . . . . . . . . 53
138         6.4.15. Setting audio output type  . . . . . . . . . . . . . . 53         6.4.15. Setting audio output type  . . . . . . . . . . . . . . 53
139         6.4.16. Setting audio output channel . . . . . . . . . . . . . 54         6.4.16. Setting audio output channel . . . . . . . . . . . . . 54
140         6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 55         6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 55
141         6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 55         6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 56
142         6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 56         6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 56
143         6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57         6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57
144         6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 57         6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 58
145         6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58         6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58
146         6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 59         6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 59
147         6.4.24. Resetting a sampler channel  . . . . . . . . . . . . . 59         6.4.24. Assigning a MIDI instrument map to a sampler
148       6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 60                 channel  . . . . . . . . . . . . . . . . . . . . . . . 60
149         6.5.1.  Register front-end for receiving event messages  . . . 60         6.4.25. Resetting a sampler channel  . . . . . . . . . . . . . 61
150         6.5.  Controlling connection . . . . . . . . . . . . . . . . . . 61
151           6.5.1.  Register front-end for receiving event messages  . . . 61
152         6.5.2.  Unregister front-end for not receiving event         6.5.2.  Unregister front-end for not receiving event
153                 messages . . . . . . . . . . . . . . . . . . . . . . . 61                 messages . . . . . . . . . . . . . . . . . . . . . . . 62
154         6.5.3.  Enable or disable echo of commands . . . . . . . . . . 62         6.5.3.  Enable or disable echo of commands . . . . . . . . . . 63
155         6.5.4.  Close client connection  . . . . . . . . . . . . . . . 62         6.5.4.  Close client connection  . . . . . . . . . . . . . . . 63
156       6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 62       6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 64
157         6.6.1.  Current number of active voices  . . . . . . . . . . . 62         6.6.1.  Current number of active voices  . . . . . . . . . . . 64
158         6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 63         6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 64
159         6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 63         6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 64
160         6.6.4.  General sampler informations . . . . . . . . . . . . . 63         6.6.4.  General sampler informations . . . . . . . . . . . . . 65
161       6.7.  MIDI Instrument Mapping  . . . . . . . . . . . . . . . . . 64       6.7.  MIDI Instrument Mapping  . . . . . . . . . . . . . . . . . 65
162         6.7.1.  Create or replace a MIDI instrument map entry  . . . . 64         6.7.1.  Create a new MIDI instrument map . . . . . . . . . . . 66
163         6.7.2.  Getting ammount of MIDI instrument map entries . . . . 67         6.7.2.  Delete one particular or all MIDI instrument maps  . . 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  
164    
165    
166    
167  Schoenebeck               Expires May 30, 2007                  [Page 3]  Schoenebeck               Expires June 23, 2007                 [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
   
   
      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  
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
170    
171    
172           6.7.3.  Get amount of existing MIDI instrument maps  . . . . . 67
173           6.7.4.  Getting all created MIDI instrument maps . . . . . . . 68
174           6.7.5.  Getting MIDI instrument map information  . . . . . . . 68
175           6.7.6.  Renaming a MIDI instrument map . . . . . . . . . . . . 69
176           6.7.7.  Create or replace a MIDI instrument map entry  . . . . 69
177           6.7.8.  Getting ammount of MIDI instrument map entries . . . . 72
178           6.7.9.  Getting indeces of all entries of a MIDI
179                   instrument map . . . . . . . . . . . . . . . . . . . . 73
180           6.7.10. Remove an entry from the MIDI instrument map . . . . . 73
181           6.7.11. Get current settings of MIDI instrument map entry  . . 74
182           6.7.12. Clear MIDI instrument map  . . . . . . . . . . . . . . 76
183       7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 77
184       8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
185         8.1.  Number of audio output devices changed . . . . . . . . . . 87
186         8.2.  Audio output device's settings changed . . . . . . . . . . 87
187         8.3.  Number of MIDI input devices changed . . . . . . . . . . . 87
188         8.4.  MIDI input device's settings changed . . . . . . . . . . . 88
189         8.5.  Number of sampler channels changed . . . . . . . . . . . . 88
190         8.6.  Number of active voices changed  . . . . . . . . . . . . . 88
191         8.7.  Number of active disk streams changed  . . . . . . . . . . 89
192         8.8.  Disk stream buffer fill state changed  . . . . . . . . . . 89
193         8.9.  Channel information changed  . . . . . . . . . . . . . . . 89
194         8.10. Total number of active voices changed  . . . . . . . . . . 90
195         8.11. Number of MIDI instrument maps changed . . . . . . . . . . 90
196         8.12. MIDI instrument map information changed  . . . . . . . . . 90
197         8.13. Number of MIDI instruments changed . . . . . . . . . . . . 91
198         8.14. MIDI instrument information changed  . . . . . . . . . . . 91
199         8.15. Miscellaneous and debugging events . . . . . . . . . . . . 92
200       9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 93
201       10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 94
202       11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 95
203       Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 96
204       Intellectual Property and Copyright Statements . . . . . . . . . . 97
205    
206    
207    
# Line 218  Internet-Draft        LinuxSampler Contr Line 220  Internet-Draft        LinuxSampler Contr
220    
221    
222    
223    Schoenebeck               Expires June 23, 2007                 [Page 4]
   
 Schoenebeck               Expires May 30, 2007                  [Page 4]  
224    
225  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
226    
227    
228  1.  Requirements notation  1.  Requirements notation
# Line 276  Internet-Draft        LinuxSampler Contr Line 276  Internet-Draft        LinuxSampler Contr
276    
277    
278    
279  Schoenebeck               Expires May 30, 2007                  [Page 5]  Schoenebeck               Expires June 23, 2007                 [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
282    
283    
284  2.  Versioning of this specification  2.  Versioning of this specification
# Line 332  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335  Schoenebeck               Expires May 30, 2007                  [Page 6]  Schoenebeck               Expires June 23, 2007                 [Page 6]
336    
337  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
338    
339    
340  3.  Introduction  3.  Introduction
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck               Expires May 30, 2007                  [Page 7]  Schoenebeck               Expires June 23, 2007                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
394    
395    
396  4.  Focus of this protocol  4.  Focus of this protocol
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck               Expires May 30, 2007                  [Page 8]  Schoenebeck               Expires June 23, 2007                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
450    
451    
452  5.  Communication Overview  5.  Communication Overview
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck               Expires May 30, 2007                  [Page 9]  Schoenebeck               Expires June 23, 2007                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
506    
507    
508  5.1.1.  Result format  5.1.1.  Result format
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck               Expires May 30, 2007                 [Page 10]  Schoenebeck               Expires June 23, 2007                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
562    
563    
564     set has the following format:     set has the following format:
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck               Expires May 30, 2007                 [Page 11]  Schoenebeck               Expires June 23, 2007                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
618    
619    
620     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck               Expires May 30, 2007                 [Page 12]  Schoenebeck               Expires June 23, 2007                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
674    
675    
676         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck               Expires May 30, 2007                 [Page 13]  Schoenebeck               Expires June 23, 2007                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
730    
731    
732  6.  Description for control commands  6.  Description for control commands
# Line 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 June 23, 2007                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
786    
787    
788    6.2.1.  Getting amount of available audio output drivers
789    
790       Use the following command to get the number of audio output drivers
791     currently available for the LinuxSampler instance:     currently available for the LinuxSampler instance:
792    
793        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 833  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839    Schoenebeck               Expires June 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        December 2006
842    
843    
844        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck               Expires May 30, 2007                 [Page 16]  Schoenebeck               Expires June 23, 2007                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
898    
899    
900     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck               Expires May 30, 2007                 [Page 17]  Schoenebeck               Expires June 23, 2007                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
954    
955    
956        MULTIPLICITY -        MULTIPLICITY -
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck               Expires May 30, 2007                 [Page 18]  Schoenebeck               Expires June 23, 2007                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1010    
1011    
1012           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck               Expires May 30, 2007                 [Page 19]  Schoenebeck               Expires June 23, 2007                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1066    
1067    
1068           "TYPE: INT"           "TYPE: INT"
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck               Expires May 30, 2007                 [Page 20]  Schoenebeck               Expires June 23, 2007                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1122    
1123    
1124           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck               Expires May 30, 2007                 [Page 21]  Schoenebeck               Expires June 23, 2007                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1178    
1179    
1180        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck               Expires May 30, 2007                 [Page 22]  Schoenebeck               Expires June 23, 2007                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1234    
1235    
1236     Possible Answers:     Possible Answers:
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck               Expires May 30, 2007                 [Page 23]  Schoenebeck               Expires June 23, 2007                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1290    
1291    
1292           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 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 June 23, 2007                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1346    
1347    
1348    6.2.11.  Getting information about an audio channel
1349    
1350       Use the following command to get information about an audio channel:
1351    
1352        GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>        GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
1353    
1354     Where <device-id> is the numerical ID of the audio output device as     Where <device-id> is the numerical ID of the audio output device as
# Line 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 June 23, 2007                [Page 25]
 Schoenebeck               Expires May 30, 2007                 [Page 25]  
1400    
1401  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1402    
1403    
1404       Examples:
1405    
1406        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
1407    
1408        S: "NAME: studio monitor left"        S: "NAME: studio monitor left"
# Line 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 June 23, 2007                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1458    
1459    
1460       channel number and <param> a specific channel parameter name for
1461       which information should be obtained (as returned by the "GET
1462     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).     AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
1463    
1464     Possible Answers:     Possible Answers:
# Line 1506  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511    Schoenebeck               Expires June 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        December 2006
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 June 23, 2007                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1570    
1571    
1572        "OK" -        "OK" -
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck               Expires May 30, 2007                 [Page 29]  Schoenebeck               Expires June 23, 2007                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1626    
1627    
1628     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 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 June 23, 2007                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1682    
1683    
1684    6.3.3.  Getting information about a specific MIDI input driver
1685    
1686       Use the following command to get detailed information about a
1687       specific MIDI input driver:
1688    
1689        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>
1690    
1691     Where <midi-input-driver> is the name of the MIDI input driver as     Where <midi-input-driver> is the name of the MIDI input driver as
# Line 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 June 23, 2007                [Page 31]
1736    
1737    Internet-Draft        LinuxSampler Control Protocol        December 2006
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 June 23, 2007                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1794    
1795    
1796          FIX -
1797    
1798             either true or false, if false then this parameter can be
1799             changed at any time, once the device is created by the 'CREATE
1800           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1801           matter which driver parameter)           matter which driver parameter)
1802    
# Line 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 June 23, 2007                [Page 33]
   
 Schoenebeck               Expires May 30, 2007                 [Page 33]  
1848    
1849  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1850    
1851    
1852             may also appear without (optionally returned, dependent to
1853             driver parameter)
1854    
1855        POSSIBILITIES -        POSSIBILITIES -
1856    
1857           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
# Line 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 June 23, 2007                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
1906    
1907    
1908          "OK[<device-id>]" -
1909    
1910             in case the device was successfully created, where <device-id>
1911             is the numerical ID of the new device
1912    
1913        "WRN[<device-id>]:<warning-code>:<warning-message>" -        "WRN[<device-id>]:<warning-code>:<warning-message>" -
1914    
# Line 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 June 23, 2007                [Page 35]
1960    
1961    Internet-Draft        LinuxSampler Control Protocol        December 2006
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 June 23, 2007                [Page 36]
2016    
2017    Internet-Draft        LinuxSampler Control Protocol        December 2006
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 June 23, 2007                [Page 37]
2072    
2073    Internet-Draft        LinuxSampler Control Protocol        December 2006
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.  
2124    
    Possible Answers:  
2125    
2126    
2127    Schoenebeck               Expires June 23, 2007                [Page 38]
 Schoenebeck               Expires May 30, 2007                 [Page 38]  
2128    
2129  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2130    
2131    
2132       MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
2133       input port number.
2134    
2135       Possible Answers:
2136    
2137        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2138        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2139        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 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 June 23, 2007                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2186    
2187    
2188          character string to that info category.  There is information
2189          which is always returned, independently of the given channel
2190          parameter and there is optional information which are only shown
2191          dependently to the given MIDI port.  At the moment the following
2192          information categories are defined:
2193    
2194        TYPE -        TYPE -
2195    
2196           either "BOOL" for boolean value(s) or "INT" for integer           either "BOOL" for boolean value(s) or "INT" for integer
# Line 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 June 23, 2007                [Page 40]
2240    
2241    Internet-Draft        LinuxSampler Control Protocol        December 2006
2242    
2243    
2244             returned, dependent to device and port parameter)
2245    
2246  Schoenebeck               Expires May 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 June 23, 2007                [Page 41]
2296    
2297    Internet-Draft        LinuxSampler Control Protocol        December 2006
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 June 23, 2007                [Page 42]
   
 Schoenebeck               Expires May 30, 2007                 [Page 42]  
2352    
2353  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2354    
2355    
2356             or more patch parameters provided by the loaded instrument
2357             file), providing an appropriate warning code and warning
2358             message
2359    
2360        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2361    
2362           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 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 June 23, 2007                [Page 43]
 Schoenebeck               Expires May 30, 2007                 [Page 43]  
2408    
2409  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2410    
2411    
2412       Example:
2413    
2414    
2415    
2416  6.4.3.  Getting all created sampler channel count  6.4.3.  Getting all created sampler channel count
# Line 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 June 23, 2007                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2466    
2467    
2468          ADD CHANNEL
2469    
2470       This will increment the sampler channel count by one and the new
2471     sampler channel will be appended to the end of the sampler channel     sampler channel will be appended to the end of the sampler channel
2472     list.  The front-end should send the respective, related commands     list.  The front-end should send the respective, related commands
2473     right after to e.g. load an engine, load an instrument and setting     right after to e.g. load an engine, load an instrument and setting
# Line 2513  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519    Schoenebeck               Expires June 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        December 2006
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 June 23, 2007                [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2578    
2579    
2580        LinuxSampler will answer by sending a comma separated list of the        LinuxSampler will answer by sending a comma separated list of the
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck               Expires May 30, 2007                 [Page 47]  Schoenebeck               Expires June 23, 2007                [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2634    
2635    
2636           "VERSION: testing-1.0"           "VERSION: testing-1.0"
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck               Expires May 30, 2007                 [Page 48]  Schoenebeck               Expires June 23, 2007                [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2690    
2691    
2692              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck               Expires May 30, 2007                 [Page 49]  Schoenebeck               Expires June 23, 2007                [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
2746    
2747    
2748           MUTE -           MUTE -
# Line 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 June 23, 2007                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol        December 2006
2802    
2803    
2804             "MIDI_INPUT_CHANNEL: 5"
2805    
2806             "VOLUME: 1.0"
2807    
2808             "MUTE: false"
2809    
2810  Schoenebeck               Expires May 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.  
   
    Example:  
2852    
2853    
2854    
2855  6.4.13.  Current fill state of disk stream buffers  Schoenebeck               Expires June 23, 2007                [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol        December 2006
2858    
    The front-end can ask for the current fill state of all disk streams  
    on a sampler channel by sending the following command:  
2859    
2860          return "NA" for not available.
2861    
2862       Example:
2863    
2864    
2865    
2866  Schoenebeck               Expires May 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 June 23, 2007                [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol        December 2006
2914    
2915    
2916        S: ""        S: ""
2917    
2918  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 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 June 23, 2007                [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol        December 2006
2970    
2971    
2972     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
2973     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
2974    
# Line 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 June 23, 2007                [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol        December 2006
3026    
3027    
3028           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3029           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3030           warning message           warning message
# Line 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 June 23, 2007                [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol        December 2006
3082    
3083    
3084  6.4.18.  Setting MIDI input type  6.4.18.  Setting MIDI input type
3085    
3086     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
# Line 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 June 23, 2007                [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol        December 2006
3138    
3139    
3140           on success           on success
3141    
3142        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
# Line 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 June 23, 2007                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol        December 2006
3194    
3195    
3196    
3197    
3198  6.4.21.  Setting channel volume  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 June 23, 2007                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol        December 2006
3250    
3251    
3252        "OK" -        "OK" -
3253    
3254           on success           on success
# Line 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 June 23, 2007                [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol        December 2006
3306    
3307    
3308     Examples:     Examples:
3309    
3310    
3311    
3312  6.4.24.  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 May 30, 2007                 [Page 59]  Schoenebeck               Expires June 23, 2007                [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3362    
3363    
3364       Examples:
3365    
3366    
3367    
3368    6.4.25.  Resetting a sampler channel
3369    
3370       The front-end can reset a particular sampler channel by sending the
3371       following command:
3372    
3373          RESET CHANNEL <sampler-channel>
3374    
3375       Where <sampler-channel> defines the sampler channel to be reset.
3376     This will cause the engine on that sampler channel, its voices and     This will cause the engine on that sampler channel, its voices and
3377     eventually disk streams and all control and status variables to be     eventually disk streams and all control and status variables to be
3378     reset.     reset.
# Line 3340  Internet-Draft        LinuxSampler Contr Line 3408  Internet-Draft        LinuxSampler Contr
3408     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3409     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
3410    
       SUBSCRIBE <event-id>  
3411    
    where <event-id> will be replaced by the respective event that client  
    wants to subscribe to.  
3412    
    Possible Answers:  
   
       "OK" -  
3413    
          on success  
3414    
3415    Schoenebeck               Expires June 23, 2007                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol        December 2006
3418    
3419    
3420          SUBSCRIBE <event-id>
3421    
3422       where <event-id> will be replaced by the respective event that client
3423       wants to subscribe to.
3424    
3425       Possible Answers:
3426    
3427  Schoenebeck               Expires May 30, 2007                 [Page 60]        "OK" -
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3428    
3429             on success
3430    
3431        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3432    
# Line 3398  Internet-Draft        LinuxSampler Contr Line 3465  Internet-Draft        LinuxSampler Contr
3465           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3466           message           message
3467    
       "ERR:<error-code>:<error-message>" -  
   
          in case it failed, providing an appropriate error code and  
          error message  
   
    Examples:  
3468    
3469    
3470    
3471    Schoenebeck               Expires June 23, 2007                [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol        December 2006
3474    
3475    
3476          "ERR:<error-code>:<error-message>" -
3477    
3478             in case it failed, providing an appropriate error code and
3479             error message
3480    
3481       Examples:
3482    
 Schoenebeck               Expires May 30, 2007                 [Page 61]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3483    
3484    
3485  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 3520  Internet-Draft        LinuxSampler Contr
3520     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
3521     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
3522    
 6.6.  Global commands  
3523    
    The following commands have global impact on the sampler.  
3524    
 6.6.1.  Current number of active voices  
3525    
    The front-end can ask for the current number of active voices on the  
    sampler by sending the following command:  
3526    
3527    Schoenebeck               Expires June 23, 2007                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol        December 2006
3530    
3531    
3532    6.6.  Global commands
3533    
3534       The following commands have global impact on the sampler.
3535    
3536  Schoenebeck               Expires May 30, 2007                 [Page 62]  6.6.1.  Current number of active voices
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
3537    
3538       The front-end can ask for the current number of active voices on the
3539       sampler by sending the following command:
3540    
3541        GET TOTAL_VOICE_COUNT        GET TOTAL_VOICE_COUNT
3542    
# Line 3509  Internet-Draft        LinuxSampler Contr Line 3574  Internet-Draft        LinuxSampler Contr
3574    
3575    
3576    
3577    
3578    
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires June 23, 2007                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol        December 2006
3586    
3587    
3588  6.6.4.  General sampler informations  6.6.4.  General sampler informations
3589    
3590     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 3597  Internet-Draft        LinuxSampler Contr
3597        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
3598        answer line begins with the information category name followed by        answer line begins with the information category name followed by
3599        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  
   
   
3600        character string to that information category.  At the moment the        character string to that information category.  At the moment the
3601        following categories are defined:        following categories are defined:
3602    
# Line 3558  Internet-Draft        LinuxSampler Contr Line 3626  Internet-Draft        LinuxSampler Contr
3626     actually map arbitrary MIDI bank select / program change numbers with     actually map arbitrary MIDI bank select / program change numbers with
3627     real instruments.     real instruments.
3628    
3629     By default, that is when the sampler is launched, this map will be     The sampler allows to manage an arbitrary amount of MIDI instrument
3630     empty, thus the sampler will simply ignore all program change     maps which define which instrument to load on which MIDI program
3631     messages.  The front-end has to explicitly add entries to the map so     change message.
3632     the sampler knows how to react on a given program change message,  
3633     that is by switching to the respectively defined engine type and     By default, that is when the sampler is launched, there is no map,
3634     loading the respective instrument.     thus the sampler will simply ignore all program change messages.  The
3635       front-end has to explicitly create at least one map, add entries to
3636    
3637    
3638    
3639    Schoenebeck               Expires June 23, 2007                [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol        December 2006
3642    
3643    
3644       the map and tell the respective sampler channel(s) which MIDI
3645       instrument map to use, so the sampler knows how to react on a given
3646       program change message on the respective sampler channel, that is by
3647       switching to the respectively defined engine type and loading the
3648       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
3649       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
3650       channel.
3651    
3652     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
3653     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 3656  Internet-Draft        LinuxSampler Contr
3656     sampler to switch to the respective instrument as reflected by the     sampler to switch to the respective instrument as reflected by the
3657     current MIDI instrument map.     current MIDI instrument map.
3658    
3659  6.7.1.  Create or replace a MIDI instrument map entry  6.7.1.  Create a new MIDI instrument map
3660    
3661       The front-end can add a new MIDI instrument map by sending the
3662       following command:
3663    
3664          ADD MIDI_INSTRUMENT_MAP [<name>]
3665    
3666     The front-end can create a new or replace an existing entry in the     Where <name> is an optional argument allowing to assign a custom name
3667       to the new map.  MIDI instrument Map names do not have to be unique.
3668    
3669       Possible Answers:
3670    
3671          "OK[<map>]" -
3672    
3673             in case a new MIDI instrument map could be added, where <map>
3674             reflects the unique ID of the newly created MIDI instrument map
3675    
3676          "ERR:<error-code>:<error-message>" -
3677    
3678             when a new map could not be created, which might never occur in
3679             practice
3680    
3681       Examples:
3682    
3683          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
3684    
3685          S: "OK[0]"
3686    
3687          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
3688    
3689          S: "OK[1]"
3690    
3691    
3692    
3693    
3694    
3695    Schoenebeck               Expires June 23, 2007                [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol        December 2006
3698    
3699    
3700          C: "ADD MIDI_INSTRUMENT_MAP"
3701    
3702          S: "OK[5]"
3703    
3704    6.7.2.  Delete one particular or all MIDI instrument maps
3705    
3706       The front-end can delete a particular MIDI instrument map by sending
3707       the following command:
3708    
3709          REMOVE MIDI_INSTRUMENT_MAP <map>
3710    
3711       Where <map> reflects the unique ID of the map to delete as returned
3712       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
3713    
3714       The front-end can delete all MIDI instrument maps by sending the
3715       following command:
3716    
3717          REMOVE MIDI_INSTRUMENT_MAP ALL
3718    
3719       Possible Answers:
3720    
3721          "OK" -
3722    
3723             in case the map(s) could be deleted
3724    
3725          "ERR:<error-code>:<error-message>" -
3726    
3727             when the given map does not exist
3728    
3729       Examples:
3730    
3731          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
3732    
3733          S: "OK"
3734    
3735          C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
3736    
3737          S: "OK"
3738    
3739    6.7.3.  Get amount of existing MIDI instrument maps
3740    
3741       The front-end can retrieve the current amount of MIDI instrument maps
3742       by sending the following command:
3743    
3744          GET MIDI_INSTRUMENT_MAPS
3745    
3746       Possible Answers:
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires June 23, 2007                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol        December 2006
3754    
3755    
3756          The sampler will answer by returning the current number of MIDI
3757          instrument maps.
3758    
3759       Example:
3760    
3761          C: "GET MIDI_INSTRUMENT_MAPS"
3762    
3763          S: "2"
3764    
3765    6.7.4.  Getting all created MIDI instrument maps
3766    
3767       The number of MIDI instrument maps can change on runtime.  To get the
3768       current list of MIDI instrument maps, the front-end can send the
3769       following command:
3770    
3771          LIST MIDI_INSTRUMENT_MAPS
3772    
3773       Possible Answers:
3774    
3775          The sampler will answer by returning a comma separated list with
3776          all MIDI instrument maps' numerical IDs.
3777    
3778       Example:
3779    
3780          C: "LIST MIDI_INSTRUMENT_MAPS"
3781    
3782          S: "0,1,5,12"
3783    
3784    6.7.5.  Getting MIDI instrument map information
3785    
3786       The front-end can ask for the current settings of a MIDI instrument
3787       map by sending the following command:
3788    
3789          GET MIDI_INSTRUMENT_MAP INFO <map>
3790    
3791       Where <map> is the numerical ID of the map the front-end is
3792       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
3793       (Section 6.7.4) command.
3794    
3795       Possible Answers:
3796    
3797          LinuxSampler will answer by sending a <CRLF> separated list.  Each
3798          answer line begins with the settings category name followed by a
3799          colon and then a space character <SP> and finally the info
3800          character string to that setting category.  At the moment the
3801          following categories are defined:
3802    
3803    
3804    
3805    
3806    
3807    Schoenebeck               Expires June 23, 2007                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol        December 2006
3810    
3811    
3812    
3813    
3814             NAME -
3815    
3816                custom name of the given map, which does not have to be
3817                unique
3818    
3819       The mentioned fields above don't have to be in particular order.
3820    
3821       Example:
3822    
3823          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
3824    
3825          S: "NAME: Standard Map"
3826    
3827             "."
3828    
3829    6.7.6.  Renaming a MIDI instrument map
3830    
3831       The front-end can alter the custom name of a MIDI instrument map by
3832       sending the following command:
3833    
3834          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
3835    
3836       Where <map> is the numerical ID of the map and <name> the new custom
3837       name of the map, which does not have to be unique.
3838    
3839       Possible Answers:
3840    
3841          "OK" -
3842    
3843             on success
3844    
3845          "ERR:<error-code>:<error-message>" -
3846    
3847             in case the given map does not exist
3848    
3849       Example:
3850    
3851          C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
3852    
3853          S: "OK"
3854    
3855    6.7.7.  Create or replace a MIDI instrument map entry
3856    
3857       The front-end can create a new or replace an existing entry in a
3858     sampler's MIDI instrument map by sending the following command:     sampler's MIDI instrument map by sending the following command:
3859    
3860    
3861    
3862    
3863  Schoenebeck               Expires May 30, 2007                 [Page 64]  Schoenebeck               Expires June 23, 2007                [Page 69]
3864    
3865  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3866    
3867    
3868        MAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog>        MAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog> <engine_name>
3869        <engine_name> <filename> <instrument_index> <volume_value>        <filename> <instrument_index> <volume_value> [<instr_load_mode>]
3870        [<instr_load_mode>] [<name>]        [<name>]
3871    
3872     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
3873     the MIDI bank select MSB (coarse) index, <midi_bank_lsb> an integer     integer value between 0..16383 reflecting the MIDI bank select index,
3874     value between 0..127 reflecting the MIDI bank select LSB (fine)     <midi_prog> an integer value between 0..127 reflecting the MIDI
3875     index, <midi_prog> an integer value between 0..127 reflecting the     program change index, <engine_name> a sampler engine name as returned
3876     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  
3877     encapsulated into apostrophes), <filename> the name of the     encapsulated into apostrophes), <filename> the name of the
3878     instrument's file to be deployed (encapsulated into apostrophes),     instrument's file to be deployed (encapsulated into apostrophes),
3879     <instrument_index> the index (integer value) of the instrument within     <instrument_index> the index (integer value) of the instrument within
# Line 3636  Internet-Draft        LinuxSampler Contr Line 3915  Internet-Draft        LinuxSampler Contr
3915    
3916    
3917    
3918  Schoenebeck               Expires May 30, 2007                 [Page 65]  
3919    Schoenebeck               Expires June 23, 2007                [Page 70]
3920    
3921  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3922    
3923    
3924        not supplied -        not supplied -
# Line 3664  Internet-Draft        LinuxSampler Contr Line 3944  Internet-Draft        LinuxSampler Contr
3944     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
3945     this, in case the frontend shows the load modes of entries, the     this, in case the frontend shows the load modes of entries, the
3946     frontend should retrieve the actual mode by i.e. sending "GET     frontend should retrieve the actual mode by i.e. sending "GET
3947     MIDI_INSTRUMENT INFO" (Section 6.7.5) command(s).  Finally the     MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
3948     OPTIONAL <name> argument allows to set a custom name (encapsulated     OPTIONAL <name> argument allows to set a custom name (encapsulated
3949     into apostrophes) for the mapping entry, useful for frontends for     into apostrophes) for the mapping entry, useful for frontends for
3950     displaying an appropriate name for mapped instruments (using "GET     displaying an appropriate name for mapped instruments (using "GET
3951     MIDI_INSTRUMENT INFO" (Section 6.7.5)).     MIDI_INSTRUMENT INFO" (Section 6.7.11)).
3952    
3953     The "MAP MIDI_INSTRUMENT" command will immediately return, thus it     The "MAP MIDI_INSTRUMENT" command will immediately return, thus it
3954     will not block when an instrument is to be loaded due to a     will not block when an instrument is to be loaded due to a
# Line 3685  Internet-Draft        LinuxSampler Contr Line 3965  Internet-Draft        LinuxSampler Contr
3965    
3966        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3967    
3968           when the given engine does not exist or a value is out of range           when the given map or engine does not exist or a value is out
3969             of range
3970    
3971     Examples:     Examples:
3972    
3973    
3974    
3975    Schoenebeck               Expires June 23, 2007                [Page 71]
 Schoenebeck               Expires May 30, 2007                 [Page 66]  
3976    
3977  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
3978    
3979    
3980        C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
3981        0.8 PERSISTENT"        0.8 PERSISTENT"
3982    
3983        S: "OK"        S: "OK"
3984    
3985        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
3986        1.0"        1.0"
3987    
3988        S: "OK"        S: "OK"
# Line 3712  Internet-Draft        LinuxSampler Contr Line 3992  Internet-Draft        LinuxSampler Contr
3992    
3993        S: "OK"        S: "OK"
3994    
3995        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
3996        'Silent Piano'"        'Silent Piano'"
3997    
3998        S: "OK"        S: "OK"
3999    
4000        C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0        C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0
4001        1.0 PERSISTENT 'Foo Drumkit'"        PERSISTENT 'Foo Drumkit'"
4002    
4003        S: "OK"        S: "OK"
4004    
4005  6.7.2.  Getting ammount of MIDI instrument map entries  6.7.8.  Getting ammount of MIDI instrument map entries
4006    
4007       The front-end can query the amount of currently existing entries in a
4008       MIDI instrument map by sending the following command:
4009    
4010     The front-end can query the amount of currently existing MIDI        GET MIDI_INSTRUMENTS <map>
    instrument map entries by sending the following command:  
4011    
4012        GET MIDI_INSTRUMENTS     The front-end can query the amount of currently existing entries in
4013       all MIDI instrument maps by sending the following command:
4014    
4015          GET MIDI_INSTRUMENTS ALL
4016    
4017     Possible Answers:     Possible Answers:
4018    
4019        LinuxSampler will answer by sending the current number of entries        The sampler will answer by sending the current number of entries
4020        in the sampler's MIDI instrument map.        in the MIDI instrument map(s).
4021    
4022     Example:     Example:
4023    
4024        C: "GET MIDI_INSTRUMENTS"        C: "GET MIDI_INSTRUMENTS 0"
4025    
4026        S: "634"        S: "234"
4027    
 6.7.3.  Getting indeces of all MIDI instrument map entries  
4028    
    The front-end can query a list of all currently existing MIDI  
    instrument map entries by sending the following command:  
4029    
4030    
4031    Schoenebeck               Expires June 23, 2007                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol        December 2006
4034    
4035    
4036  Schoenebeck               Expires May 30, 2007                 [Page 67]        C: "GET MIDI_INSTRUMENTS ALL"
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4037    
4038          S: "954"
4039    
4040        LIST MIDI_INSTRUMENTS  6.7.9.  Getting indeces of all entries of a MIDI instrument map
4041    
4042       The front-end can query a list of all currently existing entries in a
4043       certain MIDI instrument map by sending the following command:
4044    
4045          LIST MIDI_INSTRUMENTS <map>
4046    
4047       Where <map> is the numeric ID of the MIDI instrument map.
4048    
4049       The front-end can query a list of all currently existing entries of
4050       all MIDI instrument maps by sending the following command:
4051    
4052          LIST MIDI_INSTRUMENTS ALL
4053    
4054     Possible Answers:     Possible Answers:
4055    
4056        LinuxSampler will answer by sending a comma separated list of MIDI        The sampler will answer by sending a comma separated list of map
4057        bank MSB (coarse) - MIDI bank LSB (fine) - MIDI program triples,        ID - MIDI bank - MIDI program triples, where each triple is
4058        where each triple is encapsulated into curly braces.  The list is        encapsulated into curly braces.  The list is returned in one
4059        returned in one single line.  Each triple just reflects the key of        single line.  Each triple just reflects the key of the respective
4060        the respective map entry, thus subsequent "GET MIDI_INSTRUMENT        map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4061        INFO" (Section 6.7.5) command(s) are necessary to retrieve        (Section 6.7.11) command(s) are necessary to retrieve detailed
4062        detailed informations about each entry.        informations about each entry.
4063    
4064     Example:     Example:
4065    
4066        C: "LIST MIDI_INSTRUMENTS"        C: "LIST MIDI_INSTRUMENTS 0"
4067    
4068        S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"        S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4069    
4070  6.7.4.  Remove an entry from the MIDI instrument map  6.7.10.  Remove an entry from the MIDI instrument map
4071    
4072     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
4073     sending the following command:     sending the following command:
4074    
4075        UNMAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog>        UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4076    
4077     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>
4078     the MIDI bank MSB (coarse) value, <midi_bank_lsb> an integer value     is an integer value between 0..16383 reflecting the MIDI bank value
4079     between 0..127 reflecting the MIDI bank LSB (fine) value and     and <midi_prog> an integer value between 0..127 reflecting the MIDI
4080     <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.  
4081    
4082     Possible Answers:     Possible Answers:
4083    
4084    
4085    
4086    
4087    Schoenebeck               Expires June 23, 2007                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol        December 2006
4090    
4091    
4092        "OK" -        "OK" -
4093    
4094           usually           usually
# Line 3796  Internet-Draft        LinuxSampler Contr Line 4099  Internet-Draft        LinuxSampler Contr
4099    
4100     Example:     Example:
4101    
4102        C: "UNMAP MIDI_INSTRUMENT 2 40 127"        C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4103    
4104        S: "OK"        S: "OK"
4105    
4106    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  
4107    
4108     The front-end can retrieve the current settings of a certain     The front-end can retrieve the current settings of a certain
4109     instrument map entry by sending the following command:     instrument map entry by sending the following command:
4110    
4111        GET MIDI_INSTRUMENT INFO <midi_bank_msb> <midi_bank_lsb>        GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
       <midi_prog>  
4112    
4113     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>
4114     the MIDI bank MSB (coarse) value, <midi_bank_lsb> an integer value     is an integer value between 0..16383 reflecting the MIDI bank value,
4115     between 0..127 reflecting the MIDI bank LSB (fine) value and     <midi_bank> and <midi_prog> an integer value between 0..127
4116     <midi_prog> an integer value between 0..127 reflecting the MIDI     reflecting the MIDI program value of the map's entrie's key index
4117     program value of the map entrie's key index triple.     triple.
4118    
4119     Possible Answers:     Possible Answers:
4120    
# Line 3836  Internet-Draft        LinuxSampler Contr Line 4129  Internet-Draft        LinuxSampler Contr
4129           Name for this MIDI instrument map entry (if defined).  This           Name for this MIDI instrument map entry (if defined).  This
4130           name shall be used by frontends for displaying a name for this           name shall be used by frontends for displaying a name for this
4131           mapped instrument.  It can be set and changed with the "MAP           mapped instrument.  It can be set and changed with the "MAP
4132           MIDI_INSTRUMENT" (Section 6.7.1) command and does not have to           MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4133           be unique.           be unique.
4134    
4135        "ENGINE_NAME" -        "ENGINE_NAME" -
4136    
4137           Name of the engine to be deployed for this instrument.           Name of the engine to be deployed for this instrument.
4138    
4139    
4140    
4141    
4142    
4143    Schoenebeck               Expires June 23, 2007                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol        December 2006
4146    
4147    
4148        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
4149    
4150           File name of the instrument.           File name of the instrument.
# Line 3857  Internet-Draft        LinuxSampler Contr Line 4159  Internet-Draft        LinuxSampler Contr
4159           contrast to the "NAME" field, the "INSTRUMENT_NAME" field           contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4160           cannot be changed.           cannot be changed.
4161    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
4162        "LOAD_MODE" -        "LOAD_MODE" -
4163    
4164           Life time of instrument (see "MAP MIDI_INSTRUMENT"           Life time of instrument (see "MAP MIDI_INSTRUMENT"
4165           (Section 6.7.1) for details about this setting).           (Section 6.7.7) for details about this setting).
4166    
4167        "VOLUME" -        "VOLUME" -
4168    
# Line 3880  Internet-Draft        LinuxSampler Contr Line 4174  Internet-Draft        LinuxSampler Contr
4174    
4175     Example:     Example:
4176    
4177        C: "GET MIDI_INSTRUMENT INFO 3 45 120"        C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4178    
4179        S: "NAME: Drums for Foo Song"        S: "NAME: Drums for Foo Song"
4180    
# Line 3898  Internet-Draft        LinuxSampler Contr Line 4192  Internet-Draft        LinuxSampler Contr
4192    
4193           "."           "."
4194    
 6.7.6.  Clear MIDI instrument map  
4195    
    The front-end can clear the whole MIDI instrument map, that is delete  
    all entries by sending the following command:  
4196    
       CLEAR MIDI_INSTRUMENTS  
4197    
    Possible Answers:  
4198    
4199        "OK" -  Schoenebeck               Expires June 23, 2007                [Page 75]
   
          always  
   
    Example:  
   
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 70]  
4200    
4201  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
   
   
       C: "CLEAR MIDI_INSTRUMENTS"  
   
       S: "OK"  
   
   
   
   
   
   
   
   
   
   
   
   
   
   
4202    
4203    
4204    6.7.12.  Clear MIDI instrument map
4205    
4206       The front-end can clear a whole MIDI instrument map, that is delete
4207       all its entries by sending the following command:
4208    
4209          CLEAR MIDI_INSTRUMENTS <map>
4210    
4211       Where <map> is the numeric ID of the map to clear.
4212    
4213       The front-end can clear all MIDI instrument maps, that is delete all
4214       entries of all maps by sending the following command:
4215    
4216          CLEAR MIDI_INSTRUMENTS ALL
4217    
4218       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4219       only their entries, thus the map's settings like custom name will be
4220       preservevd.
4221    
4222       Possible Answers:
4223    
4224          "OK" -
4225    
4226             always
4227    
4228       Examples:
4229    
4230          C: "CLEAR MIDI_INSTRUMENTS 0"
4231    
4232          S: "OK"
4233    
4234          C: "CLEAR MIDI_INSTRUMENTS ALL"
4235    
4236          S: "OK"
4237    
4238    
4239    
# Line 3972  Internet-Draft        LinuxSampler Contr Line 4252  Internet-Draft        LinuxSampler Contr
4252    
4253    
4254    
4255  Schoenebeck               Expires May 30, 2007                 [Page 71]  Schoenebeck               Expires June 23, 2007                [Page 76]
4256    
4257  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4258    
4259    
4260  7.  Command Syntax  7.  Command Syntax
# Line 4013  Internet-Draft        LinuxSampler Contr Line 4293  Internet-Draft        LinuxSampler Contr
4293    
4294     command =     command =
4295    
4296        ADD SP CHANNEL        ADD SP add_instruction
4297    
4298        / MAP SP map_instruction        / MAP SP map_instruction
4299    
# Line 4028  Internet-Draft        LinuxSampler Contr Line 4308  Internet-Draft        LinuxSampler Contr
4308    
4309    
4310    
4311  Schoenebeck               Expires May 30, 2007                 [Page 72]  Schoenebeck               Expires June 23, 2007                [Page 77]
4312    
4313  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4314    
4315    
4316        / LIST SP list_instruction        / LIST SP list_instruction
# Line 4055  Internet-Draft        LinuxSampler Contr Line 4335  Internet-Draft        LinuxSampler Contr
4335    
4336        / QUIT        / QUIT
4337    
4338       add_instruction =
4339    
4340          CHANNEL
4341    
4342          / MIDI_INSTRUMENT_MAP
4343    
4344          / MIDI_INSTRUMENT_MAP SP map_name
4345    
4346     subscribe_event =     subscribe_event =
4347    
4348        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4349    
4350          / AUDIO_OUTPUT_DEVICE_INFO
4351    
4352          / MIDI_INPUT_DEVICE_COUNT
4353    
4354          / MIDI_INPUT_DEVICE_INFO
4355    
4356          / CHANNEL_COUNT
4357    
4358        / VOICE_COUNT        / VOICE_COUNT
4359    
# Line 4065  Internet-Draft        LinuxSampler Contr Line 4361  Internet-Draft        LinuxSampler Contr
4361    
4362        / BUFFER_FILL        / BUFFER_FILL
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires June 23, 2007                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol        December 2006
4370    
4371    
4372        / CHANNEL_INFO        / CHANNEL_INFO
4373    
4374          / MIDI_INSTRUMENT_MAP_COUNT
4375    
4376          / MIDI_INSTRUMENT_MAP_INFO
4377    
4378          / MIDI_INSTRUMENT_COUNT
4379    
4380          / MIDI_INSTRUMENT_INFO
4381    
4382        / MISCELLANEOUS        / MISCELLANEOUS
4383    
4384        / TOTAL_VOICE_COUNT        / TOTAL_VOICE_COUNT
4385    
4386     unsubscribe_event =     unsubscribe_event =
4387    
4388        CHANNEL_COUNT        AUDIO_OUTPUT_DEVICE_COUNT
4389    
4390          / AUDIO_OUTPUT_DEVICE_INFO
4391    
4392          / MIDI_INPUT_DEVICE_COUNT
4393    
4394          / MIDI_INPUT_DEVICE_INFO
4395    
4396          / CHANNEL_COUNT
4397    
4398        / VOICE_COUNT        / VOICE_COUNT
4399    
# Line 4081  Internet-Draft        LinuxSampler Contr Line 4401  Internet-Draft        LinuxSampler Contr
4401    
4402        / BUFFER_FILL        / BUFFER_FILL
4403    
4404          / CHANNEL_INFO
4405    
4406          / MIDI_INSTRUMENT_MAP_COUNT
4407    
4408          / MIDI_INSTRUMENT_MAP_INFO
4409    
4410  Schoenebeck               Expires May 30, 2007                 [Page 73]        / MIDI_INSTRUMENT_COUNT
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4411    
4412          / MIDI_INSTRUMENT_INFO
       / CHANNEL_INFO  
4413    
4414        / MISCELLANEOUS        / MISCELLANEOUS
4415    
# Line 4097  Internet-Draft        LinuxSampler Contr Line 4417  Internet-Draft        LinuxSampler Contr
4417    
4418     map_instruction =     map_instruction =
4419    
4420        MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP  
4421    
4422    
4423    Schoenebeck               Expires June 23, 2007                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol        December 2006
4426    
4427    
4428          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4429        engine_name SP filename SP instrument_index SP volume_value        engine_name SP filename SP instrument_index SP volume_value
4430    
4431        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4432        SP engine_name SP filename SP instrument_index SP volume_value SP        engine_name SP filename SP instrument_index SP volume_value SP
4433        instr_load_mode        instr_load_mode
4434    
4435        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4436        SP engine_name SP filename SP instrument_index SP volume_value SP        engine_name SP filename SP instrument_index SP volume_value SP
4437        entry_name        entry_name
4438    
4439        / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        / MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP
4440        SP engine_name SP filename SP instrument_index SP volume_value SP        engine_name SP filename SP instrument_index SP volume_value SP
4441        instr_load_mode SP entry_name        instr_load_mode SP entry_name
4442    
4443     unmap_instruction =     unmap_instruction =
4444    
4445        MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog        MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
4446    
4447     remove_instruction =     remove_instruction =
4448    
4449        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
4450    
4451          / MIDI_INSTRUMENT_MAP SP midi_map
4452    
4453          / MIDI_INSTRUMENT_MAP SP ALL
4454    
4455     get_instruction =     get_instruction =
4456    
4457        AVAILABLE_ENGINES        AVAILABLE_ENGINES
# Line 4137  Internet-Draft        LinuxSampler Contr Line 4469  Internet-Draft        LinuxSampler Contr
4469    
4470        / AUDIO_OUTPUT_DRIVER SP INFO SP string        / AUDIO_OUTPUT_DRIVER SP INFO SP string
4471    
4472          / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
4473    
4474          / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
4475          key_val_list
4476    
4477    
 Schoenebeck               Expires May 30, 2007                 [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
4478    
4479        / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string  Schoenebeck               Expires June 23, 2007                [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol        December 2006
4482    
       / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP  
       key_val_list  
4483    
4484        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
4485    
# Line 4185  Internet-Draft        LinuxSampler Contr Line 4516  Internet-Draft        LinuxSampler Contr
4516    
4517        / TOTAL_VOICE_COUNT_MAX        / TOTAL_VOICE_COUNT_MAX
4518    
4519        / MIDI_INSTRUMENTS        / MIDI_INSTRUMENTS SP midi_map
4520    
4521          / MIDI_INSTRUMENTS SP ALL
4522    
4523          / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
4524    
4525          / MIDI_INSTRUMENT_MAPS
4526    
4527        / MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP        / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
       midi_prog  
4528    
4529     set_instruction =     set_instruction =
4530    
# Line 4196  Internet-Draft        LinuxSampler Contr Line 4532  Internet-Draft        LinuxSampler Contr
4532    
4533    
4534    
4535  Schoenebeck               Expires May 30, 2007                 [Page 75]  Schoenebeck               Expires June 23, 2007                [Page 81]
4536    
4537  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4538    
4539    
4540        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='        AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
# Line 4215  Internet-Draft        LinuxSampler Contr Line 4551  Internet-Draft        LinuxSampler Contr
4551    
4552        / CHANNEL SP set_chan_instruction        / CHANNEL SP set_chan_instruction
4553    
4554          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
4555    
4556        / ECHO SP boolean        / ECHO SP boolean
4557    
4558     create_instruction =     create_instruction =
# Line 4233  Internet-Draft        LinuxSampler Contr Line 4571  Internet-Draft        LinuxSampler Contr
4571    
4572     clear_instruction =     clear_instruction =
4573    
4574        MIDI_INSTRUMENTS        MIDI_INSTRUMENTS SP midi_map
4575    
4576          / MIDI_INSTRUMENTS SP ALL
4577    
4578     destroy_instruction =     destroy_instruction =
4579    
# Line 4245  Internet-Draft        LinuxSampler Contr Line 4585  Internet-Draft        LinuxSampler Contr
4585    
4586        INSTRUMENT SP load_instr_args        INSTRUMENT SP load_instr_args
4587    
       / ENGINE SP load_engine_args  
4588    
    set_chan_instruction =  
4589    
4590    
4591    Schoenebeck               Expires June 23, 2007                [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol        December 2006
4594    
4595    
4596  Schoenebeck               Expires May 30, 2007                 [Page 76]        / ENGINE SP load_engine_args
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4597    
4598       set_chan_instruction =
4599    
4600        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index        AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
4601    
# Line 4282  Internet-Draft        LinuxSampler Contr Line 4622  Internet-Draft        LinuxSampler Contr
4622    
4623        / SOLO SP sampler_channel SP boolean        / SOLO SP sampler_channel SP boolean
4624    
4625          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
4626    
4627          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
4628    
4629          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
4630    
4631     key_val_list =     key_val_list =
4632    
4633        string '=' param_val_list        string '=' param_val_list
# Line 4296  Internet-Draft        LinuxSampler Contr Line 4642  Internet-Draft        LinuxSampler Contr
4642    
4643     list_instruction =     list_instruction =
4644    
       AUDIO_OUTPUT_DEVICES  
   
       / MIDI_INPUT_DEVICES  
4645    
       / CHANNELS  
   
       / AVAILABLE_ENGINES  
4646    
4647    Schoenebeck               Expires June 23, 2007                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol        December 2006
4650    
4651    
4652          AUDIO_OUTPUT_DEVICES
4653    
4654          / MIDI_INPUT_DEVICES
4655    
4656  Schoenebeck               Expires May 30, 2007                 [Page 77]        / CHANNELS
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4657    
4658          / AVAILABLE_ENGINES
4659    
4660        / AVAILABLE_MIDI_INPUT_DRIVERS        / AVAILABLE_MIDI_INPUT_DRIVERS
4661    
4662        / AVAILABLE_AUDIO_OUTPUT_DRIVERS        / AVAILABLE_AUDIO_OUTPUT_DRIVERS
4663    
4664        / MIDI_INSTRUMENTS        / MIDI_INSTRUMENTS SP midi_map
4665    
4666          / MIDI_INSTRUMENTS SP ALL
4667    
4668          / MIDI_INSTRUMENT_MAPS
4669    
4670     load_instr_args =     load_instr_args =
4671    
# Line 4349  Internet-Draft        LinuxSampler Contr Line 4697  Internet-Draft        LinuxSampler Contr
4697    
4698        string        string
4699    
4700    
4701    
4702    
4703    Schoenebeck               Expires June 23, 2007                [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol        December 2006
4706    
4707    
4708     midi_input_port_index =     midi_input_port_index =
4709    
4710        number        number
# Line 4361  Internet-Draft        LinuxSampler Contr Line 4717  Internet-Draft        LinuxSampler Contr
4717    
4718     midi_input_type_name =     midi_input_type_name =
4719    
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
4720        string        string
4721    
4722     midi_bank_msb =     midi_map =
4723    
4724        number        number
4725    
4726     midi_bank_lsb =     midi_bank =
4727    
4728        number        number
4729    
# Line 4405  Internet-Draft        LinuxSampler Contr Line 4753  Internet-Draft        LinuxSampler Contr
4753    
4754        stringval        stringval
4755    
4756    
4757    
4758    
4759    Schoenebeck               Expires June 23, 2007                [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol        December 2006
4762    
4763    
4764       map_name =
4765    
4766          stringval
4767    
4768     entry_name =     entry_name =
4769    
4770        stringval        stringval
# Line 4417  Internet-Draft        LinuxSampler Contr Line 4777  Internet-Draft        LinuxSampler Contr
4777    
4778     param_val =     param_val =
4779    
4780          string
4781    
4782          / stringval
4783    
4784          / number
4785    
4786  Schoenebeck               Expires May 30, 2007                 [Page 79]        / dotnum
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
4787    
4788    
       string  
4789    
       / stringval  
4790    
       / number  
4791    
       / dotnum  
4792    
4793    
4794    
# Line 4455  Internet-Draft        LinuxSampler Contr Line 4812  Internet-Draft        LinuxSampler Contr
4812    
4813    
4814    
4815    Schoenebeck               Expires June 23, 2007                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol        December 2006
4818    
4819    
4820    8.  Events
4821    
4822       This chapter will describe all currently defined events supported by
4823       LinuxSampler.
4824    
4825    8.1.  Number of audio output devices changed
4826    
4827       Client may want to be notified when the total number of audio output
4828       devices on the back-end changes by issuing the following command:
4829    
4830          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
4831    
4832       Server will start sending the following notification messages:
4833    
4834          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
4835    
4836       where <devices> will be replaced by the new number of audio output
4837       devices.
4838    
4839    8.2.  Audio output device's settings changed
4840    
4841       Client may want to be notified when changes were made to audio output
4842       devices on the back-end by issuing the following command:
4843    
4844          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
4845    
4846       Server will start sending the following notification messages:
4847    
4848          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
4849    
4850       where <device-id> will be replaced by the numerical ID of the audio
4851       output device, which settings has been changed.  The front-end will
4852       have to send the respective command to actually get the audio output
4853       device info.  Because these messages will be triggered by LSCP
4854       commands issued by other clients rather than real time events
4855       happening on the server, it is believed that an empty notification
4856       message is sufficient here.
4857    
4858    8.3.  Number of MIDI input devices changed
4859    
4860       Client may want to be notified when the total number of MIDI input
4861       devices on the back-end changes by issuing the following command:
4862    
4863          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
4864    
4865       Server will start sending the following notification messages:
4866    
4867    
4868    
4869    
4870    
4871  Schoenebeck               Expires May 30, 2007                 [Page 80]  Schoenebeck               Expires June 23, 2007                [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
4874    
4875    
4876  8.  Events        "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
4877    
4878     This chapter will describe all currently defined events supported by     where <devices> will be replaced by the new number of MIDI input
4879     LinuxSampler.     devices.
4880    
4881    8.4.  MIDI input device's settings changed
4882    
4883  8.1.  Number of sampler channels changed     Client may want to be notified when changes were made to MIDI input
4884       devices on the back-end by issuing the following command:
4885    
4886          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
4887    
4888       Server will start sending the following notification messages:
4889    
4890          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
4891    
4892       where <device-id> will be replaced by the numerical ID of the MIDI
4893       input device, which settings has been changed.  The front-end will
4894       have to send the respective command to actually get the MIDI input
4895       device info.  Because these messages will be triggered by LSCP
4896       commands issued by other clients rather than real time events
4897       happening on the server, it is believed that an empty notification
4898       message is sufficient here.
4899    
4900    8.5.  Number of sampler channels changed
4901    
4902     Client may want to be notified when the total number of channels on     Client may want to be notified when the total number of channels on
4903     the back-end changes by issuing the following command:     the back-end changes by issuing the following command:
# Line 4500  Internet-Draft        LinuxSampler Contr Line 4911  Internet-Draft        LinuxSampler Contr
4911     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
4912     channels.     channels.
4913    
4914  8.2.  Number of active voices changed  8.6.  Number of active voices changed
4915    
4916     Client may want to be notified when the number of voices on the back-     Client may want to be notified when the number of voices on the back-
4917     end changes by issuing the following command:     end changes by issuing the following command:
# Line 4509  Internet-Draft        LinuxSampler Contr Line 4920  Internet-Draft        LinuxSampler Contr
4920    
4921     Server will start sending the following notification messages:     Server will start sending the following notification messages:
4922    
4923    
4924    
4925    
4926    
4927    Schoenebeck               Expires June 23, 2007                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol        December 2006
4930    
4931    
4932        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>
4933    
4934     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
4935     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
4936     voices on that channel.     voices on that channel.
4937    
4938  8.3.  Number of active disk streams changed  8.7.  Number of active disk streams changed
4939    
4940     Client may want to be notified when the number of streams on the     Client may want to be notified when the number of streams on the
4941     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 4529  Internet-Draft        LinuxSampler Contr Line 4949  Internet-Draft        LinuxSampler Contr
4949    
4950     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
4951     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck               Expires May 30, 2007                 [Page 81]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
   
   
4952     active disk streams on that channel.     active disk streams on that channel.
4953    
4954  8.4.  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
4955    
4956     Client may want to be notified when the buffer fill state of a disk     Client may want to be notified when the buffer fill state of a disk
4957     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 4556  Internet-Draft        LinuxSampler Contr Line 4968  Internet-Draft        LinuxSampler Contr
4968     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
4969     (Section 6.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
4970    
4971  8.5.  Channel information changed  8.9.  Channel information changed
4972    
4973     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
4974     channels on the back-end by issuing the following command:     channels on the back-end by issuing the following command:
# Line 4565  Internet-Draft        LinuxSampler Contr Line 4977  Internet-Draft        LinuxSampler Contr
4977    
4978     Server will start sending the following notification messages:     Server will start sending the following notification messages:
4979    
4980    
4981    
4982    
4983    Schoenebeck               Expires June 23, 2007                [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol        December 2006
4986    
4987    
4988        "NOTIFY:CHANNEL_INFO:<sampler-channel>"        "NOTIFY:CHANNEL_INFO:<sampler-channel>"
4989    
4990     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
# Line 4574  Internet-Draft        LinuxSampler Contr Line 4994  Internet-Draft        LinuxSampler Contr
4994     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
4995     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
4996    
4997  8.6.  Total number of active voices changed  8.10.  Total number of active voices changed
4998    
4999     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
5000     back-end changes by issuing the following command:     back-end changes by issuing the following command:
# Line 4583  Internet-Draft        LinuxSampler Contr Line 5003  Internet-Draft        LinuxSampler Contr
5003    
5004     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5005    
5006          "NOTIFY:TOTAL_VOICE_COUNT:<voices>
5007    
5008       where <voices> will be replaced by the new number of all currently
5009       active voices.
5010    
5011    8.11.  Number of MIDI instrument maps changed
5012    
5013       Client may want to be notified when the number of MIDI instrument
5014       maps on the back-end changes by issuing the following command:
5015    
5016          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
5017    
5018       Server will start sending the following notification messages:
5019    
5020          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
5021    
5022       where <maps> will be replaced by the new number of MIDI instrument
5023       maps.
5024    
5025    8.12.  MIDI instrument map information changed
5026    
5027       Client may want to be notified when changes were made to MIDI
5028       instrument maps on the back-end by issuing the following command:
5029    
5030          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
5031    
5032       Server will start sending the following notification messages:
5033    
5034    
5035    
5036    
5037    
5038    
5039  Schoenebeck               Expires May 30, 2007                 [Page 82]  Schoenebeck               Expires June 23, 2007                [Page 90]
5040    
5041  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5042    
5043    
5044        "NOTIFY:TOTAL_VOICE_COUNT:<voices>        "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
5045    
5046     where <voices> will be replaced by the new number of all currently     where <map-id> will be replaced by the numerical ID of the MIDI
5047     active voices.     instrument map, for which information changes occurred.  The front-
5048       end will have to send the respective command to actually get the MIDI
5049       instrument map info.  Because these messages will be triggered by
5050       LSCP commands issued by other clients rather than real time events
5051       happening on the server, it is believed that an empty notification
5052       message is sufficient here.
5053    
5054    8.13.  Number of MIDI instruments changed
5055    
5056       Client may want to be notified when the number of MIDI instrument
5057       maps on the back-end changes by issuing the following command:
5058    
5059          SUBSCRIBE MIDI_INSTRUMENT_COUNT
5060    
5061       Server will start sending the following notification messages:
5062    
5063          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
5064    
5065       where <map-id> is the numerical ID of the MIDI instrument map, in
5066       which the nuber of instruments has changed and <instruments> will be
5067       replaced by the new number of MIDI instruments in the specified map.
5068    
5069    8.14.  MIDI instrument information changed
5070    
5071       Client may want to be notified when changes were made to MIDI
5072       instruments on the back-end by issuing the following command:
5073    
5074          SUBSCRIBE MIDI_INSTRUMENT_INFO
5075    
5076       Server will start sending the following notification messages:
5077    
5078          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
5079    
5080  8.7.  Miscellaneous and debugging events     where <map-id> will be replaced by the numerical ID of the MIDI
5081       instrument map, in which a MIDI instrument is changed. <bank> and
5082       <program> specifies the location of the changed MIDI instrument in
5083       the map.  The front-end will have to send the respective command to
5084       actually get the MIDI instrument info.  Because these messages will
5085       be triggered by LSCP commands issued by other clients rather than
5086       real time events happening on the server, it is believed that an
5087       empty notification message is sufficient here.
5088    
5089    
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck               Expires June 23, 2007                [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol        December 2006
5098    
5099    
5100    8.15.  Miscellaneous and debugging events
5101    
5102     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified of miscellaneous and debugging events
5103     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 5143  Internet-Draft        LinuxSampler Contr
5143    
5144    
5145    
5146  Schoenebeck               Expires May 30, 2007                 [Page 83]  
5147    
5148    
5149    
5150    
5151    Schoenebeck               Expires June 23, 2007                [Page 92]
5152    
5153  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5154    
5155    
5156  9.  Security Considerations  9.  Security Considerations
# Line 4700  Internet-Draft        LinuxSampler Contr Line 5204  Internet-Draft        LinuxSampler Contr
5204    
5205    
5206    
5207  Schoenebeck               Expires May 30, 2007                 [Page 84]  Schoenebeck               Expires June 23, 2007                [Page 93]
5208    
5209  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5210    
5211    
5212  10.  Acknowledgments  10.  Acknowledgments
# Line 4720  Internet-Draft        LinuxSampler Contr Line 5224  Internet-Draft        LinuxSampler Contr
5224        Grigor Iliev        Grigor Iliev
5225    
5226    
 11.  References  
5227    
    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate  
               Requirement Levels", RFC 2119, 1997.  
5228    
    [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax  
               Specifications", RFC 2234, 1997.  
5229    
    [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION  
               CONTROL PROTOCOL", RFC 793, 1981.  
5230    
5231    
5232    
# Line 4756  Internet-Draft        LinuxSampler Contr Line 5253  Internet-Draft        LinuxSampler Contr
5253    
5254    
5255    
5256  Schoenebeck               Expires May 30, 2007                 [Page 85]  
5257    
5258    
5259    
5260    
5261    
5262    
5263    Schoenebeck               Expires June 23, 2007                [Page 94]
5264    
5265  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5266    
5267    
5268  Author's Address  11.  References
5269    
5270     C. Schoenebeck     [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
5271     Interessengemeinschaft Software Engineering e. V.                Requirement Levels", RFC 2119, 1997.
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
5272    
5273     Email: schoenebeck at software minus engineering dot org     [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
5274                  Specifications", RFC 2234, 1997.
5275    
5276       [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION
5277                  CONTROL PROTOCOL", RFC 793, 1981.
5278    
5279    
5280    
# Line 4812  Author's Address Line 5316  Author's Address
5316    
5317    
5318    
5319  Schoenebeck               Expires May 30, 2007                 [Page 86]  Schoenebeck               Expires June 23, 2007                [Page 95]
5320    
5321  Internet-Draft        LinuxSampler Control Protocol        November 2006  Internet-Draft        LinuxSampler Control Protocol        December 2006
5322    
5323    
5324  Intellectual Property Statement  Author's Address
5325    
5326     The IETF takes no position regarding the validity or scope of any     C. Schoenebeck
5327     intellectual property or other rights that might be claimed to     Interessengemeinschaft Software Engineering e. V.
5328     pertain to the implementation or use of the technology described in     Max-Planck-Str. 39
5329     this document or the extent to which any license under such rights     74081 Heilbronn
5330     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.  
5331    
5332     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.  
5333    
5334    
 Full Copyright Statement  
5335    
    Copyright (C) The Internet Society (2006).  All Rights Reserved.  
5336    
    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.  
5337    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
5338    
    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  
5339    
5340    
5341    
 Schoenebeck               Expires May 30, 2007                 [Page 87]  
   
 Internet-Draft        LinuxSampler Control Protocol        November 2006  
5342    
5343    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
5344    
5345    
 Acknowledgment  
5346    
    Funding for the RFC Editor function is currently provided by the  
    Internet Society.  
5347    
5348    
5349    
# Line 4909  Acknowledgment Line 5372  Acknowledgment
5372    
5373    
5374    
5375    Schoenebeck               Expires June 23, 2007                [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol        December 2006
5378    
5379    
5380    Full Copyright Statement
5381    
5382       Copyright (C) The Internet Society (2006).
5383    
5384       This document is subject to the rights, licenses and restrictions
5385       contained in BCP 78, and except as set forth therein, the authors
5386       retain all their rights.
5387    
5388       This document and the information contained herein are provided on an
5389       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
5390       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
5391       ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
5392       INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
5393       INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
5394       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
5395    
5396    
5397    Intellectual Property
5398    
5399       The IETF takes no position regarding the validity or scope of any
5400       Intellectual Property Rights or other rights that might be claimed to
5401       pertain to the implementation or use of the technology described in
5402       this document or the extent to which any license under such rights
5403       might or might not be available; nor does it represent that it has
5404       made any independent effort to identify any such rights.  Information
5405       on the procedures with respect to rights in RFC documents can be
5406       found in BCP 78 and BCP 79.
5407    
5408       Copies of IPR disclosures made to the IETF Secretariat and any
5409       assurances of licenses to be made available, or the result of an
5410       attempt made to obtain a general license or permission for the use of
5411       such proprietary rights by implementers or users of this
5412       specification can be obtained from the IETF on-line IPR repository at
5413       http://www.ietf.org/ipr.
5414    
5415       The IETF invites any interested party to bring to its attention any
5416       copyrights, patents or patent applications, or other proprietary
5417       rights that may cover technology that may be required to implement
5418       this standard.  Please address the information to the IETF at
5419       ietf-ipr@ietf.org.
5420    
5421    
5422    Acknowledgment
5423    
5424       Funding for the RFC Editor function is provided by the IETF
5425       Administrative Support Activity (IASA).
5426    
5427    
5428    
5429    
5430    
5431  Schoenebeck               Expires May 30, 2007                 [Page 88]  Schoenebeck               Expires June 23, 2007                [Page 97]
5432    
Legend:
Removed from v.945  
changed lines
  Added in v.993
  ViewVC Help
Powered by ViewVC